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.

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

Update ASGI instrumentation docs #1090

Conversation

florimondmanca
Copy link
Contributor

@florimondmanca florimondmanca commented Sep 10, 2020

Description

Hola! πŸ‘‹

Motivation

I was working through adding the ASGI opentelemetry-python instrumentation to awesome-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:

  • Include the ASGI instrumentation README.rst.
  • List the existing API reference below.

I also:

  • Added a "raw ASGI" usage example at the bottom of the page.
  • Updated the page title to match the "XYZ Instrumentation" model for other pages.

Fixes # (issue)

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Built the docs locally and here's what the page now looks like:

asgi

Checklist:

  • Followed the style guidelines of this project
  • Changelogs have been updated
  • Unit tests have been added
  • Documentation has been updated

@florimondmanca florimondmanca requested a review from a team as a code owner September 10, 2020 11:22
@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Sep 10, 2020

CLA Check
The committers are authorized under a signed CLA.

Copy link
Contributor

@codeboten codeboten left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the contribution!

@codeboten codeboten merged commit 65ddc2d into open-telemetry:master Sep 10, 2020
@florimondmanca florimondmanca deleted the fm/opentelemetry-asgi-docs-revamp branch September 10, 2020 19:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants