Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/open-telemetry/opentelemetry-python

OpenTelemetry Python API and SDK
https://github.com/open-telemetry/opentelemetry-python

correlationcontext distributed-tracing logging metrics opentelemetry python sdk tracecontext

Last synced: about 2 months ago
JSON representation

OpenTelemetry Python API and SDK

Host: GitHub
URL: https://github.com/open-telemetry/opentelemetry-python
Owner: open-telemetry
License: apache-2.0
Created: 2019-05-07T21:13:30.000Z (over 5 years ago)
Default Branch: main
Last Pushed: 2024-05-15T22:19:04.000Z (4 months ago)
Last Synced: 2024-05-16T03:02:57.021Z (4 months ago)
Topics: correlationcontext, distributed-tracing, logging, metrics, opentelemetry, python, sdk, tracecontext
Language: Python
Homepage: https://opentelemetry.io
Size: 11.3 MB
Stars: 1,619
Watchers: 40
Forks: 559
Open Issues: 320
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

awesomeLibrary - opentelemetry-python - OpenTelemetry Python API and SDK (语言资源库 / python)
awesome-github-repos - open-telemetry/opentelemetry-python - OpenTelemetry Python API and SDK (Python)
best-of-web-python - GitHub - 19% open · ⏱️ 05.06.2024): (Monitoring)
awesome-starts - open-telemetry/opentelemetry-python - OpenTelemetry Python API and SDK (Python)

README

        # OpenTelemetry Python

[![Slack](https://img.shields.io/badge/slack-@cncf/otel/python-brightgreen.svg?logo=slack)](https://cloud-native.slack.com/archives/C01PD4HUVBL)

[![Build Status](https://github.com/open-telemetry/opentelemetry-python/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/open-telemetry/opentelemetry-python/actions)

[![Minimum Python Version](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)

[![Release](https://img.shields.io/github/v/release/open-telemetry/opentelemetry-python?include_prereleases&style=)](https://github.com/open-telemetry/opentelemetry-python/releases/)

[![Read the Docs](https://readthedocs.org/projects/opentelemetry-python/badge/?version=latest)](https://opentelemetry-python.readthedocs.io/en/latest/)

## Project Status

See the [OpenTelemetry Instrumentation for Python](https://opentelemetry.io/docs/instrumentation/python/#status-and-releases).

| Signal  | Status       | Project |

| ------- | ------------ | ------- |

| Traces  | Stable       | N/A     |

| Metrics | Stable       | N/A     |

| Logs    | Experimental | N/A     |

Project versioning information and stability guarantees can be found [here](./rationale.md#versioning-and-releasing).

## Getting started

You can find the getting started guide for OpenTelemetry Python [here](https://opentelemetry.io/docs/instrumentation/python/getting-started/).

If you are looking for **examples** on how to use the OpenTelemetry API to

instrument your code manually, or how to set up the OpenTelemetry

Python SDK, see https://opentelemetry.io/docs/instrumentation/python/manual/.

## Python Version Support

This project ensures compatibility with the current supported versions of the Python. As new Python versions are released, support for them is added and

as 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 their [end of life](https://devguide.python.org/devcycle/#end-of-life-branches).

## Documentation

The online documentation is available at https://opentelemetry-python.readthedocs.io/.

To access the latest version of the documentation, see

https://opentelemetry-python.readthedocs.io/en/latest/.

## Install

This repository includes multiple installable packages. The `opentelemetry-api`

package includes abstract classes and no-op implementations that comprise the OpenTelemetry API following the

[OpenTelemetry specification](https://github.com/open-telemetry/opentelemetry-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 the Python Package Index (PyPI). You can install them via `pip` with the following commands:

```sh

pip install opentelemetry-api

pip install opentelemetry-sdk

```

The

[`exporter/`](https://github.com/open-telemetry/opentelemetry-python/tree/main/exporter)

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

```sh

pip install opentelemetry-exporter-{exporter}

```

The

[`propagator/`](https://github.com/open-telemetry/opentelemetry-python/tree/main/propagator)

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

```sh

pip install opentelemetry-propagator-{propagator}

```

To install the development versions of these packages instead, clone or fork

this repository and perform an [editable

install](https://pip.pypa.io/en/stable/reference/pip_install/#editable-installs):

```sh

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

```

For additional exporter and instrumentation packages, see the 

[`opentelemetry-python-contrib`](https://github.com/open-telemetry/opentelemetry-python-contrib) repository.

## Contributing

For information about contributing to OpenTelemetry Python, see [CONTRIBUTING.md](CONTRIBUTING.md).

We meet weekly on Thursdays at 9AM PST. The meeting is subject to change depending on contributors' availability. Check the [OpenTelemetry community calendar](https://calendar.google.com/calendar/embed?src=google.com_b79e3e90j7bbsa2n2p5an5lf60%40group.calendar.google.com) for specific dates and Zoom meeting links.

Meeting notes are available as a public [Google doc](https://docs.google.com/document/d/1CIMGoIOZ-c3-igzbd6_Pnxx1SjAkjwqoYSUWxPY8XIs/edit).

Approvers ([@open-telemetry/python-approvers](https://github.com/orgs/open-telemetry/teams/python-approvers)):

- [Aaron Abbott](https://github.com/aabmass), Google

- [Emídio Neto](https://github.com/emdneto), Zenvia

- [Jeremy Voss](https://github.com/jeremydvoss), Microsoft

- [Owais Lone](https://github.com/owais), Splunk

- [Pablo Collins](https://github.com/pmcollins), Splunk

- [Riccardo Magliocchetti](https://github.com/xrmx), Elastic

- [Shalev Roda](https://github.com/shalevr), Cisco

- [Srikanth Chekuri](https://github.com/srikanthccv), signoz.io

- [Tammy Baylis](https://github.com/tammy-baylis-swi), SolarWinds

Emeritus Approvers

- [Ashutosh Goel](https://github.com/ashu658), Cisco

- [Carlos Alberto Cortez](https://github.com/carlosalberto), Lightstep

- [Christian Neumüller](https://github.com/Oberon00), Dynatrace

- [Héctor Hernández](https://github.com/hectorhdzg), Microsoft

- [Mauricio Vásquez](https://github.com/mauriciovasquezbernal), Kinvolk

- [Nathaniel Ruiz Nowell](https://github.com/NathanielRN), AWS

- [Nikolay Sokolik](https://github.com/oxeye-nikolay), Oxeye

- [Sanket Mehta](https://github.com/sanketmehta28), Cisco

- [Tahir H. Butt](https://github.com/majorgreys), DataDog

*For more information about the approver role, see the [community repository](https://github.com/open-telemetry/community/blob/main/community-membership.md#approver).*

Maintainers ([@open-telemetry/python-maintainers](https://github.com/orgs/open-telemetry/teams/python-maintainers)):

- [Diego Hurtado](https://github.com/ocelotl), Lightstep

- [Leighton Chen](https://github.com/lzchen), Microsoft

Emeritus Maintainers:

- [Alex Boten](https://github.com/codeboten), Lightstep

- [Chris Kleinknecht](https://github.com/c24t), Google

- [Owais Lone](https://github.com/owais), Splunk

- [Reiley Yang](https://github.com/reyang), Microsoft

- [Srikanth Chekuri](https://github.com/srikanthccv), signoz.io

- [Yusuke Tsutsumi](https://github.com/toumorokoshi), Google

*For more information about the maintainer role, see the [community repository](https://github.com/open-telemetry/community/blob/main/community-membership.md#maintainer).*

### Thanks to all the people who already contributed!