Discovering Endpoints from APM

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.

ALT TEXT

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.

API Catalog filters out spans that do not contain the following tags:
  • http.method
  • http.status_code

Example

The following examples demonstrate adding a custom tag for each span in Go and Ruby:

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:

ALT TEXT

This leads to the endpoint displaying in the API Catalog:

ALT TEXT

Further reading

Additional helpful documentation, links, and articles:

PREVIEWING: may/unit-testing