Skip to content

Correct PerfTrace export prerequisites and settings secrets guidance - #1013

Merged
TheGreatAxios merged 1 commit into
mainfrom
cl-7900-verify-docsperftracemd-especially-the-opt-in-default
Sep 14, 2026
Merged

TheGreatAxios merged 1 commit into
mainfrom
cl-7900-verify-docsperftracemd-especially-the-opt-in-default

Conversation

@TheGreatAxios

Copy link
Copy Markdown
Collaborator

Summary: applies verified Shakespeare fixes to docs/PERFTRACE.md — drops the fixed count of PostHog product events, removes the auth header from the settings example with env-only secrets guidance, and states that an endpoint alone enables export. Opt-in default statements untouched; docs text only.

Verification: pre-commit typecheck and build passed.

Fixes CL-7900

Drop the fixed count of PostHog product events, remove the auth header from the settings example, and state that an endpoint alone enables export.
@linear-code

linear-code Bot commented Sep 13, 2026

Copy link
Copy Markdown

CL-7900

@TheGreatAxios

Copy link
Copy Markdown
Collaborator Author

Critic · Approve

Corrects PerfTrace export prerequisites and settings secrets guidance; docs text only.

Findings

  • docs/PERFTRACE.md (endpoint-enables-export) — Accurate. src/perf/otel-config.ts:238-242,249-272,352-360 shows any non-empty endpoint (settings or env) proceeds to validation and returns enabled: true with no enabled === true gate; empty endpoint with only service name/attrs falls through to enabled: false (line 270-271).
  • docs/PERFTRACE.md (otel.enabled: false precedence) — Accurate. Lines 244-247 force off only when no env endpoint is set; an explicit env endpoint bypasses the off switch.
  • docs/PERFTRACE.md (headers via env) — Accurate as guidance and matches the code comment at src/perf/otel-config.ts:33-36 ("Prefer ... env so secrets stay out of settings files"). No code changed; settings.otel.headers remains a supported fallback (lines 290-303), so the "Do not" reads as prescriptive best practice, not a removal — fine as written.
  • docs/PERFTRACE.md ("three" -> "Allowlisted product events") — Accurate direction. docs/TELEMETRY.md lists more than three events (product table plus AI observability section), so dropping the fixed count removes a stale coupling.
  • Hygiene — Docs-only diff, one file (docs/PERFTRACE.md, +8/-3). No code snuck in. Removing the credential-looking Authorization value from the settings example is a strict improvement.

Nits (non-blocking)

  • None. Optional: explicitly note settings.otel.headers still works as a fallback for operators who need it, since the error string at otel-config.ts:182 names it. Not required for merge.

Verdict

Merge-ready. No blocking issues.

@TheGreatAxios
TheGreatAxios marked this pull request as ready for review September 14, 2026 04:46
@TheGreatAxios
TheGreatAxios merged commit 52f837a into main Sep 14, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant