open-telemetry / Opentelemetry Python Contrib

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

Contributing   •   Examples

OpenTelemetry Python Contrib

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}

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.

Meetings take place via Zoom video conference. The passcode is 77777.

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
• Diego Hurtado
• Hector Hernandez, Microsoft
• Owais Lone, Splunk
• Yusuke Tsutsumi, Google

Find more about the approver role in community repository.

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

• Alex Boten, Lightstep
• Leighton Chen, Microsoft

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. Clone the OpenTelemetry Python Python Core repo to a folder named opentelemetry-python-core. git clone [email protected]:open-telemetry/opentelemetry-python.git opentelemetry-python-core.
5. Change directory to the repo that was just cloned. cd opentelemetry-python-core.
6. Move the head of this repo to the hash you want your tests to use. This is currently the SHA 47483865854c7adae7455f8441dab7f814f4ce2a as seen in .github/workflows/test.yml. Use git fetch && git checkout 47483865854c7adae7455f8441dab7f814f4ce2a.
7. Go back to the root directory. cd ../.
8. Make sure you have tox installed. pip install tox.
9. Run tests for a package. (e.g. tox -e test-instrumentation-flask.)

Thanks to all the people who already contributed!