OpenTelemetry urllib3 instrumentation
Project description
This library allows tracing HTTP requests made by the urllib3 library.
Installation
pip install opentelemetry-instrumentation-urllib3
Configuration
Request/Response hooks
The urllib3 instrumentation supports extending tracing behavior with the help of request and response hooks. These are functions that are called back by the instrumentation right after a Span is created for a request and right before the span is finished processing a response respectively. The hooks can be configured as follows:
# `request` is an instance of urllib3.connectionpool.HTTPConnectionPool
def request_hook(span, request):
pass
# `request` is an instance of urllib3.connectionpool.HTTPConnectionPool
# `response` is an instance of urllib3.response.HTTPResponse
def response_hook(span, request, response):
pass
URLLib3Instrumentor().instrument(
request_hook=request_hook, response_hook=response_hook
)
Exclude lists
To exclude certain URLs from being tracked, set the environment variable OTEL_PYTHON_URLLIB3_EXCLUDED_URLS (or OTEL_PYTHON_EXCLUDED_URLS as fallback) with comma delimited regexes representing which URLs to exclude.
For example,
export OTEL_PYTHON_URLLIB3_EXCLUDED_URLS="client/.*/info,healthcheck"
will exclude requests such as https://site/client/123/info and https://site/xyz/healthcheck.
References
Project details
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
Hashes for opentelemetry_instrumentation_urllib3-0.40b0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 10b633781e7466cde6e3042d3642a22131867aceadd1a0e10912e08718cfa7ca |
|
MD5 | 7ee068f483d3499d3ef437e2b71aec4f |
|
BLAKE2b-256 | 4d1b96968886149cc98c9214ccd18c7c9aee91bb3c40872f8e97ba021190b46b |
Hashes for opentelemetry_instrumentation_urllib3-0.40b0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5e71ea80ede64083a02f92febf5b4cbf83405e29c2ed71ffa9c102cd4c1ca4d3 |
|
MD5 | 21f68365a471da5626e040dc2b74b34d |
|
BLAKE2b-256 | c93f8c6a09f87807364344197742fbb58033294d6a5c562699166b27611e4554 |