Update ASGI instrumentation docs (#1090)

open-telemetry · Sep 10, 2020 · 65ddc2d · 65ddc2d
1 parent 272bc0e
commit 65ddc2d
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 6 deletions.
diff --git a/docs/instrumentation/asgi/asgi.rst b/docs/instrumentation/asgi/asgi.rst
@@ -1,8 +1,7 @@
-OpenTelemetry asgi Instrumentation
-===================================
+.. include:: ../../../instrumentation/opentelemetry-instrumentation-asgi/README.rst
 
-Module contents
----------------
+API
+---
 
 .. automodule:: opentelemetry.instrumentation.asgi
     :members:

diff --git a/instrumentation/opentelemetry-instrumentation-asgi/README.rst b/instrumentation/opentelemetry-instrumentation-asgi/README.rst
@@ -1,5 +1,5 @@
-OpenTelemetry ASGI Middleware
-=============================
+OpenTelemetry ASGI Instrumentation
+==================================
 
 |pypi|
 
@@ -54,6 +54,17 @@ Modify the application's ``asgi.py`` file as shown below.
     application = OpenTelemetryMiddleware(application)
 
 
+Usage (Raw ASGI)
+----------------
+
+.. code-block:: python
+
+    from opentelemetry.instrumentation.asgi import OpenTelemetryMiddleware
+
+    app = ...  # An ASGI application.
+    app = OpenTelemetryMiddleware(app)
+
+
 References
 ----------