Instrumentation Tools & Auto Instrumentation for OpenTelemetry Python
Project description
Installation
pip install opentelemetry-instrumentation
This package provides a couple of commands that help automatically instruments a program:
opentelemetry-bootstrap
opentelemetry-bootstrap --action=install|requirements
This commands inspects the active Python site-packages and figures out which
instrumentation packages the user might want to install. By default it prints out
a list of the suggested instrumentation packages which can be added to a requirements.txt
file. It also supports installing the suggested packages when run with --action=install
flag.
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 for free without having to make any code changes at all. This will also configure a global tracer and tracing exporter without you having to make any code changes. By default, the instrument command will use the OTLP exporter but this can be overridden when needed.
The command supports the following configuration options as CLI arguments and environment vars:
--traces_exporter or OTEL_TRACES_EXPORTER
--metrics_exporter or OTEL_METRICS_EXPORTER
--distro or OTEL_PYTHON_DISTRO
--configurator or OTEL_PYTHON_CONFIGURATOR
Used to specify which trace exporter to use. Can be set to one or more of the well-known exporter names (see below).
Defaults to otlp.
Can be set to none to disable automatic tracer initialization.
You can pass multiple values to configure multiple exporters e.g, zipkin,prometheus
Well known trace exporter names:
jaeger_proto
jaeger_thrift
opencensus
zipkin_json
zipkin_proto
otlp
otlp_proto_grpc (deprecated)
otlp_proto_http (deprecated)
Note: The default transport protocol for otlp is gRPC. HTTP is currently supported for traces only, and should be set using OTEL_EXPORTER_OTLP_TRACES_PROTOCOL=http/protobuf
--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”
Examples
opentelemetry-instrument --traces_exporter otlp flask run --port=3000
The above command will pass --traces_exporter otlp 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.
References
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file opentelemetry_instrumentation-0.43b0.tar.gz.
File metadata
- Download URL: opentelemetry_instrumentation-0.43b0.tar.gz
- Upload date:
- Size: 23.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.7.17
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c3755da6c4be8033be0216d0501e11f4832690f4e2eca5a3576fbf113498f0f6 |
|
| MD5 | 9586f53aae9cd857095329c71c18e70e |
|
| BLAKE2b-256 | 8b1b127aa95eeea81ee725b87dc34b65b9af1cf6e9e6bc06c3ecb0e5487b9a51 |
File details
Details for the file opentelemetry_instrumentation-0.43b0-py3-none-any.whl.
File metadata
- Download URL: opentelemetry_instrumentation-0.43b0-py3-none-any.whl
- Upload date:
- Size: 28.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.7.17
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 0ff1334d7e359e27640e9d420024efeb73eacae464309c2e14ede7ba6c93967e |
|
| MD5 | 6155b9b6f0120612706a38871b7c9a7f |
|
| BLAKE2b-256 | 91f04a9f7cbcc697273d847040a9e4f98ceb07b642e1fe5fed56a0fb6b567665 |
