Skip to content

Commit

Permalink
[chore] Move Peer to registry (#853)
Browse files Browse the repository at this point in the history
Co-authored-by: Joao Grassi <[email protected]>
  • Loading branch information
trisch-me and joaopgrassi authored Apr 3, 2024
1 parent 8dc38ec commit bc41469
Show file tree
Hide file tree
Showing 8 changed files with 34 additions and 9 deletions.
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ body:
- area:network
- area:oci
- area:os
- area:peer
- area:process
- area:rpc
- area:server
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/change_proposal.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ body:
- area:network
- area:oci
- area:os
- area:peer
- area:process
- area:rpc
- area:server
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/new-conventions.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ body:
- area:network
- area:oci
- area:os
- area:peer
- area:process
- area:rpc
- area:server
Expand Down
1 change: 1 addition & 0 deletions docs/attributes-registry/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ Currently, the following namespaces exist:
* [Network](network.md)
* [OCI](oci.md)
* [OS](os.md)
* [Peer](peer.md)
* [Process](process.md)
* [RPC](rpc.md)
* [Server](server.md)
Expand Down
12 changes: 12 additions & 0 deletions docs/attributes-registry/peer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<!--- Hugo front matter used to generate the website version of this page:
--->

# Peer

## Peer Attributes

<!-- semconv registry.peer(omit_requirement_level) -->
| Attribute | Type | Description | Examples | Stability |
|---|---|---|---|---|
| `peer.service` | string | The [`service.name`](/docs/resource/README.md#service) of the remote service. SHOULD be equal to the actual `service.name` resource attribute of the remote service if any. | `AuthTokenCache` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
<!-- endsemconv -->
2 changes: 1 addition & 1 deletion docs/general/attributes.md
Original file line number Diff line number Diff line change
Expand Up @@ -296,7 +296,7 @@ Instrumentations SHOULD provide a way for users to configure this name.
<!-- semconv peer -->
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
|---|---|---|---|---|---|
| `peer.service` | string | The [`service.name`](/docs/resource/README.md#service) of the remote service. SHOULD be equal to the actual `service.name` resource attribute of the remote service if any. | `AuthTokenCache` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| [`peer.service`](../attributes-registry/peer.md) | string | The [`service.name`](/docs/resource/README.md#service) of the remote service. SHOULD be equal to the actual `service.name` resource attribute of the remote service if any. | `AuthTokenCache` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
<!-- endsemconv -->

Examples of `peer.service` that users may specify:
Expand Down
10 changes: 2 additions & 8 deletions model/general.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -32,14 +32,8 @@ groups:
type: span
brief: "Operations that access some remote service."
attributes:
- id: service
type: string
stability: experimental
brief: >
The [`service.name`](/docs/resource/README.md#service)
of the remote service. SHOULD be equal to the actual `service.name`
resource attribute of the remote service if any.
examples: "AuthTokenCache"
- ref: peer.service
requirement_level: recommended
- id: identity
type: span
brief: >
Expand Down
15 changes: 15 additions & 0 deletions model/registry/peer.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
groups:
- id: registry.peer
type: span
prefix: peer
brief: >
Operations that access some remote service.
attributes:
- id: service
type: string
stability: experimental
brief: >
The [`service.name`](/docs/resource/README.md#service)
of the remote service. SHOULD be equal to the actual `service.name`
resource attribute of the remote service if any.
examples: "AuthTokenCache"

0 comments on commit bc41469

Please sign in to comment.