Overview

If a service has a supported tracer installed, the API Catalog is automatically populated with all endpoints discovered from this service.

To check for compatibility issues, click Learn More in the app, then select Troubleshoot.

Providing endpoint paths manually

Add the datadog.api_catalog.route tag to force endpoint discovery by the API Catalog. This tag should contain the matched route, that is, the path template in the format used by the respective server framework.

Example

The following examples demonstrate adding a span tag for each using custom instrumentation:

Java

span.setTag("datadog.api_catalog.route", "/products/{productId}")

Python

span.set_tag("datadog.api_catalog.route", "/products/{productId}")

.NET

scope.Span.SetTag("datadog.api_catalog.route", "/products/{productid}");

Go

span.SetTag("datadog.api_catalog.route", "/products/:id")

Ruby

Datadog::Tracing.active_trace.set_tag('datadog.api_catalog.route', '/products/:id')

After you set this tag, you should see this tag in spans:

This leads to the endpoint displaying in the API Catalog:

Further reading

Additional helpful documentation, links, and articles:

Datadog API CatalogDOCUMENTATION