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.42b0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1510605a07154caf9bdb428a1ac9d7c0e63d4e384700f48b459f9c9fc5156b13 |
|
MD5 | 149425015f6f1a023e161220fb411e86 |
|
BLAKE2b-256 | 57d303d5d5e15b9073c8aab54ea9850eb7721b0f510a84ecc1dfcf3197467b15 |
Hashes for opentelemetry_instrumentation_urllib-0.42b0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fc1946e2dd1f856b37021c8692e1caca190f3dac6cdcac503d883f1d05f669e3 |
|
MD5 | 5a8f778ac232853015c01885795d53f0 |
|
BLAKE2b-256 | e919377beeac331d829a217b97d74d2863b3c496d62b089b049aa2e9274cc45c |