Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Hola! π
Motivation
I was working through adding the ASGI
opentelemetry-python
instrumentation toawesome-asgi
(see florimondmanca/awesome-asgi#47), and it popped out to me that the docs page for this instrumentation was a bit sub-par compared to what we have for most other instrumentations. That is, there's currently only an API reference, without usage examples.Turns out we do have usage examples in the
opentelemetry-instrumentation-asgi
README, soβ¦Description of changes
I took the same approach than the Starlette instrumentation docs and updated the ASGI docs to:
README.rst
.I also:
Fixes # (issue)
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Built the docs locally and here's what the page now looks like:
Checklist: