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.40b0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | dd454abf95d57bf9bb1e3bb34aca853951fcef2ddcfe2f0efaec64645d847a63 |
|
MD5 | 79766716f5e80efa894f3565ffffecbb |
|
BLAKE2b-256 | 1390f262f098d2e740c697b3f42844eb789436f03f3fa914c8399bf45750e9ee |
Hashes for opentelemetry_instrumentation_urllib-0.40b0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2834b02f727ed2ab9fc027e70e85412a9905d0c2bf5c7c920fa6ab03ea45cfeb |
|
MD5 | f928928efb74bf333ec705b01b91f743 |
|
BLAKE2b-256 | d11f80fdf8dbdc9b1cdf210aabb0a111f947383edfdc1be42d01d7ecaa7a2a4c |