Skip to content

docs(fastapi): document env vars, trace propagation, websockets, and logging - #4939

Open
rut0607 wants to merge 2 commits into
open-telemetry:mainfrom
rut0607:docs-fastapi-gaps
Open

docs(fastapi): document env vars, trace propagation, websockets, and logging#4939
rut0607 wants to merge 2 commits into
open-telemetry:mainfrom
rut0607:docs-fastapi-gaps

Conversation

@rut0607

@rut0607 rut0607 commented Aug 9, 2026

Copy link
Copy Markdown

Fixes #3301

This PR adds missing documentation to the FastAPI instrumentation page, covering gaps noted from an outside-Python-ecosystem perspective:

  • Clarifies that general SDK env vars (OTEL_EXPORTER_OTLP_ENDPOINT, OTEL_SERVICE_NAME, etc.) are configured separately from FastAPI-specific vars, with a link to the SDK docs
  • Documents that trace context propagation works automatically for incoming requests via the ASGI middleware and configured propagators
  • Confirms and documents WebSocket support (verified against the existing test suite in test_fastapi_instrumentation.py)
  • Documents how to enable log-trace correlation via the separate logging instrumentation package and OTEL_PYTHON_LOG_CORRELATION
  • Adds a direct PyPI link for discoverability

A changelog fragment is included at .changelog/PLACEHOLDER.added (will rename to match the PR number once assigned).

@rut0607
rut0607 requested a review from a team as a code owner August 9, 2026 10:17
@linux-foundation-easycla

linux-foundation-easycla Bot commented Aug 9, 2026

Copy link
Copy Markdown

CLA Signed
The committers listed above are authorized under a signed CLA.

@rut0607
rut0607 force-pushed the docs-fastapi-gaps branch from 44b0b3d to 0e0c122 Compare August 9, 2026 10:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

Doc holes in FastAPI instrumentation

1 participant