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.46b0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | cd7c5dc8c9ca367d1966b456438e76636d61b93cc62d98d89aa16ff8620b2fe9 |
|
MD5 | e94c84e2d29bfeddf6a52e6ea5061b7d |
|
BLAKE2b-256 | 0e58e57af79bb036eb80f80bfc5b9f5bcb066d4b1f9f4735b921947ddb27ebd6 |
Hashes for opentelemetry_instrumentation_urllib-0.46b0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 90d39daf1abb8a5513d3043ea74d019a7483302e73ffaca10cf954b2aec5372f |
|
MD5 | 438d270632fd96775736c30127f90d68 |
|
BLAKE2b-256 | aefac24635ad5bb1796845ebd2e8e5d80382913c4045d92349383414d3c923c2 |