Overview

Datadog Service Catalog provides a consolidated view of your services, combining ownership metadata, performance insights, security analysis, cost allocation, and much more. It makes it easy for organizations to achieve end-to-end service ownership at scale, get real-time performance insights, detect and address reliability and security risks, and manage application dependencies all in one place.

Use cases

Service discovery

• Datadog Service Catalog includes all discovered services from APM, USM, and RUM by default. If you are using any of these products, your catalog is pre-populated with entries.
• As you instrument more applications across your environments, they are automatically added to the Service Catalog.

Dependencies mapping and management

• Document and track all of your upstream and downstream dependencies automatically with application telemetries collected by APM, USM, and RUM.
• Manually declare dependency relationships across components (available through metadata schema v3.0).
• Understand and assess performance impacts across teams and services.

Governance and optimization

• Providing engineering leadership with a high-level view of best practices across teams and services through Service Scorecards.
• Reducing application risks by finding and fixing known security vulnerabilities in the dependencies of your services.
• Understanding trends and identifying inefficiencies in the costs related to your services.

Knowledge sharing

• Locate information without navigating through numerous repos, channels, or documentation pages.
• Save time searching for runbooks or wiki pages when onboarding new team members.
• Leverage real-time, automatically-generated topology maps to understand system architecture.

Evaluate monitoring coverage

• Detecting which services aren’t reporting observability data or having that data monitored.
• Facilitating tagging best practices and checking for recommended setup configurations to optimize cross-telemetry insights.
• Spotting issues like missing SLOs, monitors, or services without ownership.

Streamline collaboration during incidents

• Improving the on-call experience for everyone by establishing correct ownership information and communication channels, alongside streamlined access to monitoring and troubleshooting details.
• Embedding links to solutions and troubleshooting tools such as runbooks and documentation directly in the observability tooling engineers are already using.
• Speeding incident recovery by increasing confidence and simplifying locating owners of upstream and downstream services and dependencies.

Getting started

Role based access and permissions

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

Read permission

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

• Service 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 Service Catalog write permission allows a user to modify service 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.

Filtering service catalog entries by component

Every entry showing up in the Service Catalog is categorized as a component type:

• Services
• Datastores
• Queues
• RUM Apps
• External providers

Datadog populates Service Catalog entries and determines their associated component type based on collected span attributes for APM (peer tags), but also based other collected telemetry types (USM, DSM, RUM, etc…).

Note: The component supersedes the type filter (derived from the span.type span attribute), as it detects more reliably and more granularly the different entity types. For instance, you can filter by datastore technology using the datastore type facet.

Data retention

The services and resources statistics, and span summaries on the Service List and Service Page are retained for up to 30 days. For customized queries on APM trace metrics, use Metric Explorer. Learn more about data retention for APM.

Further reading

Additional helpful documentation, links, and articles:

Registering Services with the Service Definition APIDOCUMENTATION Create and manage service definitions with TerraformEXTERNAL SITE See Upstream and Downstream Dependencies During an Active IncidentGUIDE Manage Service Catalog entries with the Service Definition JSON SchemaBLOG Gain visibility into risks, vulnerabilities, and attacks with APM Security ViewBLOG 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 Improve your shift-left observability with the Datadog Service CatalogBLOG Best practices for end-to-end service ownership with Datadog Service CatalogBLOG Improve developer experience and collaboration with Service Catalog schema version 3.0BLOG