OpenTelemetry-Python¶
The Python OpenTelemetry client.
This documentation describes the opentelemetry-api, opentelemetry-sdk, and several integration packages.
Please note that this library is currently in _beta_, and shouldn’t generally be used in production environments.
Installation¶
The API and SDK packages are available on PyPI, and can installed via pip:
pip install opentelemetry-api
pip install opentelemetry-sdk
In addition, there are several extension packages which can be installed separately as:
pip install opentelemetry-exporter-{exporter}
pip install opentelemetry-instrumentation-{instrumentation}
These are for exporter and instrumentation packages respectively. The packages can be found in instrumentation and exporter directory of the repository.
Extensions¶
Visit OpenTelemetry Registry to find related projects like exporters, instrumentation libraries, tracer implementations, etc.
Installing Cutting Edge Packages¶
While the project is pre-1.0, there may be significant functionality that has not yet been released to PyPI. In that situation, you may want to install the packages directly from the repo. This can be done by cloning the repository and doing an editable install:
git clone https://github.com/open-telemetry/opentelemetry-python.git
cd opentelemetry-python
pip install -e ./opentelemetry-api
pip install -e ./opentelemetry-sdk
pip install -e ./instrumentation/opentelemetry-instrumentation-{instrumentation}
- OpenTelemetry aiohttp client Instrumentation
- OpenTelemetry aiopg Instrumentation
- OpenTelemetry ASGI Instrumentation
- Opentelemetry asyncpg Instrumentation
- OpenTelemetry Boto Instrumentation
- OpenTelemetry Botocore Instrumentation
- OpenTelemetry Celery Instrumentation
- OpenTelemetry Database API Instrumentation
- OpenTelemetry Django Instrumentation
- OpenTelemetry FastAPI Instrumentation
- OpenTelemetry Flask Instrumentation
- OpenTelemetry gRPC Instrumentation
- OpenTelemetry Python Instrumentor
- opentelemetry.instrumentation.instrumentor package
- OpenTelemetry Jinja2 Instrumentation
- opentelemetry.instrumentation.metric package
- OpenTelemetry MySQL Instrumentation
- OpenTracing Shim for OpenTelemetry
- OpenTelemetry Psycopg Instrumentation
- OpenTelemetry pymemcache Instrumentation
- OpenTelemetry pymongo Instrumentation
- OpenTelemetry PyMySQL Instrumentation
- OpenTelemetry Pyramid Instrumentation
- OpenTelemetry Redis Instrumentation
- OpenTelemetry requests Instrumentation
- OpenTelemetry SQLAlchemy Instrumentation
- OpenTelemetry SQLite3 Instrumentation
- OpenTelemetry Starlette Instrumentation
- OpenTelemetry System Metrics Instrumentation
- OpenTelemetry WSGI Instrumentation
- Autoinstrumentation
- Basic Context
- Basic Meter
- Basic Trace
- Datadog Exporter Example
- OpenTelemetry Django Instrumentation Example
- Global Error Handler
- Error Handler 0
- Error Handler 1
- OpenTelemetry Collector Metrics OpenCensus Exporter Example
- OpenTelemetry Collector Tracer OpenCensus Exporter Example
- OpenTelemetry Example Application
- OpenTracing Shim Example