Instrumentation documentation for users

[trask]

For each instrumentation, document what it captures, including span names and span attributes.

Also document any configuration options.

One option for doc structure: README.md files inside each instrumentation module, with a central "table of contents" that has links into all of the individual README.md files

[ashutosh887]

I would like to work on this @trask Please assign

[trask]

hi @ashutosh887! sure, I'd suggest picking one or two specific instrumentations and send documentation PR(s) for those to start with

[breedx-splk]

This is so massive....does it make sense to keep around? We really really want this as well, but it's a major undertaking at this point, more like a project than a feature/enhancement. Curious if there's a better way of tracking this or burning it down....maybe similar to the groovy->java issue?

[mateuszrzeszutek]

We kinda have parts of it already -- e.g. this page has a table listing instrumentations and the semconvs they implement. And there also are some READMEs with instrumentation specific configs. I think first we could discuss if this is enough; or if we want something more detailed (personally I like linking to the semconv, instead of going into individual attributes). And we could also move it over to the main opentelemetry.io page.

[trask]

And we could also move it over to the main opentelemetry.io page.

👍 I opened https://github.com/open-telemetry/opentelemetry.io/issues/3040