Kedro-Telemetry

Warnings

• breaking Support for Python 3.9 was dropped in version 0.7.0, making Python 3.10 the minimum supported version. Earlier versions (0.6.2) dropped Python 3.8. Kedro-Telemetry aims to support only actively maintained Python versions.
  Fix: Upgrade to a supported Python version (3.10 or higher).
• gotcha Versions `kedro-telemetry >= 0.2.2` and `< 0.2.4` had a bug that led to the collection of project size metrics (datasets, pipelines, nodes) without explicit user consent. This issue was addressed in later versions, and affected data was deleted.
  Fix: Upgrade to `kedro-telemetry >= 0.2.4` to avoid this bug.
• gotcha In automated environments (e.g., CI/CD), if telemetry consent is not explicitly granted or denied, `kedro-telemetry` might spawn an interactive prompt, causing the pipeline to crash. This is especially critical since version 0.6.0, where telemetry became opt-out by default.
  Fix: Explicitly disable telemetry using environment variables (`KEDRO_DISABLE_TELEMETRY=1` or `DO_NOT_TRACK=1`) or by creating a `.telemetry` file with `consent: false` in the project root.
• deprecated Uninstalling `kedro-telemetry` using `pip uninstall kedro-telemetry` is strongly discouraged as a method to disable telemetry. It can break dependencies of the core Kedro framework and lead to `pip check` reporting issues.
  Fix: Use environment variables (`KEDRO_DISABLE_TELEMETRY=1`) or the `.telemetry` file (`consent: false`) to disable telemetry without removing the package.

Install

• pip install kedro-telemetry

Imports

• No direct user imports

  kedro-telemetry operates as a plugin for the Kedro CLI and runtime; users do not typically import symbols from it directly in their project code.

  Functionality is managed via configuration and environment variables.

Quickstart

Kedro-Telemetry is enabled by default as of version 0.6.0. The primary interaction for users is to manage consent or opt-out. The recommended way to disable telemetry is by setting the `KEDRO_DISABLE_TELEMETRY` or `DO_NOT_TRACK` environment variables to any value. Alternatively, a `.telemetry` file can be created in the project root with `consent: false`, or telemetry can be disabled during project creation using `kedro new --telemetry=no`.

import os

# Opt-out of telemetry for the current environment
os.environ['KEDRO_DISABLE_TELEMETRY'] = '1'

# Alternatively, for a specific project, create a .telemetry file in the project root:
# with open('.telemetry', 'w') as f:
#     f.write('consent: false')

# Or when creating a new Kedro project:
# kedro new --telemetry=no

# Example of running a Kedro command, which will now respect the opt-out setting
# (Note: This is illustrative, actual Kedro commands would be run from the shell)
print(f"KEDRO_DISABLE_TELEMETRY is set to: {os.environ.get('KEDRO_DISABLE_TELEMETRY')}")
print("Kedro commands executed in this environment will have telemetry disabled.")