Alibaba Cloud CLI telemetry data collection

Updated at:
Copy as MD

Alibaba Cloud CLI enables telemetry by default in v3.5.3 and later. You can check, disable, or re-enable telemetry. CLI commands continue to work with telemetry disabled.

Collection scope

Alibaba Cloud uses telemetry data to improve CLI stability, usability, and performance. For the full list of collected fields and details about local data, see Alibaba Cloud CLI telemetry data collection.

Data that telemetry can collect

  • The command name, whether the command succeeded, and how long it ran.

  • The CLI runtime environment, authentication methods, and plugin usage.

  • A randomly generated installation ID.

Data excluded from telemetry

  • Command output, such as a list of resources returned by a query.

  • Credential values from the Alibaba Cloud CLI credential configuration.

  • Cloud service API request and response bodies.

Manage telemetry

Check telemetry status

Run the following command in the terminal or CI/CD job you want to check.

aliyun configure telemetry show

Telemetry is enabled when enabled is true and environment_disabled is false.

Disable telemetry

Disable telemetry for the current user. Run the following command. The CLI saves the setting locally and applies it to all profiles in the current user's configuration directory.

aliyun configure telemetry disable

Disable telemetry for the current terminal session or CI/CD job. Set ALIBABA_CLOUD_CLI_TELEMETRY_DISABLE to 1 in that environment before running the CLI. This disables telemetry for CLI processes that inherit the variable, even if the local setting enables it.

macOS or Linux (Bash, Zsh)

export ALIBABA_CLOUD_CLI_TELEMETRY_DISABLE=1

Windows PowerShell

$env:ALIBABA_CLOUD_CLI_TELEMETRY_DISABLE = "1"

Re-enable telemetry

If you disabled telemetry with the environment variable, remove it where you set it. In a terminal session, run the command for your shell. In CI/CD, remove the variable from the job configuration.

macOS or Linux (Bash, Zsh)

unset ALIBABA_CLOUD_CLI_TELEMETRY_DISABLE

Windows PowerShell

Remove-Item Env:ALIBABA_CLOUD_CLI_TELEMETRY_DISABLE -ErrorAction SilentlyContinue

If you also disabled the local setting, run the following command.

aliyun configure telemetry enable