If you experience unexpected behavior with Datadog Catalog, this guide may help you resolve the issue. If you continue to have trouble, contact Datadog Support for further assistance.

Services

APM-instrumented services not appearing

If services that you know are instrumented for APM are not appearing in the Catalog list, it’s likely because they have not been emitting performance data in the past hour for the selected env (or any primary tag values of your choosing) or additional primary tags. To confirm, on the Performance tab, hover over the columns where you expect the performance metrics to appear and see information on which environments the services are active.

SLOs not listed in Setup Guidance section

The count in the Catalog Setup Guidance section reflects the number of SLOs with service tags. If your SLOs are not listed, verify that they have service tag values specified and that they match with the service names in other products such as APM and USM.

Additional telemetry is available to a service but it’s not listed

Catalog relies on the DD_SERVICE tag in all telemetry types (infrastructure metrics, logs, Cloud Network Monitoring) to gather information about a given service. If you don’t see a telemetry type that you expect in the Catalog, ensure that you have configured the DD_SERVICE tag according to the instructions in Unified Service Tagging.

Can’t add metadata for RUM services

Adding metadata for RUM services is not supported.

Multiple services share the same metadata

If you have many services that share the same metadata, you do not need separate service.datadog.yaml files for each one. You can define multiple services in a single service.datadog.yaml file by separating each service with a --- separator. Copy and paste the shared metadata for the relevant dd-service entities.

Associated monitors not displayed in the Setup Guidance section

The Catalog associates monitors to services when they are tagged, scoped, or grouped with service or APM primary tags.

The total monitor count displayed on the Setup Guidance tab for a single service does not include muted monitors and groups.

Endpoints

Missing endpoints

The Endpoints list is based on APM tracing, so make sure your services are instrumented.

Definition matches too many services

By default, the Endpoints list matches a definition to all instances that fit the defined path. You can scope the definition to a specific service by adding the service parameter to the API definition.

Definition and traffic appear as separate endpoints

When you add an OpenAPI specification to an API entity, Datadog adds each declared HTTP method and path to the Endpoints list and combines it with traffic when the service, HTTP method, and path all match. If the definition and traffic remain as separate entries, verify the following:

• spec.implementedBy includes the service from the span. For service overrides, Datadog also checks base_service.
• The span’s @http.method matches the method in the definition.
• The span has @http.route, and its @http.url_details.path or @http.route matches the defined path. A path parameter matches exactly one segment. For example, /users/{user_id} matches /users/123, but not /users/123/orders.

A definition without spec.implementedBy can match the same route on any service. Define the implementing services to avoid broad or ambiguous matches.

Catch-all definition does not combine with traffic

A catch-all path is a path made entirely of parameters, such as /{resource} or /{resource}/{id}. To prevent an ambiguous match across services, Datadog does not combine traffic with an unscoped catch-all definition. Add the traffic’s service to spec.implementedBy.

For example, GET /{resource} without spec.implementedBy remains separate from traffic with service:store-api, @http.method:GET, and @http.route:/orders. Adding service:store-api to spec.implementedBy allows them to combine. Each parameter still matches only one path segment, so /{resource} does not match /orders/123; use /{resource}/{id} for that shape.

No telemetry data for OpenAPI file

Uploading an OpenAPI file adds its declared endpoints to the Endpoints list even if Datadog has not observed traffic. Traffic and performance information become visible after Datadog ingests matching spans for an endpoint.

No data for new monitor

The Endpoints list relies on APM tracing, so traffic information is displayed only when traces are available for the endpoint. If no data appears in the monitor graph, one of the following may apply:

• The endpoint has not been accessed since it was registered and uploaded via OpenAPI.
• Traces are sampled on the Agent side. For more details, see Ingestion Controls.

Further reading

Documentation, liens et articles supplémentaires utiles:

Setting Up CatalogDOCUMENTATION