Skip to content

Commit 65ddc2d

Browse files
Update ASGI instrumentation docs (open-telemetry#1090)
1 parent 272bc0e commit 65ddc2d

File tree

2 files changed

+16
-6
lines changed
  • docs/instrumentation/asgi
  • instrumentation/opentelemetry-instrumentation-asgi

2 files changed

+16
-6
lines changed

docs/instrumentation/asgi/asgi.rst

+3-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
OpenTelemetry asgi Instrumentation
2-
===================================
1+
.. include:: ../../../instrumentation/opentelemetry-instrumentation-asgi/README.rst
32

4-
Module contents
5-
---------------
3+
API
4+
---
65

76
.. automodule:: opentelemetry.instrumentation.asgi
87
:members:

instrumentation/opentelemetry-instrumentation-asgi/README.rst

+13-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
OpenTelemetry ASGI Middleware
2-
=============================
1+
OpenTelemetry ASGI Instrumentation
2+
==================================
33

44
|pypi|
55

@@ -54,6 +54,17 @@ Modify the application's ``asgi.py`` file as shown below.
5454
application = OpenTelemetryMiddleware(application)
5555
5656
57+
Usage (Raw ASGI)
58+
----------------
59+
60+
.. code-block:: python
61+
62+
from opentelemetry.instrumentation.asgi import OpenTelemetryMiddleware
63+
64+
app = ... # An ASGI application.
65+
app = OpenTelemetryMiddleware(app)
66+
67+
5768
References
5869
----------
5970

0 commit comments

Comments
 (0)