open-telemetry / semantic-conventions

Defines standards for generating consistent, accessible telemetry across a variety of domains
Apache License 2.0
282 stars 175 forks source link

Render attribute name together with requirement level notes #1587

Closed joaopgrassi closed 4 days ago

joaopgrassi commented 4 days ago

Split from #1583

In the requirement level notes, we do not render the attribute name it refers too, making it hard to read the notes without having to go back and forth to the attributes table.

For example, in the HTTP spans semconv we have:

[6]: If and only if it's different than http.request.method.

We should have instead:

[6] http.request.method_original: If and only if it's different than http.request.method.