From 27f5405cefd6701ffac4c6243030486fb7d3c942 Mon Sep 17 00:00:00 2001 From: Nok Lam Chan Date: Tue, 28 May 2024 19:45:14 +0100 Subject: [PATCH] Update telemetry.md (#3897) * Update telemetry.md Signed-off-by: Nok Lam Chan * Added note about project UUID (#3899) Signed-off-by: Elena Khaustova --------- Signed-off-by: Nok Lam Chan Signed-off-by: Elena Khaustova Co-authored-by: ElenaKhaustova <157851531+ElenaKhaustova@users.noreply.github.com> --- docs/source/configuration/telemetry.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/configuration/telemetry.md b/docs/source/configuration/telemetry.md index 20824713fe..3f01bba1da 100644 --- a/docs/source/configuration/telemetry.md +++ b/docs/source/configuration/telemetry.md @@ -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.