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.41b0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 113416b8bd9c2d5c890cb6f86737886e209a3776c2ecdc023887bd78634d5ef3 |
|
MD5 | fa8ef6eb9c05c7339ac044b91db8dc70 |
|
BLAKE2b-256 | 89818a5f6377c5c4a4e59292fc0877b2884e67a2caa4842f1aa4391ef9daacc6 |
Hashes for opentelemetry_instrumentation_urllib-0.41b0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cee9e95f55a73480df0915358ce8668bbeda53324c9426847e2ccaea0cac1a87 |
|
MD5 | e7d0baf15baa6814a3ec0f6ef6d34a5a |
|
BLAKE2b-256 | 384b75440f3f779b475d5c95030c44cb562db73333cd7cfb97fd50eb3b9a6791 |