opensource/opentelemetry-python-contrib
1
0
Fork 0
mirror of https://github.com/open-telemetry/opentelemetry-python-contrib.git synced 2025-07-28 20:52:57 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add documentation for request/response hooks for requests instrumentor (#2704)

Browse Source
This commit is contained in:
Artur Smęt
2024-07-15 19:24:16 +02:00
committed by GitHub
parent 7567efa341
commit 7c7a2a4312
1 changed files with 24 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
instrumentation/opentelemetry-instrumentation-requests/src/opentelemetry/instrumentation/requests/__init__.py
View File

@ -31,6 +31,30 @@ Usage
Configuration Configuration
------------- -------------
Request/Response hooks
**********************
The requests 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:
.. code:: python
# `request_obj` is an instance of requests.PreparedRequest
def request_hook(span, request_obj):
pass
# `request_obj` is an instance of requests.PreparedRequest
# `response` is an instance of requests.Response
def response_hook(span, request_obj, response)
pass
RequestsInstrumentor().instrument(
request_hook=request_hook, response_hook=response_hook)
)
Exclude lists Exclude lists
************* *************
To exclude certain URLs from being tracked, set the environment variable ``OTEL_PYTHON_REQUESTS_EXCLUDED_URLS`` To exclude certain URLs from being tracked, set the environment variable ``OTEL_PYTHON_REQUESTS_EXCLUDED_URLS``