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.44b0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2fc73065c3d93c6ab369f29440b1870e763c655fc202d52c30e75722ac6f626d |
|
MD5 | a9c513bdcf07969daba37c1fdfdedb78 |
|
BLAKE2b-256 | 47a96ecf9b075b0ef5f47cc05511584ec284a8895d934c275a8c0e36afbef206 |
Hashes for opentelemetry_instrumentation_urllib-0.44b0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0b5ade1ad06dc5486dcea6fa4de120cecc761da551c5eed1af3359ad18374c87 |
|
MD5 | 6d86825be5b25db6f25a8826221dbab1 |
|
BLAKE2b-256 | fbf07a3872d0cd4b5b33745fa1575c37b428d58287ba1621fa3ae96a2145f1a0 |