OpenTelemetry urllib instrumentation
Project description
This library allows tracing HTTP requests made by the urllib library.
Installation
pip install opentelemetry-instrumentation-urllib
Configuration
Request/Response hooks
The urllib 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_obj` is an instance of urllib.request.Request
def request_hook(span, request_obj):
pass
# `request_obj` is an instance of urllib.request.Request
# `response` is an instance of http.client.HTTPResponse
def response_hook(span, request_obj, response)
pass
URLLibInstrumentor.instrument(
request_hook=request_hook, response_hook=response_hook)
)
Exclude lists
To exclude certain URLs from being tracked, set the environment variable OTEL_PYTHON_URLLIB_EXCLUDED_URLS (or OTEL_PYTHON_EXCLUDED_URLS as fallback) with comma delimited regexes representing which URLs to exclude.
For example,
export OTEL_PYTHON_URLLIB_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_urllib-0.47b0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6cb0e0e83bb30007b38054c05f2a4fbf78fc850bc23282de4ed3c9843c7f9793 |
|
MD5 | ff6c610970537229ac81a817a617ae02 |
|
BLAKE2b-256 | 6fc0bb797fde99f7a49dd40244c1aa7503cfe8a2545c8c082ab930e6d9eb3013 |
Hashes for opentelemetry_instrumentation_urllib-0.47b0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a33b9ab0542cca87d2febe63e3628978ebe6d68d05156eebf8538f64843a0cc3 |
|
MD5 | 436ba046dbac8c46b92528d03882f725 |
|
BLAKE2b-256 | bea27cca109c11e26070b64b54e3dbc53725f6736c9e525364720daa2246a819 |