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

Contributing   •   Examples

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

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.

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.

Contributing

See CONTRIBUTING.md

We meet weekly on Thursday, and the time of the meeting alternates between 9AM PT and 4PM 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. For edit access, get in touch on GitHub Discussions.

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

• Aaron Abbott, Google
• Sanket Mehta, Cisco
• Shalev Roda, Cisco

Emeritus Approvers:

• Hector Hernandez, Microsoft
• Yusuke Tsutsumi, Google
• Nathaniel Ruiz Nowell, AWS
• Ashutosh Goel, Cisco

Find more about the approver role in community repository.

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

• Diego Hurtado, Lightstep
• Leighton Chen, Microsoft
• Srikanth Chekuri, signoz.io

Emeritus Maintainers:

• Alex Boten, Lightstep
• Owais Lone, Splunk

Find more about the maintainer role in community repository.

Running Tests Locally

1. Go to your Contrib repo directory. cd ~/git/opentelemetry-python-contrib.
2. Create a virtual env in your Contrib repo directory. python3 -m venv my_test_venv.
3. Activate your virtual env. source my_test_venv/bin/activate.
4. Make sure you have tox installed. pip install tox==3.27.1.
5. Run tests for a package. (e.g. tox -e test-instrumentation-flask.)

Thanks to all the people who already contributed!