Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
LeonSGP43 wants to merge 1 commit into
base: main
Choose a base branch
from
+5 −7
Open

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 5 additions & 7 deletions docs/getting_started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,14 +225,12 @@ references, and route construction without starting the server.

Check health: `curl http://localhost:4000/health`

**Telemetry header opt-out**
**Telemetry header**

Switchyard adds an `X-Switchyard-Version` header to outbound LLM calls for
release attribution. No request or response content is included. To disable:

```bash
export SWITCHYARD_TELEMETRY_OPT_OUT=1
```
Switchyard documents an `X-Switchyard-Version` header for release attribution
on outbound LLM calls. No request or response content is included. The 0.2.0
native server does not currently send this header upstream (see
[Known Issues](known_issues.md)), so no opt-out is required at the moment.

---

Expand Down