Overview

Software Catalog entities are defined through Entity Definitions, which are Kubernetes-style YAML configuration files.

To populate Software Catalog, you can:

• Set up Datadog Application Performance Monitoring (APM), Universal Service Monitoring (USM), Real User Monitoring (RUM), infrastructure metrics, or logs, which will automatically feed entity data into Software Catalog.
• Create entity definitions manually or through automation.
• Import existing entity definitions from third parties.

By default, these services are not associated with Datadog telemetry, but you can link telemetry data from Datadog or external sources manually using entity definition YAML files.

Automatically discover entities from Datadog

Create entities

Import entities

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.

To view the configuration completeness for an entity, click the entity in the Software Catalog, then find the Setup Guidance tab:

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

For general information, see Role Based Access Control and Role Permissions.

Read permission

The Software Catalog read permission allows a user to read Software Catalog data, which enables the following features:

• Software Catalog list
• Discover UI
• Service Definition endpoint: /api/v2/services/definition/<service_name>

The permission is enabled by default in the Datadog Read Only Role and Datadog Standard Role.

Write permission

The Software Catalog write permission allows a user to modify Software Catalog data. The write permission is required for the following features:

• Inserting or updating a service definition with the POST /api/v2/services/definitions endpoint
• Deleting a service definition with the DELETE /api/v2/services/definition/<service_name> endpoint
• Completing the onboarding process in the Discover Services UI
• Updating service metadata in the UI

The permission is enabled by default in the Datadog Admin Role and Datadog Standard Role.

Further reading

Más enlaces, artículos y documentación útiles:

Manage Service Catalog entries with the Service Definition JSON SchemaBLOG Easily add tags and metadata to your services using the simplified Service Catalog setupBLOG I use GitHub Ac­tions for Data­dog's Service Catalog, and you should, tooBLOG Best practices for end-to-end service ownership with Datadog Service CatalogBLOG