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

feat(telemetry): Introduce DO_NO_TRACK and KEDRO_DISABLE_TELEMETRY #762

Merged
merged 9 commits into from
Jul 16, 2024

Conversation

noklam
Copy link
Contributor

@noklam noklam commented Jul 10, 2024

Description

Fix #728

Development notes

  • Added two new env vars to skip telemetry if exist. It will override the consent regardless what is written in a .telemetry file.

Checklist

  • Opened this PR as a 'Draft Pull Request' if it is work-in-progress
  • Updated the documentation to reflect the code changes
  • Added a description of this change in the relevant RELEASE.md file
  • Added tests to cover my changes

Signed-off-by: Nok Lam Chan <nok.lam.chan@quantumblack.com>
Signed-off-by: Nok Lam Chan <nok.lam.chan@quantumblack.com>
Signed-off-by: Nok Lam Chan <nok.lam.chan@quantumblack.com>
Signed-off-by: Nok Lam Chan <nok.lam.chan@quantumblack.com>
Signed-off-by: Nok Lam Chan <nok.lam.chan@quantumblack.com>
Signed-off-by: Nok Lam Chan <nok.lam.chan@quantumblack.com>
@noklam noklam changed the title Introduce DO_NO_TRACK and KEDRO_DISABLE_TELEMETRY feat(telemetry): Introduce DO_NO_TRACK and KEDRO_DISABLE_TELEMETRY Jul 10, 2024
@noklam noklam requested review from DimedS and lrcouto July 10, 2024 16:26
@@ -1,4 +1,5 @@
# Upcoming release
* Added `DO_NOT_TRACK` and `KEDOR_DISABLE_TELEMETRY` environment variables to skip telemetry.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Added `DO_NOT_TRACK` and `KEDOR_DISABLE_TELEMETRY` environment variables to skip telemetry.
* Added `DO_NOT_TRACK` and `KEDRO_DISABLE_TELEMETRY` environment variables to skip telemetry.

Copy link
Contributor

@lrcouto lrcouto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me. I tested it locally and it works fine.

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>
@noklam
Copy link
Contributor Author

noklam commented Jul 11, 2024

CI error is irrelevant, suspect some changes caused by kedro-org/kedro#3883.

Copy link
Contributor

@DimedS DimedS left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, @noklam! I appreciate the flow where these environment variables take first priority only when they are set to True.

@noklam noklam merged commit 0ea4218 into main Jul 16, 2024
9 checks passed
@noklam noklam deleted the noklam/kedro-telemetry-introduce-728 branch July 16, 2024 15:17
merelcht pushed a commit to galenseilis/kedro-plugins that referenced this pull request Aug 27, 2024
kedro-org#762)

* add env var to skip telemetry

Signed-off-by: Nok Lam Chan <nok.lam.chan@quantumblack.com>

* release note

Signed-off-by: Nok Lam Chan <nok.lam.chan@quantumblack.com>

* update README

Signed-off-by: Nok Lam Chan <nok.lam.chan@quantumblack.com>

* fix test

Signed-off-by: Nok Lam Chan <nok.lam.chan@quantumblack.com>

* Change constant to tuple to avoid random test error

Signed-off-by: Nok Lam Chan <nok.lam.chan@quantumblack.com>

* linting

Signed-off-by: Nok Lam Chan <nok.lam.chan@quantumblack.com>

* fix typo

Signed-off-by: Nok <nok.lam.chan@quantumblack.com>

---------

Signed-off-by: Nok Lam Chan <nok.lam.chan@quantumblack.com>
Signed-off-by: Nok <nok.lam.chan@quantumblack.com>
Co-authored-by: Dmitry Sorokin <40151847+DimedS@users.noreply.github.com>
Signed-off-by: Merel Theisen <merel.theisen@quantumblack.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

kedro-telemetry: Introduce environment variables for disabling telemetry and revise disabling methods
3 participants