anton-ryzhov/opentelemetry-python

OpenTelemetry Python API and SDK

---

Getting Started   •   API Documentation   •   Getting In Touch (Gitter)

Contributing   •   Examples

---

OpenTelemetry Python

The Python OpenTelemetry implementation.

Getting started

OpenTelemetry's goal is to provide a single set of APIs to capture distributed traces and metrics from your application and send them to an observability platform. This project allows you to do just that for applications written in Python.

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

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.

The API and SDK packages are available on PyPI, and can installed via pip:

pip install opentelemetry-api
pip install opentelemetry-sdk

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

pip install opentelemetry-instrumentation-{instrumentation}

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

pip install opentelemetry-exporter-{exporter}

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

pip install -e ./opentelemetry-api
pip install -e ./opentelemetry-sdk
pip install -e ./instrumentation/opentelemetry-instrumentation-{instrumentation}

Documentation

The online documentation is available at https://opentelemetry-python.readthedocs.io/, if you want to access the documentation for the latest version use https://opentelemetry-python.readthedocs.io/en/latest/.

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.

Meetings take place via Zoom video conference.

Meeting notes are available as a public Google doc. For edit access, get in touch on Gitter.

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

• Aaron Abbott, Google
• Carlos Alberto Cortez, Lightstep
• Tahir H. Butt DataDog
• Chris Kleinknecht, Google
• Diego Hurtado
• Hector Hernandez, Microsoft
• Owais Lone, Splunk
• Reiley Yang, Microsoft
• 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.

Thanks to all the people who already contributed!

Project Status

Project boards and milestones can be found at the respective links. We try to keep these accurate and should be the best place to go for answers on project status. The dates and features described in issues and milestones are estimates, and subject to change.