Skip to content

GH-16875: Document telemetry (README + User Guide page)#16877

Open
valenad1 wants to merge 4 commits into
rel-3.46.0from
valenad-gh-16875-telemetry-docs
Open

GH-16875: Document telemetry (README + User Guide page)#16877
valenad1 wants to merge 4 commits into
rel-3.46.0from
valenad-gh-16875-telemetry-docs

Conversation

@valenad1

@valenad1 valenad1 commented Jun 8, 2026

Copy link
Copy Markdown
Collaborator

Part of #16875

User-facing documentation for the opt-out telemetry added in #16876:

  • README Privacy & Telemetry section.
  • New Telemetry page under the User Guide (h2o-docs/src/product/telemetry.rst), noting it arrives in 3.46.0.12 — what's sent (coarse bucketed metrics + version/OS), what's never sent, and how to opt out (H2O_DISABLE_TELEMETRY / DO_NOT_TRACK / telemetry=False / -Dsys.ai.h2o.telemetry.disabled=true).

Wording only — kept separate from the implementation PR so the copy can be reviewed independently.

Add a Privacy & Telemetry section to the README and a Telemetry page under the
User Guide, noting opt-out anonymous usage telemetry starting in 3.46.0.12: what
is sent (coarse bucketed metrics plus version/OS), what is never sent, and the
opt-out switches.
@@ -0,0 +1,28 @@
Telemetry

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment thread README.md


<a name="Privacy"></a>
## 9. Privacy & Telemetry

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

valenad1 added 3 commits June 8, 2026 18:43
…xact, note DNT/Sec-GPC

- Drop the inaccurate 'numeric values are always ranges' claim: a small
  cluster's node count (1-16) is sent exactly; larger clusters are bucketed.
- Note that the receiver also honors the W3C DNT: 1 and Sec-GPC: 1 request
  headers (verified in h2o-3-telemetry app/transport/http.py).
…etry docs

The h2o-3-telemetry receiver repo is private, so describing it as open source
and telling users to point H2O_TELEMETRY_URL at their own receiver doesn't hold
for end users. Remove that paragraph from the README and the User Guide page.
@sonarqubecloud

sonarqubecloud Bot commented Jun 9, 2026

Copy link
Copy Markdown

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