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.39b0.tar.gz.

File metadata

File hashes

Hashes for opentelemetry_instrumentation_urllib3-0.39b0.tar.gz
Algorithm Hash digest
SHA256 52e8d0899fc98b055e676fd7b7fc9400fff3d1900045db516c98d0dbf7e63692
MD5 e253223932f1a84b74fbf31817666325
BLAKE2b-256 64b5d089147cbe567c7a18f88470779fac7899a7a83ec70ae99806559d574a1b

See more details on using hashes here.

File details

Details for the file opentelemetry_instrumentation_urllib3-0.39b0-py3-none-any.whl.

File metadata

File hashes

Hashes for opentelemetry_instrumentation_urllib3-0.39b0-py3-none-any.whl
Algorithm Hash digest
SHA256 b562cf8011d8c053c5b455119ff1989729c6067f63b8020c648aabba5bdd6c0a
MD5 23b518558b2f2b599b6e549410ba5934
BLAKE2b-256 8dfba30221807bc73f05422ee4d69608af7a97c25c25d4d1cce5eb68731e365a

See more details on using hashes here.

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