Skip to main content

Datadog

In brief: Give TestChimp read access to Datadog APM resources and metrics, select the correct Datadog site, and map an APM service to its OpenAPI service.

The Datadog integration reads APM service resources and route-level request counts. The current adapter does not populate error rate or latency.

Prerequisites​

  • Datadog APM is enabled for the service.
  • HTTP resources are named as stable route templates, preferably METHOD /route/{parameter}.
  • You have an organization API key and an application key with read access to APM resources and metrics.
  • You know the Datadog site that hosts the organization.

Use a restricted service-account application key rather than a personal key. The API key identifies the organization; the application key applies the identity's permissions.

Configure TestChimp​

In Project Settings → Integrations → Observability:

  1. Select Datadog.
  2. Enter the organization API key.
  3. Enter the Application key.
  4. Enter the Datadog Site hostname without a scheme. Examples:
    • datadoghq.com
    • datadoghq.eu
    • us3.datadoghq.com
  5. Choose Test Connection and save.
  6. In APIs, map the OpenAPI service to its Datadog APM service.

TestChimp validates credentials against the Datadog API and uses the selected site for all subsequent calls.

How routes are discovered​

TestChimp first reads APM resources for the service. If that does not return route resources, it queries trace.http.request.hits grouped by resource_name.

A resource name should include the HTTP method:

GET /customers/{customerId}

When a resource contains only /path, TestChimp must assume GET, which can produce an incorrect mapping for other methods. Configure APM resource naming to retain the method.

Troubleshooting​

  • 401 or 403 — verify both keys, application-key ownership and scopes, and organization.
  • Connection succeeds but no services appear — confirm APM has recent data and the application key can read APM services.
  • No routes appear — inspect resource_name on trace.http.request.hits; it must carry a templated path.
  • Wrong API host — enter the site hostname, not the browser URL or a URL with https://.
  • Only RPM appears — this is the current Datadog adapter capability; error rate and latency are intentionally left unavailable rather than inferred.

Rotate either key by editing and retesting the connection before revoking the old key.

FAQ

Which Datadog keys are required?

An organization API key and a restricted application key with read access to APM resources and metrics.

Which metrics does the Datadog adapter provide?

The current adapter provides route request counts.

What should resource_name contain?

Use a stable value such as GET /customers/{customerId} so both method and route template can be mapped.

Related documentation