Skip to content

docs: remove manual SDK config env vars; drain mode is automatic on Vercel - #28

Merged
Luke Shiels (skve) merged 3 commits into
mainfrom
docs/sdk-config-cleanup
Nov 3, 2026
Merged

Luke Shiels (skve) merged 3 commits into
mainfrom
docs/sdk-config-cleanup

Conversation

@skve

@skve Luke Shiels (skve) commented Nov 3, 2026 •

Copy link
Copy Markdown
Contributor

Users should configure only the surface public key and API keys (Luke, 2026-11-03). This PR removes every other manual SDK setting from the docs and states that drain mode is automatic on Vercel. Tracked in Beads interfere-0l8g.50.3. The SDK side ships in a separate monorepo PR (interfere-0l8g.50.2).

Variables and options removed, and why

Removed Where Why
INTERFERE_SERVER_TRACING=drain integrations/vercel.mdx, sdk/opentelemetry.mdx The build reads the trace drain from the surface configuration; the SDK no longer reads this variable. The serverTracing option of register() is removed too, and no page mentions it.
INTERFERE_LOG_SOURCING=drain integrations/vercel.mdx, sdk/opentelemetry.mdx Same, for the log drain.
INTERFERE_ENVIRONMENT=staging (quickstart env blocks) sdk/next-js, vite, tanstack-start, node, nestjs, releases Vercel and Cloudflare supply the environment. sdk/configuration.mdx keeps a single sentence for self-hosted staging.
environment: process.env.INTERFERE_ENVIRONMENT sdk/node.mdx init() example Same. The environment option row now describes the platform default.
INTERFERE_DEBUG=1 sdk/node.mdx, sdk/nestjs.mdx No reader for it could be found. The debug option stays.
INTERFERE_SOURCE_ID instructions sdk/node.mdx, sdk/nestjs.mdx Replaced with a link to the releases page, which keeps the Docker/no-git instructions.

Kept

INTERFERE_PUBLIC_KEY, VITE_INTERFERE_PUBLIC_KEY, INTERFERE_API_KEY, INTERFERE_SECRET_KEY, INTERFERE_ACCESS_TOKEN, INTERFERE_TOKEN, INTERFERE_WORKSPACE, INTERFERE_SOURCE_ID (releases.mdx only) and INTERFERE_ENVIRONMENT (configuration.mdx only, self-hosted staging).

Added

  • integrations/vercel.mdx: no configuration is needed.
    • The SDK follows the surface's drains.
    • A surface without a drain keeps the SDK exporter, and on Vercel each direct export is capped at 2 s.
  • sdk/opentelemetry.mdx: one paragraph explaining that under @vercel/otel a direct exporter flushes in waitUntil, so each invocation stays billed. With a Vercel trace drain the SDK switches to drain automatically.

Checks

mint validate and mint broken-links --check-anchors --check-redirects pass. oxfmt is clean.

Merge after the SDK PR is released, because these pages describe its behaviour. Luke merges.

🤖 Generated with Claude Code

https://claude.ai/code/session_01EYipKTQdyAHwnofZV7b7j9

Luke Shiels (skve) and others added 2 commits November 3, 2026 10:51
…tion is unavailable

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EYipKTQdyAHwnofZV7b7j9
…rains only

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EYipKTQdyAHwnofZV7b7j9
@skve
Luke Shiels (skve) merged commit d013432 into main Nov 3, 2026
4 checks passed
@skve
Luke Shiels (skve) deleted the docs/sdk-config-cleanup branch November 3, 2026 18:13
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.

1 participant