From bc4146949ea37b4e4c39e9f95876e794e7d3dd8b Mon Sep 17 00:00:00 2001 From: Alexandra Konrad <10500694+trisch-me@users.noreply.github.com> Date: Wed, 3 Apr 2024 11:28:57 +0200 Subject: [PATCH] [chore] Move Peer to registry (#853) Co-authored-by: Joao Grassi <5938087+joaopgrassi@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/bug_report.yaml | 1 + .github/ISSUE_TEMPLATE/change_proposal.yaml | 1 + .github/ISSUE_TEMPLATE/new-conventions.yaml | 1 + docs/attributes-registry/README.md | 1 + docs/attributes-registry/peer.md | 12 ++++++++++++ docs/general/attributes.md | 2 +- model/general.yaml | 10 ++-------- model/registry/peer.yaml | 15 +++++++++++++++ 8 files changed, 34 insertions(+), 9 deletions(-) create mode 100644 docs/attributes-registry/peer.md create mode 100644 model/registry/peer.yaml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index c000e27b9b..4453e430d9 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -48,6 +48,7 @@ body: - area:network - area:oci - area:os + - area:peer - area:process - area:rpc - area:server diff --git a/.github/ISSUE_TEMPLATE/change_proposal.yaml b/.github/ISSUE_TEMPLATE/change_proposal.yaml index 0047654c5b..7ca04917ef 100644 --- a/.github/ISSUE_TEMPLATE/change_proposal.yaml +++ b/.github/ISSUE_TEMPLATE/change_proposal.yaml @@ -41,6 +41,7 @@ body: - area:network - area:oci - area:os + - area:peer - area:process - area:rpc - area:server diff --git a/.github/ISSUE_TEMPLATE/new-conventions.yaml b/.github/ISSUE_TEMPLATE/new-conventions.yaml index fa40eee8c9..cb66735b41 100644 --- a/.github/ISSUE_TEMPLATE/new-conventions.yaml +++ b/.github/ISSUE_TEMPLATE/new-conventions.yaml @@ -50,6 +50,7 @@ body: - area:network - area:oci - area:os + - area:peer - area:process - area:rpc - area:server diff --git a/docs/attributes-registry/README.md b/docs/attributes-registry/README.md index 015dbb718b..f8fcc96414 100644 --- a/docs/attributes-registry/README.md +++ b/docs/attributes-registry/README.md @@ -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) diff --git a/docs/attributes-registry/peer.md b/docs/attributes-registry/peer.md new file mode 100644 index 0000000000..e83991a403 --- /dev/null +++ b/docs/attributes-registry/peer.md @@ -0,0 +1,12 @@ + + +# Peer + +## Peer Attributes + + +| 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) | + \ No newline at end of file diff --git a/docs/general/attributes.md b/docs/general/attributes.md index 2c6f13649d..5db478df4e 100644 --- a/docs/general/attributes.md +++ b/docs/general/attributes.md @@ -296,7 +296,7 @@ Instrumentations SHOULD provide a way for users to configure this name. | 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) | Examples of `peer.service` that users may specify: diff --git a/model/general.yaml b/model/general.yaml index 23ec6cd32e..88693dd442 100644 --- a/model/general.yaml +++ b/model/general.yaml @@ -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: > diff --git a/model/registry/peer.yaml b/model/registry/peer.yaml new file mode 100644 index 0000000000..58ee700904 --- /dev/null +++ b/model/registry/peer.yaml @@ -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"