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.41b0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 65c539fcb1691b7558796f333a9e862028a56baa79e8e5fdbd244de65c6f8f3d |
|
MD5 | 9c4b375e79cae4abae21e84f0609a1d4 |
|
BLAKE2b-256 | 54587f1b739793fe5786f639fc75e5f4e808f44fd55da3775ea5cc09131837f8 |
Hashes for opentelemetry_instrumentation_urllib3-0.41b0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 812771728183654b7c0b8b9672cb3d8946e533afd2e45beefdf8981e47ecba0e |
|
MD5 | 7b56c72289a5753ee0a6398ec9b8b516 |
|
BLAKE2b-256 | 0679cc992db8db78a1d9962ee8766915fe64eb4a2a913d7967dc058d4f8cbf0d |