docs(getting-started): align telemetry section with known issue #5 (header not sent, opt-out env not implemented) - #437
Conversation
…er not sent, opt-out env not implemented Signed-off-by: LeonSGP43 <leonsgp43@users.noreply.github.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (1)
WalkthroughThe getting started guide replaces telemetry opt-out instructions with a note about the native server's current ChangesTelemetry documentation
Estimated code review effort: 1 (Trivial) | ~2 minutes Merge Risk: ⚪ Minimal · up to This documentation-only change corrects the telemetry guidance and links to the known issue; no actionable merge-blocking risk remains after normal checks and review. Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Comment |
Problem
The Troubleshooting section of
docs/getting_started.mdinstructs users to disable telemetry with:export SWITCHYARD_TELEMETRY_OPT_OUT=1Two problems, verified against the current tree:
grep -r SWITCHYARD_TELEMETRY_OPT_OUTacross all.rsand.pysources returns zero hits. The variable appears only in this doc.grep -rni "switchyard.version" --include="*.rs" --include="*.py"finds no code that sets anX-Switchyard-Versionheader on outbound calls. This is already acknowledged indocs/known_issues.md(0.2.0, item 5): "The native server does not send the documentedX-Switchyard-Versionheader upstream."So the section documents a working mechanism that is, in fact, a no-op today, and contradicts known_issues.md.
Change
Rewrite the section to state the attribution design, cite the 0.2.0 known issue, and drop the instruction to export a variable that has no effect. Adds a cross-link to
known_issues.md.Verification
grep -rn 'SWITCHYARD_TELEMETRY_OPT_OUT' .→ onlydocs/getting_started.md(pre-patch).grep -rni 'x-switchyard-version' crates/ switchyard*→ zero code hits; only docs mention it.docs/known_issues.mditem 5 confirms the header is not sent in 0.2.0.known_issues.mdresolves (same directory).Summary by CodeRabbit