Skip to content
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

Jump to bottom

Update telemetry.md #3897

Merged
merged 2 commits into from
May 28, 2024
Merged

Update telemetry.md #3897

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8c62911
Update telemetry.md
noklam May 28, 2024
e422664
Added note about project UUID (#3899)
ElenaKhaustova May 28, 2024
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
4 changes: 2 additions & 2 deletions docs/source/configuration/telemetry.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@

## Collected data fields:

- **Unique user identifier(UUID):** The UUID is a randomly generated anonymous identifier, stored within an OS-specific configuration folder for Kedro, named 'telemetry.conf'. If a UUID does not already exist, the telemetry plugin generates a new one, stores it, and then uses this UUID in subsequent telemetry events.
- **Unique user identifier(UUID):** The UUID is a randomly generated anonymous identifier, stored within an OS-specific configuration folder for Kedro, named `telemetry.toml`. If a UUID does not already exist, the telemetry plugin generates a new one, stores it, and then uses this UUID in subsequent telemetry events.

Check warning on line 21 in docs/source/configuration/telemetry.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/source/configuration/telemetry.md#L21 

[Kedro.toowordy] 'subsequent' is too wordy
Raw output 
{"message": "[Kedro.toowordy] 'subsequent' is too wordy", "location": {"path": "docs/source/configuration/telemetry.md", "range": {"start": {"line": 21, "column": 291}}}, "severity": "WARNING"}
- **CLI Command (Masked Arguments):** The command used, with sensitive arguments masked for privacy. Example Input: `kedro run --pipeline=ds --env=test` What we receive: `kedro run --pipeline ***** --env *****`
- **Hashed Package Name:** An anonymized identifier of the project.
- **Project UUID:** The hash of project UUID (randomly generated anonymous project identifier) and the package name. If project UUID does not already exist, the telemetry plugin generates a new one, stores it in `pyproject.toml`, and then joins this project UUID with the package name, hashes the joined result and uses it in subsequent telemetry events.

Check warning on line 23 in docs/source/configuration/telemetry.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/source/configuration/telemetry.md#L23 

[Kedro.toowordy] 'subsequent' is too wordy
Raw output 
{"message": "[Kedro.toowordy] 'subsequent' is too wordy", "location": {"path": "docs/source/configuration/telemetry.md", "range": {"start": {"line": 23, "column": 327}}}, "severity": "WARNING"}
- **Kedro Project Version:** The version of Kedro being used.
- **Kedro-Telemetry Version:** The version of the Kedro-Telemetry plugin.
- **Python Version:** The version of Python in use.
Expand Down