Skip to content

Commit 9563b69

Browse files
bmehta001Copilot
andcommitted
docs: clarify ORT_TELEMETRY_DISABLED disables non-essential telemetry
Note that the variable disables non-essential telemetry and, unlike in ONNX Runtime, applies on every desktop platform including Windows (GenAI uses 1DS everywhere, not ETW). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 8f78844 commit 9563b69

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

docs/Telemetry.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Telemetry can be disabled in any of these ways:
3131

3232
- **Don't build it in.** Telemetry is only compiled when configuring with `--use_telemetry` (`-DENABLE_TELEMETRY=ON`). To produce a binary that collects no data, invoke `build.py` directly without `--use_telemetry` (the `build.py` driver does not add the flag itself — only the `build.sh` / `build.bat` convenience scripts do).
3333
- **Automatically in CI / build pipelines.** When a well-known CI environment variable (`CI`, `TF_BUILD`, `GITHUB_ACTIONS`, `GITLAB_CI`, and others) is set to a truthy value, GenAI suppresses all telemetry — the 1DS uploader is never created and no device identifier is written. This matches ONNX Runtime, Olive, and Foundry Local.
34-
- **At runtime, via environment variable.** Set `ORT_TELEMETRY_DISABLED=1` (also accepts `true` / `yes` / `on` / `y`, case-insensitive) before the library initializes. This is the same variable honored by ONNX Runtime.
34+
- **At runtime, via environment variable.** Set `ORT_TELEMETRY_DISABLED=1` (also accepts `true` / `yes` / `on` / `y`, case-insensitive) before the library initializes to disable non-essential telemetry. It applies on every desktop platform, including Windows. This is the same variable honored by ONNX Runtime.
3535
- **At runtime, via the API.** Call `OgaSetTelemetryEnabled(false)` in the C API, or `Oga::SetTelemetryEnabled(false)` in the C++ API (equivalent calls exist in the other language bindings).
3636

3737
## What is collected

0 commit comments

Comments
 (0)