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.45b0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7e6654423615c0099ab436e9f1f54900a6675da568492e04f1f26169f59bceda |
|
MD5 | 42b2aa39c102fd0863ae23025a89b106 |
|
BLAKE2b-256 | 4f7a20f69cf9222c42021e3d219ee47e65884488f8259f8577080f963b796048 |
Hashes for opentelemetry_instrumentation_urllib3-0.45b0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9d4b2d046723479fa6a9e7eda43003abb152bc3546b0845be58ae13c54e6f71d |
|
MD5 | cf44af2f07aa14fe51fec535ef3876a9 |
|
BLAKE2b-256 | 123fd7f6b0f3c2a0e13bcf4d92fce8d654915344a5455106c55c346e5fbbd159 |