---

Getting Started   •   API Documentation   •   Getting In Touch (GitHub Discussions)

Contributing   •   Instrumentations

---

OpenTelemetry Python Contrib

The Python auto-instrumentation libraries for OpenTelemetry (per OTEP 0001)

Index

• Installation
• Releasing
  • Releasing a package as 1.0 stable
• Semantic Convention status of instrumentations
• Contributing
• Thanks to all the people who already contributed

Installation

This repository includes installable packages for each instrumented library. Libraries that produce telemetry data should only depend on opentelemetry-api, and defer the choice of the SDK to the application developer. Applications may depend on opentelemetry-sdk or another package that implements the API.

Please note that these libraries are currently in beta, and shouldn't generally be used in production environments.

Unless explicitly stated otherwise, any instrumentation here for a particular library is not developed or maintained by the authors of such library.

The instrumentation/ directory includes OpenTelemetry instrumentation packages, which can be installed separately as:

pip install opentelemetry-instrumentation-{integration}

To install the development versions of these packages instead, clone or fork this repo and do an editable install:

pip install -e ./instrumentation/opentelemetry-instrumentation-{integration}

Releasing

Maintainers release new versions of the packages in opentelemetry-python-contrib on a monthly cadence. See releases for all previous releases.

Contributions that enhance OTel for Python are welcome to be hosted upstream for the benefit of group collaboration. Maintainers will look for things like good documentation, good unit tests, and in general their own confidence when deciding to release a package with the stability guarantees that are implied with a 1.0 release.

To resolve this, members of the community are encouraged to commit to becoming a CODEOWNER for packages in -contrib that they feel experienced enough to maintain. CODEOWNERS can then follow the checklist below to release -contrib packages as 1.0 stable:

Releasing a package as 1.0 stable

To release a package as 1.0 stable, the package:

• SHOULD have a CODEOWNER. To become one, submit an issue and explain why you meet the responsibilities found in CODEOWNERS.
• MUST have unit tests that cover all supported versions of the instrumented library.
  • e.g. Instrumentation packages might use different techniques to instrument different major versions of python packages
• MUST have clear documentation for non-obvious usages of the package
  • e.g. If an instrumentation package uses flags, a token as context, or parameters that are not typical of the BaseInstrumentor class, these are documented
• After the release of 1.0, a CODEOWNER may no longer feel like they have the bandwidth to meet the responsibilities of maintaining the package. That's not a problem at all, life happens! However, if that is the case, we ask that the CODEOWNER please raise an issue indicating that they would like to be removed as a CODEOWNER so that they don't get pinged on future PRs. Ultimately, we hope to use that issue to find a new CODEOWNER.

Semantic Convention status of instrumentations

In our efforts to maintain optimal user experience and prevent breaking changes for transitioning into stable semantic conventions, OpenTelemetry Python is adopting the semantic convention migration plan for several instrumentations. Currently this plan is only being adopted for HTTP-related instrumentations, but will eventually cover all types. Please refer to the semconv status column of the instrumentation README of the current status of instrumentations' semantic conventions. The possible values are development, stable and migration referring to status of that particular semantic convention. Migration refers to an instrumentation that currently supports the migration plan.

Contributing

See CONTRIBUTING.md

We meet weekly on Thursday at 9AM PT. The meeting is subject to change depending on contributors' availability. Check the OpenTelemetry community calendar for specific dates and for the Zoom link.

Meeting notes are available as a public Google doc.

The meeting is open for all to join. We invite everyone to join our meeting, regardless of your experience level. Whether you're a seasoned OpenTelemetry developer, just starting your journey, or simply curious about the work we do, you're more than welcome to participate!

Maintainers

• Aaron Abbott, Google
• Emídio Neto, Independent
• Leighton Chen, Microsoft
• Lukas Hering, Oracle
• Riccardo Magliocchetti, Elastic

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

Approvers

• Diego Hurtado, Dash0
• Dylan Russell, Google
• Héctor Hernández, Microsoft
• Liudmila Molkova, Google
• Mike Goldsmith, Honeycomb
• Pablo Collins, Splunk
• Srikanth Chekuri, signoz.io
• Tammy Baylis, SolarWinds

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

Emeritus

• Alex Boten, Maintainer
• Ashutosh Goel, Approver
• Jeremy Voss, Approver
• Keith Decker, Approver
• Nathaniel Ruiz Nowell, Approver
• Nikolay Sokolik, Approver
• Nikolay Sokolik, Approver
• Owais Lone, Maintainer
• Owais Lone, Approver
• Sanket Mehta, Approver
• Shalev Roda, Maintainer
• Shalev Roda, Approver
• Yusuke Tsutsumi, Maintainer

For more information about the emeritus role, see the community repository.

Thanks to all of our contributors!