OpenTelemetry-Python

The Python OpenTelemetry client.

Gitter Chat

This documentation describes the opentelemetry-api, opentelemetry-sdk, and several integration packages.

Please note that this library is currently in alpha, and shouldn’t be used in production environments.

Installation

The API and SDK packages are available on PyPI, and can installed via pip:

pip install opentelemetry-api
pip install opentelemetry-sdk

In addition, there are several extension packages which can be installed separately as:

pip install opentelemetry-exporter-{exporter}
pip install opentelemetry-instrumentation-{instrumentation}

These are for exporter and instrumentation packages respectively. The packages can be found in instrumentation/ directory of the repository.

Extensions

Visit OpenTelemetry Registry to find related projects like exporters, instrumentation libraries, tracer implementations, etc.

Installing Cutting Edge Packages

While the project is pre-1.0, there may be significant functionality that has not yet been released to PyPI. In that situation, you may want to install the packages directly from the repo. This can be done by cloning the repository and doing an editable install:

git clone https://github.com/open-telemetry/opentelemetry-python.git
cd opentelemetry-python
pip install -e ./opentelemetry-api
pip install -e ./opentelemetry-sdk
pip install -e ./instrumentation/opentelemetry-instrumentation-{instrumentation}

OpenTelemetry Instrumentations

Indices and tables