Don't use placeholder values for the controller and action in the http.route example#2717
Don't use placeholder values for the controller and action in the http.route example#2717lmolkova wants to merge 1 commit intoopen-telemetry:mainfrom
Conversation
|
Suggestion for
request: request: |
|
@RassK HTTP conventions don't define any semantics for HTTP route - the value is coming from the HTTP frameworks. Do you think there a better way to describe it than semantic-conventions/model/http/registry.yaml Lines 172 to 178 in b321d3a ? Given it's stable, we won't be able to standardize the format. |
Kielek
left a comment
There was a problem hiding this comment.
Thank you!
IMO it will reduce friction related to the recommendation what should be real outcome for http.route and the span name.
Yes, I see no direct conventions. I'm interpreting it like that: There is a spec for http server span name, and if the
This could be seen constraining SuggestionsSome help from chatgpt:
Rules:
Examples:
|
|
In the case of a route template like Some additional detail might leave less room for interpretation. Here is an attempt:
Along with a footnote defining static vs dynamic and examples for common frameworks like @RassK commented:
|
|
@matt-hensley @RassK makes sense, would you be willing to send a PR? I can close this one. |
|
closing in favor of #2734 |
Fixes #2616
Using
{controller}/{action}/...in http.route examples turns out to be confusing - according to #2616 it creates the impression that it should be used verbatim, while the intention is to report the route information available from HTTP server framework which usually contains full-text controller/actions.The #2616 suggests to fix span name description, but I still struggle to understand what's missing there - it just tells to use HTTP route:
semantic-conventions/docs/http/http-spans.md
Lines 74 to 80 in b321d3a