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.39b0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bff880147a1e7b9fddb752ff99d5acd6506335595a33bd656b8b8d35b3b7781f |
|
MD5 | 4b7b780f8226253e7136c2dd8fdef652 |
|
BLAKE2b-256 | fa18f28fa0f0327e403b53c7a56f8081748be1ba2912e3b1bdce9714d6128a07 |
Hashes for opentelemetry_instrumentation_urllib-0.39b0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8473adcadd49f26d3bfa83a3b7c66c132af7e17f1fd3a88b6e84abc8dc641e6e |
|
MD5 | 68857d8755dbb12e8509819a18f1c219 |
|
BLAKE2b-256 | 85d3b8dc846015f8e2548a162e4a4cd79312856f72177254cfc4885b731aaa60 |