Registry / observability / kedro-telemetry

kedro-telemetry

JSON →
library0.8.0pypypiunverified

Kedro-Telemetry is a plugin for the Kedro framework that gathers anonymised and aggregated usage analytics. Its primary purpose is to help the Kedro team understand how Kedro is used, allowing them to prioritise product improvements. It currently ships as version 0.7.0 and integrates via `pluggy` hooks to send data to Heap Analytics.

pip install kedro-telemetry
INSTALL
IMPORT
SIG · KEDRO-TELEMETRY
K
kedro-telemetry
observabilitypythonv0.8.0
Install
7.2s avg
Import
Disk
57MB
Pass rate
10/ 10
Env Coverage10 / 10
glibc
3.93.13
musl
3.93.13
Install & Compatibility
Where this runs
tested against v0.8.0 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
musl
py 3.103.920 runs
installs and imports cleanly · install 0.0s · import 0.000s · 56.7MB
glibc
py 3.103.920 runs
installs and imports cleanly · install 7.2s · import 0.000s · 58MB
57MB installed
● package 57MB
Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

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.

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.")
Debug
Known issues
breakingSupport 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).
affects: >=0.7.0 (for Python 3.9), >=0.6.2 (for Python 3.8)
gotchaVersions `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.
affects: 0.2.2 to 0.2.3
gotchaIn 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.
affects: >=0.6.0
deprecatedUninstalling `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.
affects: All versions
Upgrade
Version history
0.8.0latest on PyPI · released May 22, 2026
Audit
Dependencies
kedrorequiredkedro-telemetry is a plugin for the Kedro framework and is typically installed as part of Kedro's dependencies.
tomlirequiredUsed for TOML parsing, specifically before Python 3.11 for reading `.telemetry` files. Post Python 3.11, `tomli` is often replaced by the standard library's `tomllib`.
tomli-wrequiredUsed for writing TOML files, specifically for `.telemetry` files.
Agent activity
5 hits · last 30 days
node
4
OpenAI (training)
1
Resources
kedro-telemetry — pip install kedro-telemetry · libregistry