OpenTelemetry urllib3 Instrumentation

This library allows tracing HTTP requests made by the urllib3 library.

Usage

import urllib3
from opentelemetry.instrumentation.urllib3 import URLLib3Instrumentor

def strip_query_params(url: str) -> str:
    return url.split("?")[0]

URLLib3Instrumentor().instrument(
    # Remove all query params from the URL attribute on the span.
    url_filter=strip_query_params,
)

http = urllib3.PoolManager()
response = http.request("GET", "https://www.example.org/")

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:

def request_hook(
    span: Span,
    pool: urllib3.connectionpool.HTTPConnectionPool,
    request_info: RequestInfo,
) -> Any:
    ...

def response_hook(
    span: Span,
    pool: urllib3.connectionpool.HTTPConnectionPool,
    response: urllib3.response.HTTPResponse,
) -> Any:
    ...

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.

API

class opentelemetry.instrumentation.urllib3.RequestInfo(method, url, headers, body)[source]

Bases: object

Arguments that were passed to the urlopen() call.

method: str

url: str

headers: Optional[Mapping[str, str]]

body: Union[bytes, IO[Any], Iterable[bytes], str, None]

class opentelemetry.instrumentation.urllib3.URLLib3Instrumentor(*args, **kwargs)[source]

Bases: BaseInstrumentor

instrumentation_dependencies()[source]

Return a list of python packages with versions that the will be instrumented.

The format should be the same as used in requirements.txt or pyproject.toml.

For example, if an instrumentation instruments requests 1.x, this method should look like: :rtype: Collection[str]

def instrumentation_dependencies(self) -> Collection[str]:
return [‘requests ~= 1.0’]

This will ensure that the instrumentation will only be used when the specified library is present in the environment.