Observability Integrations

In brief: Connect a supported observability provider, map one provider service or dataset to an OpenAPI service, and enrich API governance with aggregated runtime evidence.

TestChimp observability integrations connect provider-side aggregate runtime metrics to your OpenAPI operations. They complement test coverage; they do not replace it.

Supported providers

Provider	Resource discovered	Current runtime metrics
Google Cloud Monitoring	OpenTelemetry service.name in Google Managed Service for Prometheus	Requests, errors, HTTP status classes, p50/p95/p99 latency
CloudWatch	Application Signals service or API Gateway API/stage	Requests and p95 latency; API Gateway also provides 5xx errors
Datadog	APM service	Request count
Honeycomb	Dataset	Request count and p50/p95/p99 latency

Provider capabilities depend on the aggregate metrics exposed by that provider and the permissions granted to the connection.

Common setup

1. Open Project Settings → Integrations → Observability.
2. Select Add observability provider.
3. Select a provider and enter the fields documented in its guide.
4. Choose Test Connection before saving.
5. Open APIs, select the OpenAPI service, and choose Map observability resource.
6. Select the provider resource that represents that service.
7. Run Sync now.

TestChimp discovers runtime routes from the previous 24 hours. Only routes with traffic in that window participate in mapping.

Read-only access and stored data

Use a dedicated identity with only the permissions listed in the provider guide.

TestChimp stores:

• encrypted provider credentials;
• the selected provider resource;
• observed method/route to OpenAPI-operation mappings;
• aggregate hourly metric windows; and
• aggregate daily summaries used by the APIs list.

TestChimp does not fetch or store raw traces, logs, span bodies, or request payloads through an observability connection.

Metric windows

• The hourly collector queries the prior completed hour.
• The daily collector queries the prior completed UTC day.
• The APIs list prefers the latest completed daily summary.
• If that daily summary is not available for an operation, the list uses the latest persisted hourly result.
• The detail chart reads persisted metric windows; opening a page never triggers provider aggregation.

Route requirements

Route discovery requires an HTTP method and a stable route template, such as GET /users/{id}. Do not emit concrete paths such as /users/18492; they create high-cardinality metrics and cannot be mapped safely to an OpenAPI operation.

After mapping:

• Mapped routes matched an OpenAPI operation.
• Unmapped routes were observed but did not match the contract.
• Not observed operations exist in the spec but had no discovered route.

See Observability in API Contract Governance for how these states and runtime summaries are used.

Credential rotation

Edit the connection, provide the replacement secret fields, test the connection, and save. Leaving a secret field blank while editing preserves the existing encrypted value. Revoke the old credential in the provider only after the replacement connection succeeds.