Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions config/_default/menus/main.en.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2061,6 +2061,11 @@ menu:
parent: software_catalog_set_up
identifier: software_catalog_import_entities
weight: 1013
- name: Define Ownership
url: internal_developer_portal/software_catalog/set_up/ownership
parent: software_catalog_set_up
identifier: software_catalog_ownership
weight: 1014
- name: Entity Model
url: internal_developer_portal/software_catalog/entity_model
parent: software_catalog
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ algolia:
tags: ['software catalog']
---

{{< img src="tracing/software_catalog/software_catalog_updated.mp4" video=true alt="Navigating the Software Catalog" style="width:100%;" >}}
{{< img src="tracing/software_catalog/software-catalog-landing-vid.mp4" video=true alt="Navigating the Software Catalog" style="width:100%;" >}}

## Overview

Expand All @@ -26,13 +26,10 @@ algolia:
Built on real-time telemetry and automated metadata collection, Software Catalog offers integrations with observability, security, and cost management tools. This empowers engineering, SRE, security, and platform teams to maintain visibility, streamline operations, and ensure service reliability at scale.

## What you can do in Software Catalog
<br>
{{< img src="tracing/software_catalog/software_catalog_tabs.mp4" video=true alt="A video overview of the Software Catalog, with the Services component type selected, that scrolls through the Ownership, Reliability, Performance, Security, Costs, and Delivery tabs" style="width:100%;" >}}
<br>

Software Catalog offers multiple views to help you explore and manage your entities.

- **Ownership**: Access your team's Slack, repo, or on-call information.
- [**Ownership**][8]: Access your team's Slack, repo, or on-call information.
- **Reliability**: Address risks by surfacing entities with recent deploys, rising error rates, open incidents, or failing monitors.
- **Performance**: Compare latency, traffic, error rate, and Apdex by environment.
- **Security**: Find vulnerable libraries and live attacks from a single list to harden security posture.
Expand Down Expand Up @@ -88,4 +85,5 @@ Some integrations alias to certain types. For example, Postgres, MySQL, and Cass
[5]: /internal_developer_portal/software_catalog/set_up/discover_entities
[6]: /internal_developer_portal/software_catalog/set_up/create_entities
[7]: /internal_developer_portal/software_catalog/set_up/import_entities
[8]: /internal_developer_portal/software_catalog/set_up/ownership

Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,10 @@ You can bring your Backstage entities into Datadog's IDP in one of two ways:

Sync your ServiceNow CMDB inventories with Datadog's Software Catalog by setting up a regular query against your ServiceNow CI tables.

## Define entity ownership

Link entities to teams to enable team-based filtering across Datadog products, route notifications to the right owners, and drive accountability through Scorecards and Campaigns. For details, see [Define ownership for Software Catalog entities][12].

## Verify configuration completeness

Following monitoring best practices such as tracing, logging, and code profiling helps you ensure that you have all the data you need during incident triage. Software Catalog provides automatic checks for these recommended setups.
Expand All @@ -132,7 +136,7 @@ To view the configuration completeness for an entity, click the entity in the [S

The Setup Guidance table does not necessarily reflect billing for individual products, but rather activity for the entity you are presently examining. For example, if the service does not emit infrastructure metrics for a long time, `Infrastructure Monitoring` might have `Not Detected` specified, even if you have hosts or containers running infrastructure monitoring.

## Role based access and permissions
## Configure role based access and permissions

For general information, see [Role Based Access Control][3] and [Role Permissions][4].

Expand Down Expand Up @@ -170,6 +174,7 @@ The permission is enabled by default in the **Datadog Admin Role** and **Datadog
[9]: /internal_developer_portal/software_catalog/entity_model?tab=v30
[10]: https://app.datadoghq.com/software/settings/get-started
[11]: https://www.npmjs.com/package/@datadog/backstage-plugin-datadog-entity-sync-backend
[12]: /internal_developer_portal/software_catalog/set_up/ownership



Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
---
title: Define ownership for Software Catalog entities
description: Link services and other entities to Datadog Teams so you can filter views, route notifications, and drive accountability across your software portfolio.
further_reading:
- link: "/account_management/teams/"
tag: "Documentation"
text: "Teams"
- link: "/tracing/software_catalog/adding_metadata/#add-metadata-from-the-datadog-ui"
tag: "Documentation"
text: "Add metadata from the Datadog UI"
---

## Overview

Define ownership in Software Catalog to connect entities to the Datadog Teams responsible for them. Ownership information appears on each entity's details page and allows you to:
- Filter views by team across Datadog products.
- Attribute Scorecards and Campaigns to the right owners.
- Route notifications and on-call context to the correct team.

## Create a Team

You can create a Team from your [Datadog Organization Settings][3] or directly from [Software Catalog][1]. For full instructions, see [Team set up and configuration][2].

A Team definition includes the following:
1. **Team name**: For example, "Bits Demo".
2. **Handle**: A unique identifier, such as `bits-demo`. Handles can be used as search facets (for example, `team:bits-demo`).
3. **Members**: One or more Datadog users.
4. **Description**: Optional, but recommended for context.

After creating a Team, you can add reference links, configure notifications, and associate the Team with Datadog resources such as Monitors and Dashboards.

## Configure entity ownership

### In Datadog

To add or update an entity's owner in Datadog:

1. Go to **Service Management** > **Software Catalog**, and open the entity.
2. Click **Edit in UI** on the entity page.
3. In the **Ownership** section, set the **Owner** and optionally add **Additional owners**.
- Search by team name or paste a handle (for example, `team:example-team`).
5. Click **Save Entry**.

### Through configuration files

If you manage entities as code (for example, through repository-backed service definitions or automation), include the team handle(s) in the entity metadata field that maps to owners. Ensure handles exactly match existing Datadog Teams.

## Best practices

- **Use Teams, not individuals:** Assign entities to Teams so membership changes don't break ownership links, filters, or notifications.
- **Choose a primary owner:** Designate one accountable Team; add secondary owners only when necessary.
- **Keep handles consistent:** Use lowercase, hyphenated handles for consistency and searchability (for example, `payments-platform`, not `Payments Platform`).
- **Sync from your IdP:** If possible, provision Teams from SAML or SCIM to keep membership current.
- **Use team filters:** Encourage engineers to enable [**My Teams**][4] to focus views on owned entities.


[1]: https://app.datadoghq.com/teams
[2]: /account_management/teams/
[3]: https://app.datadoghq.com/organization-settings/teams
[4]: /account_management/teams/#team-filter
Binary file not shown.
Loading