Document FastAPI instrumentation setup#4555
Open
Harshal96 wants to merge 5 commits into
Open
Conversation
Clarify FastAPI auto-instrumentation configuration, propagation, WebSocket behavior, and log export. Also surface the opentelemetry-instrumentation README in the generated docs menu. Assisted-by: OpenAI Codex
Contributor
|
Thank you @Harshal96 ! Please could you update this reference as per
Also could you please add a changelog entry, since it's more than a few lines. |
Member
|
Thanks for the PR! Just a heads-up: we no longer update Please add the appropriate changelog fragment for this change instead of editing |
Assisted-by: OpenAI Codex
Author
|
Done! |
Co-authored-by: Tammy Baylis <96076570+tammy-baylis-swi@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
Clarifies the FastAPI instrumentation docs for auto-instrumentation environment configuration, trace propagation, WebSocket behavior, and log export. Also renders the
opentelemetry-instrumentationREADME in the generated docs so theopentelemetry-instrumentpackage has a clearer docs menu entry.Fixes #3301
Type of change
How Has This Been Tested?
python3 -m py_compile instrumentation/opentelemetry-instrumentation-fastapi/src/opentelemetry/instrumentation/fastapi/__init__.pyuv run --no-project --with docutils --with pygments python3 -c "...FastAPI docstring RST parsed..."uv run --no-project --with docutils python3 -c "...opentelemetry-instrumentation README RST parsed..."uv run --no-project --with ruff ruff check instrumentation/opentelemetry-instrumentation-fastapi/src/opentelemetry/instrumentation/fastapi/__init__.pygit diff --checkFull docs build was attempted with
uv run sphinx-build -W --keep-going -b html docs docs/_build/html, but this local machine could not complete the workspace sync because the unrelatedmysqlclient==2.2.8build requirespkg-config/MySQL client build flags.Does This PR Require a Core Repo Change?
Checklist:
See contributing.md for styleguide, changelog guidelines, and more.