-
Notifications
You must be signed in to change notification settings - Fork 290
Introduce service.peer.name and service.peer.namespace; deprecate peer.service #3097
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| # Use this changelog template to create an entry for release notes. | ||
| # | ||
| # If your change doesn't affect end users you should instead start | ||
| # your pull request title with [chore] or use the "Skip Changelog" label. | ||
|
|
||
| # One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' | ||
| change_type: deprecation | ||
|
|
||
| # The name of the area of concern in the attributes-registry, (e.g. http, cloud, db) | ||
| component: peer | ||
|
|
||
| # A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). | ||
| note: The `peer.service` attribute has been deprecated in favor of `service.peer.name`. | ||
|
|
||
| # Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists. | ||
| # The values here must be integers. | ||
| issues: [2945] | ||
|
|
||
| # (Optional) One or more lines of additional information to render under the primary note. | ||
| # These lines will be padded with 2 spaces and then inserted directly into the document. | ||
| # Use pipe (|) for multiline entries. | ||
| subtext: The `peer.service` attribute has been renamed to `service.peer.name` to align with the `service.{name|namespace}` resource attributes. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| # Use this changelog template to create an entry for release notes. | ||
| # | ||
| # If your change doesn't affect end users you should instead start | ||
| # your pull request title with [chore] or use the "Skip Changelog" label. | ||
|
|
||
| # One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' | ||
| change_type: enhancement | ||
|
|
||
| # The name of the area of concern in the attributes-registry, (e.g. http, cloud, db) | ||
| component: service | ||
|
|
||
| # A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). | ||
| note: "`service.peer.name` and `service.peer.namespace` have been introduced as the replacement for `peer.service` to describe remote services that use both a name and a namespace." | ||
|
|
||
| # Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists. | ||
| # The values here must be integers. | ||
| issues: [2945] | ||
|
|
||
| # (Optional) One or more lines of additional information to render under the primary note. | ||
| # These lines will be padded with 2 spaces and then inserted directly into the document. | ||
| # Use pipe (|) for multiline entries. | ||
| subtext: The `peer.service` attribute could not fully represent the `service.{name|namespace}` resource attributes; `service.peer.name` and `service.peer.namespace` provide a more complete representation. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| groups: | ||
| - id: service.peer | ||
| type: attribute_group | ||
| brief: "Operations that access some remote service." | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Nit: "Operations that access some remote service MAY fill out these attributes" |
||
| attributes: | ||
| - ref: service.peer.name | ||
| requirement_level: recommended | ||
| - ref: service.peer.namespace | ||
| requirement_level: recommended | ||
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -69,3 +69,22 @@ groups: | |||||||||||||||||||||||||||||||||||||||||||||||||||||
| for that telemetry. This is typically the case for scraping receivers, as they know the target address and | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| port. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| examples: ["627cc493-f310-47de-96bd-71410b7dec09"] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - id: registry.service.peer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| type: attribute_group | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| display_name: Service Attributes for Peer Services | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| brief: > | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| How to describe the service on the other side of a request. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| attributes: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - id: service.peer.name | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| type: string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| stability: development | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| brief: > | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Logical name of the service on the other side of the connection. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SHOULD be equal to the actual [`service.name`](/docs/resource/README.md#service) resource attribute of the remote service if any. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. What has me concerned here is we don't have a specified way for instrumentation (i.e the OTel API) to access the resource attribute and fill out a @mmanciop I do think we need an overall "Improve the state of service-peer in OTEL Specification" tracking bug, with known examples/demos you've collected. However, there's enough usage in OTEL now, that I think we this is ok for now. I just believe this requirement is "too hard" to accomplish in practice in OTEL. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
| examples: ["shoppingcart"] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| - id: service.peer.namespace | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| type: string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| stability: development | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| brief: > | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| A namespace for `service.peer.name`. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| examples: ["Shop"] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+78
to
+90
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The entire rationale behind this PR is that we want the moving into The goal is when we change |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should be specified on the attribute definition/registry and not the usage of it.