Skip to main content

Honeycomb

In brief: Use a Honeycomb Configuration API key with query permissions, select a dataset, and map http.method and http.route aggregates to OpenAPI operations.

The Honeycomb integration uses the Query Data API to read request count and p50/p95/p99 latency grouped by HTTP method and route.

:::caution Honeycomb plan requirement The required Run Queries Configuration API-key permission is available on Honeycomb Enterprise. A free-plan key can authenticate successfully but still fail during route sync. :::

Event fields​

Events in the selected dataset must contain:

  • http.method
  • http.route
  • duration_ms for latency percentiles

http.route must be a stable route template. TestChimp does not fall back to concrete URL paths because doing so creates high-cardinality, unsafe mappings.

The current adapter does not populate error rate from Honeycomb.

Create the key​

In Honeycomb, open Environment Settings → API Keys and create a Configuration API key, not an Ingest key. Enable:

  • Manage Queries and Columns
  • Run Queries

Restrict the key to the environment containing the dataset. TestChimp needs query access; it does not ingest events or modify dataset data.

See Honeycomb Environment API keys.

Configure TestChimp​

In Project Settings → Integrations → Observability:

  1. Select Honeycomb.
  2. Enter the API key.
  3. Optionally enter a default Dataset slug.
  4. Keep the default API base URL for Honeycomb US. For EU or a private endpoint, enter the appropriate Honeycomb API base URL.
  5. Choose Test Connection and save.
  6. In APIs, select the dataset and map it to the corresponding OpenAPI service.

Use the dataset slug, not only its display name, when entering it manually.

Troubleshooting​

  • Authentication succeeds but sync returns 401 — the key is missing Run Queries or Manage Queries and Columns, or the Honeycomb plan does not include Run Queries.
  • 404 while querying a dataset — verify the dataset slug and API region.
  • No routes appear — verify recent events have both http.method and http.route.
  • RPM appears but latency is empty — verify duration_ms exists and is numeric.
  • More than 1,000 routes — reduce route cardinality. The discovery query intentionally limits grouped results to 1,000.

Rotate the key by updating and testing the connection, then revoke the old key in Honeycomb.

FAQ

Which Honeycomb key permissions are required?

Manage Queries and Columns plus Run Queries on a Configuration API key.

Does Honeycomb Free support this integration?

The required Run Queries key permission is Enterprise-only, so the complete sync flow is not available on the free plan.

Which Honeycomb event fields are required?

http.method, http.route, and duration_ms for latency percentiles.

Related documentation