Repository files navigation

See theOpenTelemetry Instrumentation for Python.

Project versioning information and stability guarantees can be foundhere.

You can find the getting started guide for OpenTelemetry Pythonhere.

If you are looking forexamples on how to use the OpenTelemetry API toinstrument your code manually, or how to set up the OpenTelemetryPython SDK, seehttps://opentelemetry.io/docs/instrumentation/python/manual/.

This project ensures compatibility with the current supported versions of the Python. As new Python versions are released, support for them is added andas old Python versions reach their end of life, support for them is removed.

We add support for new Python versions no later than 3 months after they become stable.

We remove support for old Python versions 6 months after they reach theirend of life.

The online documentation is available athttps://opentelemetry-python.readthedocs.io/.To access the latest version of the documentation, seehttps://opentelemetry-python.readthedocs.io/en/latest/.

This repository includes multiple installable packages. Theopentelemetry-apipackage includes abstract classes and no-op implementations that comprise the OpenTelemetry API following theOpenTelemetry specification.Theopentelemetry-sdk package is the reference implementation of the API.

Libraries that produce telemetry data should only depend onopentelemetry-api,and defer the choice of the SDK to the application developer. Applications maydepend onopentelemetry-sdk or another package that implements the API.

The API and SDK packages are available on the Python Package Index (PyPI). You can install them viapip with the following commands:

pip install opentelemetry-apipip install opentelemetry-sdk

Theexporter/directory includes OpenTelemetry exporter packages. You can install the packages separately with the following command:

pip install opentelemetry-exporter-{exporter}

Thepropagator/directory includes OpenTelemetry propagator packages. You can install the packages separately with the following command:

pip install opentelemetry-propagator-{propagator}

To install the development versions of these packages instead, clone or forkthis repository and perform aneditableinstall:

pip install -e ./opentelemetry-api -e ./opentelemetry-sdk -e ./opentelemetry-semantic-conventions

For additional exporter and instrumentation packages, see theopentelemetry-python-contrib repository.

For information about contributing to OpenTelemetry Python, seeCONTRIBUTING.md.

We meet weekly on Thursdays at 9AM PST. The meeting is subject to change depending on contributors' availability. Check theOpenTelemetry community calendar for specific dates and Zoom meeting links.

Meeting notes are available as a publicGoogle doc.

Approvers (@open-telemetry/python-approvers):

• Emídio Neto, PicPay
• Jeremy Voss, Microsoft
• Owais Lone, Splunk
• Pablo Collins, Splunk
• Shalev Roda, Cisco
• Srikanth Chekuri, signoz.io
• Tammy Baylis, SolarWinds

Emeritus Approvers

• Ashutosh Goel, Cisco
• Carlos Alberto Cortez, Lightstep
• Christian Neumüller, Dynatrace
• Héctor Hernández, Microsoft
• Mauricio Vásquez, Kinvolk
• Nathaniel Ruiz Nowell, AWS
• Nikolay Sokolik, Oxeye
• Sanket Mehta, Cisco
• Tahir H. Butt, DataDog

For more information about the approver role, see thecommunity repository.

Maintainers (@open-telemetry/python-maintainers):

• Aaron Abbott, Google
• Diego Hurtado, Lightstep
• Leighton Chen, Microsoft
• Riccardo Magliocchetti, Elastic

Emeritus Maintainers:

• Alex Boten, Lightstep
• Chris Kleinknecht, Google
• Owais Lone, Splunk
• Reiley Yang, Microsoft
• Srikanth Chekuri, signoz.io
• Yusuke Tsutsumi, Google

For more information about the maintainer role, see thecommunity repository.