This release is a pre-release and may not be stable for production use.
OpenTelemetry Instrumentation
Installation
pip install opentelemetry-instrumentation
This package provides commands that help automatically instrument a program:
opentelemetry-bootstrap
opentelemetry-bootstrap [-a |--action=][install|requirements]
This command install default instrumentation packages and detects active Python site-packages
to figure out which instrumentation packages the user might want to install. By default, it
prints out a list of the default and detected instrumentation packages that can be added to a
requirements.txt file. It also supports installing the packages when run with
--action=install or -a install flag. All default and detectable
instrumentation packages are defined here.
opentelemetry-instrument
opentelemetry-instrument python program.py
The instrument command will try to automatically detect packages used by your python program and when possible, apply automatic tracing instrumentation on them. This means your program will get automatic distributed tracing without having to make any code changes. This will also configure a global tracer and tracing exporter as well as a meter and meter exporter. By default, the instrument command will use the OTLP exporter but this can be overridden.
The command supports the following configuration options as CLI arguments and environment variables:
--traces_exporter or OTEL_TRACES_EXPORTER
--metrics_exporter or OTEL_METRICS_EXPORTER
--distro or OTEL_PYTHON_DISTRO
--configurator or OTEL_PYTHON_CONFIGURATOR
The exporter options define what exporter destination to use and can be set to one or more exporter names (see below). You can pass multiple values to configure multiple exporters (e.g., zipkin_json,otlp).
Defaults to otlp.
Can be set to none to disable automatic tracer initialization.
Can be set to console to display JSON results locally.
Trace exporter names:
jaeger_proto
jaeger_thrift
opencensus
otlp
otlp_proto_grpc (deprecated)
otlp_proto_http (deprecated)
zipkin_json
zipkin_proto
Metric exporter names:
otlp
otlp_proto_grpc (deprecated)
prometheus
Note: The default transport protocol for otlp is gRPC.
--id-generator or OTEL_PYTHON_ID_GENERATOR
Used to specify which IDs Generator to use for the global Tracer Provider. By default, it will use the random IDs generator.
The code in program.py needs to use one of the packages for which there is an OpenTelemetry integration. For a list of the available integrations please check here
OTEL_PYTHON_DISABLED_INSTRUMENTATIONS
If set by the user, opentelemetry-instrument will read this environment variable to disable specific instrumentations. e.g OTEL_PYTHON_DISABLED_INSTRUMENTATIONS=”requests,django”
If the variables contains * as member no instrumentation will be enabled.
OTEL_PYTHON_AUTO_INSTRUMENTATION_EXPERIMENTAL_GEVENT_PATCH
If set by the user to patch_all , opentelemetry instrument will call the gevent monkeypatching method patch_all. This is considered experimental but can be useful to instrument gevent applications. e.g OTEL_PYTHON_AUTO_INSTRUMENTATION_EXPERIMENTAL_GEVENT_PATCH=patch_all
Examples
opentelemetry-instrument --traces_exporter console flask run --port=3000
The above command will pass --traces_exporter console to the instrument command and --port=3000 to flask run.
opentelemetry-instrument --traces_exporter zipkin_json,otlp celery -A tasks worker --loglevel=info
The above command will configure global trace provider, attach zipkin and otlp exporters to it and then start celery with the rest of the arguments.
opentelemetry-instrument --id_generator random flask run --port=3000
The above command will configure the global trace provider to use the Random IDs Generator, and then pass --port=3000 to flask run.
Programmatic Auto-instrumentation
from opentelemetry.instrumentation import auto_instrumentation auto_instrumentation.initialize()
If you are in an environment where you cannot use opentelemetry-instrument to inject auto-instrumentation you can do so programmatically with the code above. Please note that some instrumentations may require the initialize() method to be called before the library they instrument is imported.
References
Release files for opentelemetry-instrumentation 0.66b0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| opentelemetry_instrumentation-0.66b0.tar.gz | 43.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| opentelemetry_instrumentation-0.66b0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 80.2 kB
Release files / opentelemetry_instrumentation-0.66b0.tar.gz
| Download URL | opentelemetry_instrumentation-0.66b0.tar.gz |
|---|---|
| Size | 43.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
316715ed7b33a12530c0ae3e8d4cdf26d70e1aad358d7ba256e5dea2d4ceed71
|
|
BLAKE2b-256 checksum How to use checksums |
d197e6959310cff3dbbce24ca0a60e5e12f773320d17480c779b038b55defd35
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.10.21
|
Release files / opentelemetry_instrumentation-0.66b0-py3-none-any.whl
| Download URL | opentelemetry_instrumentation-0.66b0-py3-none-any.whl |
|---|---|
| Size | 36.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0b32e2fcfec1e4bd48511a3b77ce32bfb1c16dcd5479396b21f9086a4b06c0c9
|
|
BLAKE2b-256 checksum How to use checksums |
4b08bf39ca469f178963715ff6fd7012eec0b438f472703b11a64a40cbb14f6f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.10.21
|
