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.43b0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 406c4077ff9b4f97112117f96950b2726ff68666711b1eadcf9ed3724c4adfbe |
|
MD5 | ee19675139d8bad6b18c86d221eb2166 |
|
BLAKE2b-256 | 2918d50fccbabae4d78cdd399a03502763c9627f4ed9d42276a4c214fdb02c64 |
Hashes for opentelemetry_instrumentation_urllib3-0.43b0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7fe2e51d7287bb93737b0b7df9f8d5c96c8a1b186adf538e776b3bb84c4a1ff9 |
|
MD5 | 1eff62b2db8dfc87516a695ce0112781 |
|
BLAKE2b-256 | a0543e6fc502e06d6c4cba23f314426951225f950b1af3c2e6decb780cd64ff1 |