Skip to main content

OpenTelemetry urllib instrumentation

Project description

pypi

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:

from opentelemetry.instrumentation.urllib import URLLibInstrumentor

# `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


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_urllib-0.49b1.tar.gz.

File metadata

File hashes

Hashes for opentelemetry_instrumentation_urllib-0.49b1.tar.gz
Algorithm Hash digest
SHA256 8cba9b9da5071ef4e305a43b12d482dd11d6c9a9807242cfafce31b1aed0d4e8
MD5 94c8cf0074031bd707e36ec2536ad61a
BLAKE2b-256 efd2eaa8af472d27f443409a24327f3f26dbe36bb1a13c2a56c9e6beffecafb0

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for opentelemetry_instrumentation_urllib-0.49b1-py3-none-any.whl
Algorithm Hash digest
SHA256 0baf74dc2ca613d6d78751f303cc0855580fca166082610e57eed3dc374ca8fb
MD5 907ee9e56b111a0891fa2e06e3cd9170
BLAKE2b-256 40956af520bb8488550675a123c6225d8443d138ecdf2c9ffe6a67742d271f87

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