Skip to main content

OpenTelemetry urllib3 instrumentation

Project description

pypi

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


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

File details

Details for the file opentelemetry_instrumentation_urllib3-0.49b1.tar.gz.

File metadata

File hashes

Hashes for opentelemetry_instrumentation_urllib3-0.49b1.tar.gz
Algorithm Hash digest
SHA256 bdf43b010ee1f2ff4a1db3a31ea4eaff74012f987e2f9ad1ffdbf83888d3a8d7
MD5 c049be36891a506376b00a0f1d5c03ea
BLAKE2b-256 a0c9d23c0b9b92048e2ec61a7bd939fa4aafabfed8c50d3c53759115ca174c24

See more details on using hashes here.

Provenance

File details

Details for the file opentelemetry_instrumentation_urllib3-0.49b1-py3-none-any.whl.

File metadata

File hashes

Hashes for opentelemetry_instrumentation_urllib3-0.49b1-py3-none-any.whl
Algorithm Hash digest
SHA256 731b79158e21bf1cf8c88fb1b1acba8776ebec9d86a364f72c889fc83aafc12c
MD5 263040fb7c107c3d9cbcf06d8d785ad2
BLAKE2b-256 e4936f5aaa24050c37ec51212e2297df4f55a8113fe92fe0982478dc9add02cb

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page