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.48b0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6b03d6ee9b6e001cc73bb07ccf71bc42886eb006885ff6d53b5b00751bb01326 |
|
MD5 | b642b0e1c25dde2aeb5b748a471cb163 |
|
BLAKE2b-256 | a395aff5c7533096c8809b6d073fbbca6cbde057ce898355424c2d77c61fc456 |
Hashes for opentelemetry_instrumentation_urllib3-0.48b0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3ba2b874d798996a105fcb887491ecf78c1c47dc39516c8544680b2e32fc8d18 |
|
MD5 | 3dfd974f1b51a5cddd799c639bee0f52 |
|
BLAKE2b-256 | 2e36ca3c9f077a3e682de59f9178a87c4580d051b01172cb5b4c3052de8f590e |