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.44b0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2fb0967c1ad50eb8962fcd9b830fe7f6ee3ef43da80294f2d39e304e0a8e6a77 |
|
MD5 | 5a9e12a9c646cfe7e20f02d3022f18d8 |
|
BLAKE2b-256 | 7fb90e0be26d4153167b567532c016676d2368686a2cccc9482a68d67375177d |
Hashes for opentelemetry_instrumentation_urllib3-0.44b0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bbe3da11556afdd550c603e79bb9e3d05de1d4148c077d0d8bd688a2a3274ce2 |
|
MD5 | 3b8f7bee669422bad9392a6aac7d0bf2 |
|
BLAKE2b-256 | dd0d38e19049254f1f4fde647ee724825661faa3f06c8121f3c410a6c1cb570a |