Skip to content

Commit 0b16fe7

Browse files
committed
docs: improved docs a bit more
1 parent 44d2c76 commit 0b16fe7

File tree

2 files changed

+55
-4
lines changed
  • instrumentation/opentelemetry-instrumentation-httpx

2 files changed

+55
-4
lines changed

instrumentation/opentelemetry-instrumentation-httpx/README.rst

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -136,15 +136,29 @@ The hooks can be configured as follows:
136136
# status_code, headers, stream, extensions = response
137137
pass
138138
139-
HTTPXClientInstrumentor().instrument(request_hook=request_hook, response_hook=response_hook)
139+
async def async_request_hook(span, request):
140+
# method, url, headers, stream, extensions = request
141+
pass
142+
143+
async def async_response_hook(span, request, response):
144+
# method, url, headers, stream, extensions = request
145+
# status_code, headers, stream, extensions = response
146+
pass
147+
148+
HTTPXClientInstrumentor().instrument(
149+
request_hook=request_hook,
150+
response_hook=response_hook,
151+
async_request_hook=async_request_hook,
152+
async_response_hook=async_response_hook
153+
)
140154
141155
142156
Or if you are using the transport classes directly:
143157

144158

145159
.. code-block:: python
146160
147-
from opentelemetry.instrumentation.httpx import SyncOpenTelemetryTransport
161+
from opentelemetry.instrumentation.httpx import SyncOpenTelemetryTransport, AsyncOpenTelemetryTransport
148162
149163
def request_hook(span, request):
150164
# method, url, headers, stream, extensions = request
@@ -155,13 +169,29 @@ Or if you are using the transport classes directly:
155169
# status_code, headers, stream, extensions = response
156170
pass
157171
172+
async def async_request_hook(span, request):
173+
# method, url, headers, stream, extensions = request
174+
pass
175+
176+
async def async_response_hook(span, request, response):
177+
# method, url, headers, stream, extensions = request
178+
# status_code, headers, stream, extensions = response
179+
pass
180+
158181
transport = httpx.HTTPTransport()
159182
telemetry_transport = SyncOpenTelemetryTransport(
160183
transport,
161184
request_hook=request_hook,
162185
response_hook=response_hook
163186
)
164187
188+
async_transport = httpx.AsyncHTTPTransport()
189+
telemetry_transport = AsyncOpenTelemetryTransport(
190+
async_transport,
191+
request_hook=async_request_hook,
192+
response_hook=async_response_hook
193+
)
194+
165195
166196
References
167197
----------

instrumentation/opentelemetry-instrumentation-httpx/src/opentelemetry/instrumentation/httpx/__init__.py

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -140,15 +140,20 @@ async def async_response_hook(span, request, response):
140140
# status_code, headers, stream, extensions = response
141141
pass
142142
143-
HTTPXClientInstrumentor().instrument(request_hook=request_hook, response_hook=response_hook, async_request_hook=async_request_hook, async_response_hook=async_response_hook)
143+
HTTPXClientInstrumentor().instrument(
144+
request_hook=request_hook,
145+
response_hook=response_hook,
146+
async_request_hook=async_request_hook,
147+
async_response_hook=async_response_hook
148+
)
144149
145150
146151
Or if you are using the transport classes directly:
147152
148153
149154
.. code-block:: python
150155
151-
from opentelemetry.instrumentation.httpx import SyncOpenTelemetryTransport
156+
from opentelemetry.instrumentation.httpx import SyncOpenTelemetryTransport, AsyncOpenTelemetryTransport
152157
153158
def request_hook(span, request):
154159
# method, url, headers, stream, extensions = request
@@ -159,13 +164,29 @@ def response_hook(span, request, response):
159164
# status_code, headers, stream, extensions = response
160165
pass
161166
167+
async def async_request_hook(span, request):
168+
# method, url, headers, stream, extensions = request
169+
pass
170+
171+
async def async_response_hook(span, request, response):
172+
# method, url, headers, stream, extensions = request
173+
# status_code, headers, stream, extensions = response
174+
pass
175+
162176
transport = httpx.HTTPTransport()
163177
telemetry_transport = SyncOpenTelemetryTransport(
164178
transport,
165179
request_hook=request_hook,
166180
response_hook=response_hook
167181
)
168182
183+
async_transport = httpx.AsyncHTTPTransport()
184+
telemetry_transport = AsyncOpenTelemetryTransport(
185+
async_transport,
186+
request_hook=async_request_hook,
187+
response_hook=async_response_hook
188+
)
189+
169190
API
170191
---
171192
"""

0 commit comments

Comments
 (0)