Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update ASGI instrumentation docs #1090

Merged
merged 1 commit into from
Sep 10, 2020
Merged

Update ASGI instrumentation docs #1090

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions docs/instrumentation/asgi/asgi.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
OpenTelemetry asgi Instrumentation
===================================
.. include:: ../../../instrumentation/opentelemetry-instrumentation-asgi/README.rst

Module contents
---------------
API
---

.. automodule:: opentelemetry.instrumentation.asgi
:members:
Expand Down
15 changes: 13 additions & 2 deletions instrumentation/opentelemetry-instrumentation-asgi/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
OpenTelemetry ASGI Middleware
=============================
OpenTelemetry ASGI Instrumentation
==================================

|pypi|

Expand Down Expand Up @@ -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
----------

Expand Down