Skip to content

Commit

Permalink
Update telemetry.md (#3897)
Browse files Browse the repository at this point in the history
* Update telemetry.md

Signed-off-by: Nok Lam Chan <[email protected]>

* Added note about project UUID (#3899)

Signed-off-by: Elena Khaustova <[email protected]>

---------

Signed-off-by: Nok Lam Chan <[email protected]>
Signed-off-by: Elena Khaustova <[email protected]>
Co-authored-by: ElenaKhaustova <[email protected]>
  • Loading branch information
noklam and ElenaKhaustova authored May 28, 2024
1 parent 011e3a8 commit 27f5405
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/source/configuration/telemetry.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ which will prompt you for your consent the first time.

## 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.
- **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.
- **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

0 comments on commit 27f5405

Please sign in to comment.