open-telemetry / open-telemetry/opentelemetry-python-contrib

Doc holes in FastAPI instrumentation

Open
#3,301 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation good first issue
Dominant language
Python
Stars
1.1k
Forks
1.1k
Avg merge
4d 15h
Merged PRs (30d)
16

Description

Mentioning FastAPI specifically as that's what I'm using but I wouldn't be surprised if it held true for the others. So coming to add opentelemetry instrumentation as someone primarily not using python but using other language ecosystems I don't want to rely on assumptions on what's provided as not every language is equally fleshed out in opentelemetry IME.

So in these docs https://opentelemetry-python-contrib.readthedocs.io/en/latest/instrumentation/fastapi/fastapi.html#usage the missing information for me is:

  1. What environment variables can set things up? Do I have ones like OTEL_EXPORTER_OTLP_ENDPOINT OTEL_EXPORTER_OLTP_PROTOCOL OTEL_SERVICE_NAME or does this have to be setup separately
  2. Does trace propagation work or do I need manual intervention
  3. If it does work does it also work for websocket requests?
  4. How do I integrate logs so they show up as events
  5. There should be a link to the opentelemetry-instrumentation package I had to search pypi for it because it's not a very google friendly name (a lot of things related to general python, languages I use more often and opentelemetry in general)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the FastAPI instrumentation page at instrumentation/fastapi/fastapi.html and review the five missing topics listed in the issue. Check the repository's existing documentation and package references for environment variables, propagation, WebSocket requests, log events, and the opentelemetry-instrumentation package. Done means the page addresses each question and links to the package.

Written by the indexing model from the issue text.

Assessment

Tech stack
fastapi, python
Domain
backend, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.