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.45b0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3effe2f1e10f77f5532a7f7f73f0719e5e5bf7e6c5e8557643f26f6749a82dc1 |
|
MD5 | 0fa18dcdde61527bff10eeb681532a9d |
|
BLAKE2b-256 | 19c36025b7e2763be625ab22d9caf3fe2eb299633cbf3b62b3fd99115c69c5d2 |
Hashes for opentelemetry_instrumentation_urllib-0.45b0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 92b0843a2c087c6ab81d4ad37f2432884a7f9ec91bd21a77858805944ed13fbd |
|
MD5 | a54c3dc2d7265cccaef45ba5a593778e |
|
BLAKE2b-256 | d6dbd0b6cc3dfda12c715b92b501237bbaba41771c1fa3414e67c27749ce146a |