Skip to content

docs(getting-started): align telemetry section with known issue #5 (header not sent, opt-out env not implemented) - #437

Open
LeonSGP43 wants to merge 1 commit into
NVIDIA-NeMo:mainfrom
LeonSGP43:docs/telemetry-optout-accuracy
Open

docs(getting-started): align telemetry section with known issue #5 (header not sent, opt-out env not implemented)#437
LeonSGP43 wants to merge 1 commit into
NVIDIA-NeMo:mainfrom
LeonSGP43:docs/telemetry-optout-accuracy

Conversation

@LeonSGP43

@LeonSGP43 LeonSGP43 commented Aug 15, 2026

Copy link
Copy Markdown

Problem

The Troubleshooting section of docs/getting_started.md instructs users to disable telemetry with:

export SWITCHYARD_TELEMETRY_OPT_OUT=1

Two problems, verified against the current tree:

  1. The opt-out environment variable does not exist. grep -r SWITCHYARD_TELEMETRY_OPT_OUT across all .rs and .py sources returns zero hits. The variable appears only in this doc.
  2. The header it disables is not sent. grep -rni "switchyard.version" --include="*.rs" --include="*.py" finds no code that sets an X-Switchyard-Version header on outbound calls. This is already acknowledged in docs/known_issues.md (0.2.0, item 5): "The native server does not send the documented X-Switchyard-Version header 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' . → only docs/getting_started.md (pre-patch).
  • grep -rni 'x-switchyard-version' crates/ switchyard* → zero code hits; only docs mention it.
  • docs/known_issues.md item 5 confirms the header is not sent in 0.2.0.
  • Relative link known_issues.md resolves (same directory).

Summary by CodeRabbit

  • Documentation
    • Updated telemetry troubleshooting guidance to clarify that the 0.2.0 native server does not currently send the documented version header upstream.
    • Removed outdated telemetry opt-out instructions.

…er not sent, opt-out env not implemented

Signed-off-by: LeonSGP43 <leonsgp43@users.noreply.github.com>
@LeonSGP43
LeonSGP43 requested a review from a team as a code owner August 15, 2026 04:52
@coderabbitai

coderabbitai Bot commented Aug 15, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: c11fb144-3234-4014-b798-f7c752625964

📥 Commits

Reviewing files that changed from the base of the PR and between 9ad6744 and d2143f5.

📒 Files selected for processing (1)
  • docs/getting_started.md

Walkthrough

The getting started guide replaces telemetry opt-out instructions with a note about the native server's current X-Switchyard-Version header behavior.

Changes

Telemetry documentation

Layer / File(s) Summary
Update telemetry troubleshooting guidance
docs/getting_started.md
The guide states that the 0.2.0 native server does not send the X-Switchyard-Version header upstream and does not require telemetry opt-out.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to d2143

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

A bunny reads the guide today,
“No opt-out flag is needed,” they say.
The header stays at home,
No upstream paths to roam,
Clear telemetry words now lead the way.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly identifies the documentation update and its alignment with the known telemetry issue.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

Comment @coderabbitai help to get the list of available commands.

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