FAQ#
What happens when I enable conda-anaconda-telemetry?#
When the conda-anaconda-telemetry plugin is installed in the conda base environment and enabled,
the plugin will collect additional information about how conda is being used. This is then submitted
to the channel servers that are currently configured via HTTP request headers or OpenTelemetry (OTel).
This allows channel owners to gain additional insights about how their channels are being used.
What data is tracked by this plugin?#
We currently collect the following information when this plugin is installed:
Installed virtual packages (e.g.,
glibcversion or your current architecture specifications, such asm1)Installed packages in the active environment (e.g. the output of
conda list)Configured channels (e.g.
defaultsorconda-forge)System information (e.g.
conda-buildversion or the command currently being run)When
conda searchis run, we track the packages that are being searched forWhen
conda installorconda createis run, we track the packages that are being installed that are specified at the command line (e.g. for the commandconda install package-a package-b,package-aandpackage-bwill be tracked)Usage tokens provided by
anaconda-anon-usage(e.g. a client token and a per-session token). For the exact fields that are exported - see below.
Which commands are you tracking?#
We only track commands that make network requests. This includes the following:
conda searchconda installconda updateconda createconda removeconda notices
When are telemetry headers attached?#
Telemetry headers (the anaconda-telemetry-* headers) are only added to HTTP
requests that match a small whitelist of hosts and paths. The plugin attaches
headers for requests to:
repo.anaconda.comandrepo.anaconda.cloud(any path), andconda.anaconda.org/<channel>/...for the channels:anaconda,conda-forge,main,msys2, andr.
Examples:
Requests to
https://repo.anaconda.com/pkgs/main/...will include telemetry headers.Requests to
https://conda.anaconda.org/conda-forge/...will include telemetry headers.
This behavior is implemented in conda_anaconda_telemetry/hooks.py via a
compiled regular expression named REQUEST_HEADER_PATTERN which performs the
matching. Limiting submission to these hosts avoids adding telemetry headers to
unrelated third-party hosts.
Telemetry data via OpenTelemetry#
There is an existing parallel approach handling data which relies on OpenTelemetry (OTel). OpenTelemetry is an open-source framework designed to standardize how telemetry data is handled. The OTel-based approach is gated behind the same setting as the headers.
The OTel based approach will replace the header-based approach in the future.
Data handled via OTel are sent to Anaconda’s servers.
Signal version#
The signal version is 1. It is sent as event.schema_version, which the plugin sets. It is separate from schema.version, which the SDK sets.
Events#
install.pnfe: Sent whenconda installfails because a requested package is not in the configured channels. It is not sent when telemetry is disabled, when the plugin has no record of the request, or when a package name cannot be read (for example, a URL spec).create.pnfe: Sent whenconda createfails because a requested package is not in the configured channels. It is not sent when telemetry is disabled, when the plugin has no record of the request, or when a package name cannot be read (for example, a URL spec).install.success: Sent whenconda installsucceeds. It is not sent when telemetry is disabled, for dry runs, for download-only runs, or when the plugin has no record of the request or the result.create.success: Sent whenconda createsucceeds. It is not sent when telemetry is disabled, for dry runs, for download-only runs, or when the plugin has no record of the request or the result.
Resource attributes#
Name |
Description |
Owner |
Presence |
|---|---|---|---|
|
Identifier of the Anaconda account, taken from the sign-in of anaconda-auth. It is not the API key. |
sdk |
optional: The user is signed in through anaconda-auth. |
|
Token that identifies this client installation. It persists between runs. |
sdk |
optional: The |
|
Token that identifies the conda environment. It persists between runs. |
sdk |
optional: The |
|
Tokens that identify the installer used to install conda. They persist between runs. |
sdk |
optional: The |
|
Tokens that identify the machine. They persist between runs. |
sdk |
optional: The |
|
Tokens that identify the organization. They persist between runs. |
sdk |
optional: The |
|
Token for the current run. It changes with each run. |
sdk |
optional: The |
|
Version of the |
sdk |
optional: The |
|
Version of the Anaconda OpenTelemetry SDK that sends the signal. |
sdk |
always |
|
Whether conda detected a CI environment, derived from the |
plugin |
always |
|
Version of conda that sends the signal. |
plugin |
always |
|
Label of the deployment. It comes from the |
plugin |
always |
|
Name of the installer that installed conda. |
plugin |
optional: The installer metadata file (.installer.info) in the base environment exists and is valid. |
|
Platform of the installer that installed conda. |
plugin |
optional: The installer metadata file (.installer.info) in the base environment exists and is valid. |
|
Version of the installer that installed conda. |
plugin |
optional: The installer metadata file (.installer.info) in the base environment exists and is valid. |
|
Type of the operating system. |
sdk |
always |
|
Version of the operating system. |
sdk |
always |
|
Extra attributes that the SDK groups into one attribute. |
sdk |
always |
|
Name of the product platform that sends the signal (conda). |
plugin |
always |
|
Version of Python that runs conda. |
sdk |
always |
|
Version of the SDK telemetry schema. It is not the same as |
sdk |
always |
|
ID of this instance of the sending service. The OpenTelemetry SDK sets it. |
sdk |
optional: The installed |
|
Name of the sending service (conda-anaconda-telemetry). |
plugin |
always |
|
Version of the conda-anaconda-telemetry plugin. |
plugin |
always |
|
Programming language of the OpenTelemetry SDK. |
sdk |
always |
|
Name of the OpenTelemetry SDK. |
sdk |
always |
|
Version of the OpenTelemetry SDK. |
sdk |
always |
Anaconda token classes#
persistent: Persistent tokens stay the same between runs. Attributes:aau.client.token,aau.environment.token,aau.installer.tokens,aau.machine.tokens,aau.organization.tokens.per-run: Per-run tokens change with each run. Attributes:aau.session.token.account-linked: Account-linked tokens are tied to an Anaconda account. Attributes:aau.anaconda_auth.token.
Log attributes: pnfe outcome#
Events: install.pnfe, create.pnfe.
Name |
Description |
Owner |
Presence |
|---|---|---|---|
|
The conda command that ran. |
plugin |
always |
|
Version of this signal format. It is not the same as |
plugin |
always |
|
Names of the packages that were not found. Only package names are sent, with no versions or URLs. |
plugin |
always |
|
Name of the error that conda raised. |
plugin |
always |
|
The channel priority setting of conda. |
plugin |
always |
|
Channels used for the request. Only |
plugin |
always |
|
Name of the event. |
sdk |
always |
|
Names of the packages that the user requested. Only package names are sent, with no versions or URLs. |
plugin |
always |
|
Whether the plugin shortened a list to keep the signal small. |
plugin |
always |
Log attributes: success outcome#
Events: install.success, create.success.
Name |
Description |
Owner |
Presence |
|---|---|---|---|
|
The conda command that ran. |
plugin |
always |
|
Version of this signal format. It is not the same as |
plugin |
always |
|
The channel priority setting of conda. |
plugin |
always |
|
Channels used for the request. Only |
plugin |
always |
|
Name of the event. |
sdk |
always |
|
Names of the packages that the user requested. Only package names are sent, with no versions or URLs. |
plugin |
always |
|
Packages that the solver chose to install. |
plugin |
always |
|
Whether the plugin shortened a list to keep the signal small. |
plugin |
always |