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.

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

kedro-telemetry: Implement telemetry message notification #727

Closed
DimedS opened this issue Jun 14, 2024 · 4 comments · Fixed by #760
Closed

kedro-telemetry: Implement telemetry message notification #727

DimedS opened this issue Jun 14, 2024 · 4 comments · Fixed by #760
Assignees

Comments

@DimedS
Copy link
Contributor

DimedS commented Jun 14, 2024

Description

Part of #715:

Implement a new telemetry message to inform users about anonymous usage data collection:

Kedro is sending anonymous usage data with the sole purpose of improving the product. No personal data or IP addresses are stored on our side. 
If you want to opt out, set the `KEDRO_DISABLE_TELEMETRY` or `DO_NOT_TRACK` environment variables, or create a  `.telemetry` file in the current working directory with the contents `consent: false`.
Read more at https://docs.kedro.org/en/latest/configuration/telemetry.html

Display that message after:

  1. Kedro installation with pip install kedro command.
  2. Each kedro command: once per kedro command execution when the kedro-telemetry plugin was used to send telemetry (consent wasn't disabled).

QUESTION PLEASE COMMENT: Should we message something If consent was disabled
Currently, the message displayed when consent is disabled is:

Kedro-Telemetry is installed, but you have opted out of
sharing usage analytics so none will be collected.
@merelcht merelcht moved this to To Do in Kedro Framework Jun 20, 2024
@merelcht merelcht changed the title kedro-telemetry: Implement telemetry message notification kedro-telemetry: Implement telemetry message notification Jul 1, 2024
@DimedS DimedS moved this from To Do to In Progress in Kedro Framework Jul 5, 2024
@DimedS
Copy link
Contributor Author

DimedS commented Jul 8, 2024

Regarding point 1, I tried several approaches to print a message after the pip install command. The best result I achieved was printing something in verbose mode (-v) during the pip install . command (or during the package build stage) using the setup.py file. Based on my investigation, it appears there is currently no way to print a message after installing from a .whl file. Therefore, I propose removing this requirement and focusing solely on point 2. I also checked that other packages with opt-out telemetry do not print anything after pip install. @astrojuanlu

@DimedS DimedS linked a pull request Jul 9, 2024 that will close this issue
3 tasks
@DimedS DimedS moved this from In Progress to In Review in Kedro Framework Jul 9, 2024
@astrojuanlu
Copy link
Member

I think it will be difficult or outright impossible to display it after pip install. Precompiled wheels are just unzip && cp, no chance to give any message.

@astrojuanlu
Copy link
Member

Oh I see how my phrasing led you into investigating this. Yeah, enough with Kedro commands.

@DimedS
Copy link
Contributor Author

DimedS commented Jul 9, 2024

Oh I see how my phrasing led you into investigating this. Yeah, enough with Kedro commands.

I reread your phrase and understand that it seems you mean installing Kedro and then executing kedro run and then printing. I interpreted it slightly differently)) However, it would actually be great to print it after running pip install kedro, before the user executes any command, but it looks like there really is no way to do that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

4 participants