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.48b0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a9db839b4248efc9b01628dc8aa886c1269a81cec84bc375d344239037823d48 |
|
MD5 | 0d737632093903e449ea48e1a0aedce3 |
|
BLAKE2b-256 | 054f9887c18154de0ffabf4b7e0de923e3a6ea93f407a5dd245cb7202a495613 |
Hashes for opentelemetry_instrumentation_urllib-0.48b0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8115399fc786f5a46f30b158ab32a9cc77a248d421dcb0d411da657250388915 |
|
MD5 | ad34d0f2ece306f526354d282a096607 |
|
BLAKE2b-256 | da6b94774f730522cff6a18e7fe7b3fc48e3152c2b21f5bd94999231625340a1 |