If you experience unexpected behavior with Datadog API Catalog, this guide may help you resolve the issue. If you continue to have trouble, contact Datadog Support for further assistance.
Definition matches too many services
By default, The API Catalog 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.
Missing endpoints
API Catalog is based on APM tracing, so the first step is to make sure your services are instrumented. Click Learn More in the app, then select Troubleshoot to verify this.
If your service is instrumented and you still can’t see the endpoints, there are two options:
- Upload OpenAPI file: Uploading a spec file to the Catalog page automatically connects any trace seen in traffic to the matching endpoints. You should expect to see the endpoints in the Explorer page soon after uploading, depending on traffic.
- Use the Setup wizard to enable autodiscovery for the service: Not all instrumentation libraries are supported, so you can use the wizard on the Setup page to see if an upgrade is required, or learn how to add missing tags yourself.
No telemetry data for OpenAPI file
API Catalog is based on APM tracing, so info from traffic is displayed only when there are traces for the endpoint. After uploading an OpenAPI file, deployment data (Last Seen, environments, and more) is visible after Datadog ingests a span for the endpoint.
No data for new monitor
API Catalog is based on APM tracing, so info from traffic is displayed only when there are traces for the endpoint. If you do not see data in the monitor graph, one of the options below may apply:
- The endpoint has not been used yet since it was registered/uploaded through OpenAPI.
- Traces are sampled on the Agent side. Read Ingestion Controls for more information.
Further reading
Additional helpful documentation, links, and articles:
