Skip to content

Commit

Permalink
Update telemetry docs for opt-out model (#4040)
Browse files Browse the repository at this point in the history
* Modify telemetry docs after opt-out

---------

Signed-off-by: Dmitry Sorokin <dmd40in@gmail.com>
Signed-off-by: Dmitry Sorokin <40151847+DimedS@users.noreply.github.com>
Co-authored-by: ElenaKhaustova <157851531+ElenaKhaustova@users.noreply.github.com>
Co-authored-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>
  • Loading branch information
3 people authored Aug 1, 2024
1 parent 8bbbfb6 commit c0d2bac
Showing 1 changed file with 24 additions and 29 deletions.
53 changes: 24 additions & 29 deletions docs/source/configuration/telemetry.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ Kedro can capture anonymised telemetry.
This data is collected with the sole purpose of improving Kedro by understanding feature usage.
Importantly, we do not store personal information about you or sensitive data from your project,
and this process is never utilized for marketing or promotional purposes.
Participation in this program is optional, and Kedro will continue working as normal if you opt-out.
Participation in this program is optional, and it is enabled by default. Kedro will continue working as normal if you opt-out.

The Kedro Project's telemetry has been reviewed and approved under the
[Telemetry Data Collection and Usage Policy] of LF Projects, LLC.

Kedro collects anonymous telemetry through [the Kedro-Telemetry plugin],
which will prompt you for your consent the first time.
which is installed as one of Kedro’s dependencies.

[the Kedro-Telemetry plugin]: https://github.com/kedro-org/kedro-plugins/tree/main/kedro-telemetry
[Telemetry Data Collection and Usage Policy]: https://lfprojects.org/policies/telemetry-data-policy/
Expand All @@ -31,38 +31,33 @@ which will prompt you for your consent the first time.
For technical information on how the telemetry collection works, you can browse
[the source code of `kedro-telemetry`](https://github.com/kedro-org/kedro-plugins/tree/main/kedro-telemetry).

## How do I consent to the use of Kedro-Telemetry?

Kedro-Telemetry is a Python plugin. To install it:

```console
pip install kedro-telemetry
```

```{note}
If you are using an official [Kedro project template](/starters/starters) then `kedro-telemetry` is included in the [project-level `requirements.txt`](/kedro_project_setup/dependencies) of the starter. `kedro-telemetry` is activated after you have a created a new project with a [Kedro project template](/starters/starters) and have run `kedro install` from the terminal.
```
## How do I withdraw consent?

When you next run the Kedro CLI you will be asked for consent to share usage analytics data for the purposes explained in the privacy notice, and a `.telemetry` YAML file will be created in the project root directory. The variable `consent` will be set according to your choice in the file, e.g. if you consent:
To withdraw consent, you have a few options:

```yaml
consent: true
```
1. **Set Environment Variables**:
Set the environment variables `DO_NOT_TRACK` or `KEDRO_DISABLE_TELEMETRY` to any value. The presence of any of these environment variables will disable telemetry for all Kedro projects in that environment and will override any consent specified in the `.telemetry` file of the specific project.

```{note}
The `.telemetry` file should not be committed to `git` or packaged in deployment. In `kedro>=0.17.4` the file is git-ignored.
```
2. **CLI Option When Creating a New Project**:
When creating a new project, you can use the command:

## How do I withdraw consent?
```console
kedro new --telemetry=no
```
This will create a new project with a `.telemetry` file in its root folder, containing `consent: false`. This file will be used when executing Kedro commands within that project folder. Note that telemetry data about the execution of the `kedro new` command will still be sent if telemetry has not been disabled using environment variables.

To withdraw consent, you can change the `consent` variable to `false` in `.telemetry` YAML by editing the file in the following way:
>*Note:* The `.telemetry` file should not be committed to `git` or packaged in deployment. In `kedro>=0.17.4` the file is git-ignored.

```yaml
consent: false
```
3. **Modify or Create the `.telemetry` file manually**:
If the `.telemetry` file exists in the root folder of your Kedro project, set the `consent` variable to `false`. If the file does not exist, create it with the following content:
```yaml
consent: false
```

Or you can uninstall the plugin:
4. **Uninstall the plugin**:
Remove the `kedro-telemetry` plugin:

```console
pip uninstall kedro-telemetry
```
```console
pip uninstall kedro-telemetry
```
>*Note:* This is a last resort option, as it will break the dependencies of Kedro (for example, `pip check` will report issues).

0 comments on commit c0d2bac

Please sign in to comment.