Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Show relationship between http target and route in example usage #3292

Merged
merged 4 commits into from
Mar 8, 2023

Conversation

JamieDanielson
Copy link
Member

Changes

Clarify relationship between http.target and http.route by using the same pattern in the example usage. Having different patterns for the attribute values distorts the relationship between the two attributes.

A similar pattern is seen in the docs for aws-lambda.md, where http.target is /pets/10 and http.route is /pets/{petId}. It's a minor adjustment but should help provide clarity for new users.

Copy link
Member

@trask trask left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thx!

can you make this change also to

examples: ['/path/12314/?q=ddds']

and then the build should pass (the markdown tables are autogenerated, see https://github.com/open-telemetry/opentelemetry-specification/blob/main/semantic_conventions/README.md#generating-markdown)

@trask trask added area:semantic-conventions Related to semantic conventions semconv:HTTP labels Mar 6, 2023
@jmacd jmacd merged commit b9081ae into open-telemetry:main Mar 8, 2023
@JamieDanielson JamieDanielson deleted the jamie.http-route-spec branch March 8, 2023 17:23
lmolkova pushed a commit to lmolkova/opentelemetry-specification that referenced this pull request Mar 8, 2023
…n-telemetry#3292)

Clarify relationship between `http.target` and `http.route` by using the
same pattern in the example usage. Having different patterns for the
attribute values distorts the relationship between the two attributes.

A similar pattern is seen in the docs for
[`aws-lambda.md`](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/instrumentation/aws-lambda.md#api-gateway-request-proxy-lambda-tracing-passive),
where `http.target` is `/pets/10` and `http.route` is `/pets/{petId}`.
It's a minor adjustment but should help provide clarity for new users.

---------

Co-authored-by: Joshua MacDonald <jmacd@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:semantic-conventions Related to semantic conventions semconv:HTTP
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants