Document FastAPI instrumentation setup#4555
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
|
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. |
|
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
|
Done! |
Co-authored-by: Tammy Baylis <96076570+tammy-baylis-swi@users.noreply.github.com>
| @@ -0,0 +1 @@ | |||
| `opentelemetry-instrumentation-fastapi`, `opentelemetry-instrumentation`: update docs | |||
There was a problem hiding this comment.
You need to be a bit more specific here
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.