-
Notifications
You must be signed in to change notification settings - Fork 2k
GH-16875: Document telemetry (README + User Guide page) #16877
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.
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
Closed
+94
−2
Closed
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
6ae619a
GH-16875: Document telemetry (README + User Guide page)
valenad1 48959a5
GH-16875: Correct telemetry wording — small-cluster node counts are e…
valenad1 97817eb
GH-16875: Drop private-receiver / H2O_TELEMETRY_URL claims from telem…
valenad1 8a97b01
GH-16875: Document the first-run telemetry disclosure notice
valenad1 a498455
GH-16875: Document telemetry getter/setter; drop first-run notice sec…
valenad1 dd7c5bc
GH-16875: Document telemetry as opt-in (default off)
valenad1 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| Telemetry | ||
|
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
| ========= | ||
|
|
||
| Starting with version **3.46.0.12**, H2O-3 sends anonymous usage telemetry to help the team prioritize features and platforms. It is **opt-out** and designed to be invisible: every send is fire-and-forget with a short timeout, so if the receiver is unreachable your code behaves exactly as if telemetry never ran — it never blocks, raises, or retries. | ||
|
|
||
| What is sent | ||
| ------------ | ||
|
|
||
| - One small ping when you start or connect to H2O (``h2o.init()`` / ``h2o.connect()`` in Python or R, or a standalone ``java -jar h2o.jar`` / ``hadoop jar h2odriver.jar`` cluster), plus one per major action: training, scoring, MOJO and model download, upload, import, parse, AutoML, and model save/load. | ||
| - Each ping contains the H2O version, the client (``python`` / ``r`` / ``jvm``), the operating system, an ephemeral session ID regenerated on every start, a timestamp, the algorithm name, and **coarse range buckets** for counts such as rows, columns, durations, and sizes. Numeric values are always ranges, never exact figures. | ||
|
|
||
| What is never sent | ||
| ------------------ | ||
|
|
||
| Code, file paths, dataset or model names, column names, parameter values, hostnames, usernames, email addresses, or any user-generated content. | ||
|
|
||
| Opting out | ||
| ---------- | ||
|
|
||
| Any one of the following disables telemetry completely: | ||
|
|
||
| - Set an environment variable: ``H2O_DISABLE_TELEMETRY=1`` or ``DO_NOT_TRACK=1``. | ||
| - Pass ``telemetry=False`` (Python) or ``telemetry = FALSE`` (R) to ``h2o.init()``. | ||
| - For a cluster started directly on the JVM, add ``-Dsys.ai.h2o.telemetry.disabled=true``. | ||
|
|
||
| The wire format and the receiver software are open source in the | ||
| `h2o-3-telemetry <https://github.com/h2oai/h2o-3-telemetry>`__ repository. To send | ||
| telemetry to your own receiver instead, set the ``H2O_TELEMETRY_URL`` environment variable. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@carmilea @mmalohlava