Skip to content

Commit

Permalink
Added note about project UUID (#3899)
Browse files Browse the repository at this point in the history
Signed-off-by: Elena Khaustova <ymax70rus@gmail.com>
  • Loading branch information
ElenaKhaustova committed May 28, 2024
1 parent 8c62911 commit e422664
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/source/configuration/telemetry.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ which will prompt you for your consent the first time.

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

0 comments on commit e422664

Please sign in to comment.