Developer Guide#

This guide covers development setup, the plugin’s technical design, and maintainer information.

Development environment#

Note

The development environment setup is currently only available for users of unix-like operating systems (e.g. macOS or Linux)

To set up your development environment, first clone the repository:

git clone git@github.com:anaconda/conda-anaconda-telemetry.git

From the root of the project directory, run the develop.sh script by sourcing it:

source develop.sh

This script performs the following:

  • Creates a new conda environment while installing needed dependencies

  • Activates this environment

  • Installs an editable version of the plugin

  • Modifies CONDA_EXE to point at the locally installed conda

After it finishes running, you will have a development environment setup that you can start using.

Technical design#

The Conda Anaconda Telemetry plugin functions by attaching additional telemetry data to HTTP request headers submitted to Anaconda channel servers. This is done by relying on the conda plugin for request headers.

The entire plugin consists of just a single hooks.py module and currently submits up to five headers per request. To respect size limits (typically 8KB), each header has been given a character limit, with anaconda-telemetry-packages getting the highest limit because it is inherently larger than the other headers. When a header’s data is larger than its limit, the data is truncated and submitted as partial data.

Below is a table showing the current headers, along with their size limits:

Header

Size (in bytes)

anaconda-telemetry-virtual-packages

500

anaconda-telemetry-channels

500

anaconda-telemetry-packages

5,000

anaconda-telemetry-search

500

anaconda-telemetry-install

500

anaconda-telemetry-sys-info

500

Maintainer information#

Conda Anaconda Telemetry (conda-anaconda-telemetry) uses increasing MAJOR.MINOR.PATCH version numbers for final releases, such as 0.3.1, following PEP 440. Release tags contain the version number without a v prefix. The package version is derived from Git tags by hatch-vcs, as configured in pyproject.toml.

For vulnerability reporting and the coordinated disclosure policy, see Anaconda’s security.txt.

On this page