opentelemetry-python-contrib icon indicating copy to clipboard operation
opentelemetry-python-contrib copied to clipboard

Doc holes in FastAPI instrumentation

Open xd009642 opened this issue 8 months ago • 2 comments
trafficstars

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)

xd009642 avatar Feb 26 '25 14:02 xd009642

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

xrmx avatar Feb 28 '25 15:02 xrmx

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

ADITYADAS1999 avatar Mar 03 '25 07:03 ADITYADAS1999