Repository navigation
docs: match the otel kit example to the sdk - #31
Open
Philip Snyder (pjsny) wants to merge 1 commit into
Open
Philip Snyder (pjsny) wants to merge 1 commit into
Philip Snyder (pjsny) wants to merge 1 commit into
Conversation
The OpenTelemetry composition page left out `idGenerator` and `traceContextPropagator`, and composed the propagators as `["auto", ...kit.propagators]`. The current `@interfere/next` kit needs `["auto", kit.traceContextPropagator, ...kit.propagators]`. - Update the `instrumentation.ts` example to match the kit source. - Add `idGenerator` and `traceContextPropagator` to the kit table. - State that the kit returns `null` on the Edge runtime, and that the app configuration selects drain or direct export.
Philip Snyder (pjsny)
requested review from
Jakub Krehel (jakubkrehel),
Luke Shiels (skve) and
Wiktor Gala (vv1ktor)
as code owners
November 4, 2026 22:52
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
The
sdk/opentelemetrypage shows how to composebuildInterfereOtelKit()with@vercel/otel. The example did not match the current@interfere/nextsource:kit.idGenerator.["auto", ...kit.propagators]. The kit TSDoc requires["auto", kit.traceContextPropagator, ...kit.propagators], and the SDK's ownregister()uses that order.idGeneratorortraceContextPropagator.This change updates the example, the kit table and the propagator sentence. The descriptions come from
InterfereOtelKitinsrc/packages/public/next/src/instrumentation.tsand the propagator classes undersrc/internal/server/tracing/in the monorepo.The same example also goes into the
@interfere/nextREADME and the@vercel/otelguide on interfere.com.Verification
bun run format,bun run lint,bun run typecheck,bun run validateandbun run check:linkspass.bun run dev,/sdk/opentelemetryshows the new example and the table with 9 rows.tsc --noEmitagainst@vercel/otel@2.1.3types.