Skip to content

docs: rename the OTel key to INTERFERE_TELEMETRY_KEY - #32

Merged
Philip Snyder (pjsny) merged 1 commit into
mainfrom
telemetry-key-name
Nov 6, 2026
Merged

Philip Snyder (pjsny) merged 1 commit into
mainfrom
telemetry-key-name

Conversation

@pjsny

Copy link
Copy Markdown
Member

Description

The OpenTelemetry pages stored the workspace telemetry key as INTERFERE_API_KEY. An app's build uses that name for its secret key. A project with both an app and an OpenTelemetry export then put 2 different keys in 1 variable.

This change renames the variable to INTERFERE_TELEMETRY_KEY on these pages:

  • sdk/otel-ingestion.mdx: the key setup, the Collector exporter and the direct export from a service.
  • sdk/nestjs.mdx: the key setup and the exporter header.

The Vercel guide does not change. Interfere reads only the Authorization header, so existing setups that use the old name keep working.

The same name is in the Interfere app (interfere/interfere#8031) and in the plugin setup skill (interfere-inc/plugins#2).

Verification

  • bun run format:check passes.
  • bun run validate passes.
  • bun run check:links finds no broken links.

The OpenTelemetry pages stored the workspace telemetry key as
`INTERFERE_API_KEY`. An app's build uses that name for its secret key.
A project with both an app and an OpenTelemetry export then put 2
different keys in 1 variable.

The OpenTelemetry ingestion page and the NestJS page now use
`INTERFERE_TELEMETRY_KEY` for the Collector and for direct export. The
Vercel guide does not change. Interfere reads only the header, so
existing setups that use the old name keep working.
@pjsny
Philip Snyder (pjsny) merged commit e8e7c3f into main Nov 6, 2026
5 checks passed
@pjsny
Philip Snyder (pjsny) deleted the telemetry-key-name branch November 6, 2026 18:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants