Python

A language-specific implementation of OpenTelemetry in Python.

This is the OpenTelemetry Python documentation. OpenTelemetry is an observability framework – an API, SDK, and tools that are designed to aid in the generation and collection of application telemetry data such as metrics, logs, and traces. This documentation is designed to help you understand how to get started using OpenTelemetry Python.

Status and Releases

The current status of the major functional components for OpenTelemetry Python is as follows:

For releases, including the latest release, see Releases.

Version support

OpenTelemetry-Python supports Python 3.6 and higher.

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 Jaeger, Zipkin, Prometheus, OTLP and OpenCensus Exporters can be found in the exporter directory of the repository. Instrumentations and additional exporters can be found in the Contrib repo instrumentation and Contrib repo exporter directories.

Extensions

To find related projects like exporters, instrumentation libraries, tracer implementations, etc., visit the Registry.

Installing Cutting-edge Packages

There is some 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

Learn more

• [API reference][]
  • Traces API, Traces SDK
  • Metrics API, Metrics SDK
  • Logs API
• Examples
• Contrib repository
• Performance benchmarks