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.43b0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 501ca05a0ad4486344e22141a1f72d881ecd7154ffac9cb5981e164d7ad80f20 |
|
MD5 | 47b6d783b150ed02bbc7a8ab19458a5d |
|
BLAKE2b-256 | f6309422ba785c2c3a3770276c9107b31328c349617851d743920e940a6128bf |
Hashes for opentelemetry_instrumentation_urllib-0.43b0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 140653a2b733ef3b63975e19727fba3a4f02baff8331f2ca2145c05c271af44a |
|
MD5 | 27fc4fcf5173dd45360ec3b8240163ef |
|
BLAKE2b-256 | 298ac184945b2628ed44b9357e0df84dfc0974efd4e1360b3d89d2180ebfb3c0 |