Reliable documentation on generated telemetry

[medikoo]

e.g. I'm looking at @opentelemetry/instrumentation-http I see instructions on how it can be setup, but I don't see any documentation on the produced outcome.

What are the telemetry properties generated? Where can I find reliable documentation on that? Ideally if there's a helpful note on that in main package readme

[dyladan]

It would probably be a good idea for each instrumentation to provide a summary of the "shape" of the produced telemetry. For now you can look at the semantic conventions in the specifications here for example. Instrumentations are supposed to follow the guidelines there and we do our best to follow that but if our instrumentation is out of date or provides any non-standard attributes they obviously won't show up there.

[sgracias1]

hello, I would like to add this documentation in. Seems like the best way to go would be to add a new section to the README and I am thinking of pulling these values based on whats in the src code unless there is a different reference point?

[siddhikhapare]

@medikoo @dyladan I want to work on this issue. Can you assign me? Do you want small application outcome of observability after setup created using js? I need your help to understand this issue.

[legendecas]

I think documenting them in the package README with a new section should be fine.

[dyladan]

@sgracias1 and @siddhikhapare you are both welcome to work on this but I would suggest you coordinate so you don't duplicate work

[siddhikhapare]

Sure. Thank you.

[siddhikhapare]

I will work on tracing part.