OpenTelemetry urllib3 instrumentation
Project description
This library allows tracing HTTP requests made by the urllib3 library.
Installation
pip install opentelemetry-instrumentation-urllib3
Configuration
Request/Response hooks
The urllib3 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` is an instance of urllib3.connectionpool.HTTPConnectionPool
def request_hook(span, request):
pass
# `request` is an instance of urllib3.connectionpool.HTTPConnectionPool
# `response` is an instance of urllib3.response.HTTPResponse
def response_hook(span, request, response):
pass
URLLib3Instrumentor().instrument(
request_hook=request_hook, response_hook=response_hook
)
Exclude lists
To exclude certain URLs from being tracked, set the environment variable OTEL_PYTHON_URLLIB3_EXCLUDED_URLS (or OTEL_PYTHON_EXCLUDED_URLS as fallback) with comma delimited regexes representing which URLs to exclude.
For example,
export OTEL_PYTHON_URLLIB3_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_urllib3-0.47b0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8aa3342cea629dab6fde59303501ff826df5f12b3e29fdcb73ddee0a809f7fec |
|
MD5 | 7e87dd8bf0744351133383f21e07e828 |
|
BLAKE2b-256 | 6b29dbbfe9d1d1803c20738832606e304327da5d1fd08447c0d5581dbb57cb4a |
Hashes for opentelemetry_instrumentation_urllib3-0.47b0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6218b8383aa7e5c7ded56ceb7c64f1a12eefe6a4c2bf5e957c67b1bfaed621f7 |
|
MD5 | 5c0de8d02a575ca41692e5a9d3898420 |
|
BLAKE2b-256 | 8260cd70dc08c6ca5f5bbfa12724a3b1b5b8e451fd0caae9e7061c1463b88472 |