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

Doc holes in FastAPI instrumentation #3301

Open
xd009642 opened this issue Feb 26, 2025 · 2 comments
Open

Doc holes in FastAPI instrumentation #3301

xd009642 opened this issue Feb 26, 2025 · 2 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@xd009642
Copy link

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)
@xrmx xrmx added good first issue Good for newcomers documentation Improvements or additions to documentation labels Feb 28, 2025
@xrmx
Copy link
Contributor

xrmx commented Feb 28, 2025

  1. there should probably be an entry in the menu since opentelemetry-instrument is a contrib package

@ADITYADAS1999
Copy link

Hi @xrmx, is this issue still available to work on? If so, I’d be happy to contribute.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants