Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 20 additions & 12 deletions docs/telemetry.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,32 @@
---
sidebar_label: Telemetry
title: Telemetry
description: Learn what usage data Apify CLI collects, how it's linked to your account, and how to turn off telemetry.
---

Apify collects telemetry data about the general usage of the CLI to help us improve the product. Participation in this program is optional and you may opt out if you prefer not to share any information.
Apify CLI collects usage data to help improve the product. Telemetry is on by default, but you can opt out at any time.

## Data Collection
## Collected data

All telemetry data is collected and stored securely on [Mixpanel](https://mixpanel.com/). We do not collect any sensitive information such as your API token or personal information.
The CLI sends your usage data to [Segment](https://segment.com/). This information includes:

### Metrics Collected
- The command and flag names.
- The command's exit code and duration.
- Attributes of your local environment, such as OS, install method, runtime version, and CLI version.
- Whether the command ran in CI, in an interactive terminal, or under an AI coding agent.
- For commands that run or deploy an Actor from its directory, the Actor's language and runtime version.
- For `apify create`, the template details such as its ID, name, and language.
- For `apify login`, the login method.

Before a user connects to the Apify platform, we collect anonymous information about CLI usage including:
The CLI never sends your API token, the contents of your files, or the inputs you pass to commands.

- Usage of all commands
- Internal attributes of the local environment (OS, shell, Node.js version, Python version, Apify CLI version)
- For the `actor create` command, we identify which template was used to create the Actor (language, template name, template ID)
Before you log in, events are tied only to a random ID stored on your machine. After you log in, they also include your Apify user ID. For details on how Apify handles personal data, see the [Apify Privacy Policy](https://apify.com/privacy-policy).

After a user connects to the Apify platform (successful `apify login`), we collect the same information about CLI usage along with the ID of the connected user. You can read more about how we protect personal information in our [Privacy Policy](https://apify.com/privacy-policy).
## Turn off telemetry

## How to opt out
To turn off telemetry, run:

You can disable telemetry by setting the "APIFY_CLI_DISABLE_TELEMETRY" environment variable to "1". After setting this variable, the CLI will not send any telemetry data whether you are connected with Apify or not.
```bash
apify telemetry disable
```

Alternatively, set the `APIFY_CLI_DISABLE_TELEMETRY` environment variable to `1`.
5 changes: 5 additions & 0 deletions website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,11 @@ module.exports = [
},
],
},
{
type: 'doc',
id: 'telemetry',
label: 'Telemetry',
},
{
type: 'doc',
id: 'troubleshooting',
Expand Down
32 changes: 20 additions & 12 deletions website/versioned_docs/version-1.11/telemetry.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,32 @@
---
sidebar_label: Telemetry
title: Telemetry
description: Learn what usage data Apify CLI collects, how it's linked to your account, and how to turn off telemetry.
---

Apify collects telemetry data about the general usage of the CLI to help us improve the product. Participation in this program is optional and you may opt out if you prefer not to share any information.
Apify CLI collects usage data to help improve the product. Telemetry is on by default, but you can opt out at any time.

## Data Collection
## Collected data

All telemetry data is collected and stored securely on [Mixpanel](https://mixpanel.com/). We do not collect any sensitive information such as your API token or personal information.
The CLI sends your usage data to [Segment](https://segment.com/). This information includes:

### Metrics Collected
- The command and flag names.
- The command's exit code and duration.
- Attributes of your local environment, such as OS, install method, runtime version, and CLI version.
- Whether the command ran in CI, in an interactive terminal, or under an AI coding agent.
- For commands that run or deploy an Actor from its directory, the Actor's language and runtime version.
- For `apify create`, the template details such as its ID, name, and language.
- For `apify login`, the login method.

Before a user connects to the Apify platform, we collect anonymous information about CLI usage including:
The CLI never sends your API token, the contents of your files, or the inputs you pass to commands.

- Usage of all commands
- Internal attributes of the local environment (OS, shell, Node.js version, Python version, Apify CLI version)
- For the `actor create` command, we identify which template was used to create the Actor (language, template name, template ID)
Before you log in, events are tied only to a random ID stored on your machine. After you log in, they also include your Apify user ID. For details on how Apify handles personal data, see the [Apify Privacy Policy](https://apify.com/privacy-policy).

After a user connects to the Apify platform (successful `apify login`), we collect the same information about CLI usage along with the ID of the connected user. You can read more about how we protect personal information in our [Privacy Policy](https://apify.com/privacy-policy).
## Turn off telemetry

## How to opt out
To turn off telemetry, run:

You can disable telemetry by setting the "APIFY_CLI_DISABLE_TELEMETRY" environment variable to "1". After setting this variable, the CLI will not send any telemetry data whether you are connected with Apify or not.
```bash
apify telemetry disable
```

Alternatively, set the `APIFY_CLI_DISABLE_TELEMETRY` environment variable to `1`.
5 changes: 5 additions & 0 deletions website/versioned_sidebars/version-1.11-sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,11 @@
"label": "Integrating Scrapy"
}
]
},
{
"type": "doc",
"id": "telemetry",
"label": "Telemetry"
},
{
"type": "doc",
Expand Down
Loading