OpenTelemetry urllib3 Instrumentation¶
This library allows tracing HTTP requests made by the urllib3 library.
import urllib3 from opentelemetry.instrumentation.urllib3 import URLLib3Instrumentor def strip_query_params(url: str) -> str: return url.split("?") 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/")
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) )
- class opentelemetry.instrumentation.urllib3.URLLib3Instrumentor(*args, **kwargs)¶
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 setup.py.
For example, if an instrumentation instruments requests 1.x, this method should look like:
- 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.