From eef46087a3712e41659f324fbd15535ee5ef7095 Mon Sep 17 00:00:00 2001 From: Joao Grassi <5938087+joaopgrassi@users.noreply.github.com> Date: Fri, 5 Apr 2024 12:05:38 +0200 Subject: [PATCH 1/2] Move otel.scope attributes to registry --- docs/attributes-registry/README.md | 1 + docs/attributes-registry/otel.md | 13 ++++++++++++ model/registry/deprecated/otel.yaml | 19 +++++++++++++++++ model/registry/otel.yaml | 16 ++++++++++++++ model/scope/exporter/exporter.yaml | 33 ++++------------------------- 5 files changed, 53 insertions(+), 29 deletions(-) create mode 100644 docs/attributes-registry/otel.md create mode 100644 model/registry/deprecated/otel.yaml create mode 100644 model/registry/otel.yaml diff --git a/docs/attributes-registry/README.md b/docs/attributes-registry/README.md index 7082033cbd..9608e6ed4b 100644 --- a/docs/attributes-registry/README.md +++ b/docs/attributes-registry/README.md @@ -56,6 +56,7 @@ Currently, the following namespaces exist: * [K8s](k8s.md) * [Network](network.md) * [OCI](oci.md) +* [OpenTelemetry](otel.md) * [OS](os.md) * [Peer](peer.md) * [Process](process.md) diff --git a/docs/attributes-registry/otel.md b/docs/attributes-registry/otel.md new file mode 100644 index 0000000000..730ef8a14c --- /dev/null +++ b/docs/attributes-registry/otel.md @@ -0,0 +1,13 @@ + + +# OpenTelemetry + +## Scope Attributes + + +| Attribute | Type | Description | Examples | Stability | +|---|---|---|---|---| +| `otel.scope.name` | string | The name of the instrumentation scope - (`InstrumentationScope.Name` in OTLP). | `io.opentelemetry.contrib.mongodb` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +| `otel.scope.version` | string | The version of the instrumentation scope - (`InstrumentationScope.Version` in OTLP). | `1.0.0` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | + diff --git a/model/registry/deprecated/otel.yaml b/model/registry/deprecated/otel.yaml new file mode 100644 index 0000000000..23456367bc --- /dev/null +++ b/model/registry/deprecated/otel.yaml @@ -0,0 +1,19 @@ +groups: + - id: otel.library + prefix: otel.library + type: resource + brief: > + Span attributes used by non-OTLP exporters to represent OpenTelemetry Scope's concepts. + attributes: + - id: name + type: string + deprecated: use the `otel.scope.name` attribute. + stability: experimental + brief: + examples: ['io.opentelemetry.contrib.mongodb'] + - id: version + type: string + deprecated: use the `otel.scope.version` attribute. + stability: experimental + brief: + examples: ['1.0.0'] diff --git a/model/registry/otel.yaml b/model/registry/otel.yaml new file mode 100644 index 0000000000..1fa7f0da45 --- /dev/null +++ b/model/registry/otel.yaml @@ -0,0 +1,16 @@ +groups: + - id: registry.otel.scope + prefix: otel.scope + type: resource + brief: Attributes used by non-OTLP exporters to represent OpenTelemetry Scope's concepts. + attributes: + - id: name + type: string + brief: The name of the instrumentation scope - (`InstrumentationScope.Name` in OTLP). + examples: ['io.opentelemetry.contrib.mongodb'] + stability: stable + - id: version + type: string + brief: The version of the instrumentation scope - (`InstrumentationScope.Version` in OTLP). + examples: ['1.0.0'] + stability: stable diff --git a/model/scope/exporter/exporter.yaml b/model/scope/exporter/exporter.yaml index 41b27571b4..52f47f0b0e 100644 --- a/model/scope/exporter/exporter.yaml +++ b/model/scope/exporter/exporter.yaml @@ -1,34 +1,9 @@ groups: - id: otel.scope - prefix: otel.scope type: resource brief: Attributes used by non-OTLP exporters to represent OpenTelemetry Scope's concepts. attributes: - - id: name - type: string - brief: The name of the instrumentation scope - (`InstrumentationScope.Name` in OTLP). - examples: ['io.opentelemetry.contrib.mongodb'] - stability: stable - - id: version - type: string - brief: The version of the instrumentation scope - (`InstrumentationScope.Version` in OTLP). - examples: ['1.0.0'] - stability: stable - - id: otel.library - prefix: otel.library - type: resource - brief: > - Span attributes used by non-OTLP exporters to represent OpenTelemetry Scope's concepts. - attributes: - - id: name - type: string - deprecated: use the `otel.scope.name` attribute. - stability: experimental - brief: - examples: ['io.opentelemetry.contrib.mongodb'] - - id: version - type: string - deprecated: use the `otel.scope.version` attribute. - stability: experimental - brief: - examples: ['1.0.0'] + - ref: otel.scope.name + requirement_level: recommended + - ref: otel.scope.version + requirement_level: recommended From ee2e504dcf7d9b0b49fed19fb7878f04ccd78bab Mon Sep 17 00:00:00 2001 From: Joao Grassi <5938087+joaopgrassi@users.noreply.github.com> Date: Fri, 5 Apr 2024 12:07:45 +0200 Subject: [PATCH 2/2] Update issue templates --- .github/ISSUE_TEMPLATE/bug_report.yaml | 1 + .github/ISSUE_TEMPLATE/change_proposal.yaml | 1 + .github/ISSUE_TEMPLATE/new-conventions.yaml | 1 + 3 files changed, 3 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index ee13d72fe0..c44b244e36 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -51,6 +51,7 @@ body: - area:network - area:oci - area:os + - area:otel - area:peer - area:process - area:rpc diff --git a/.github/ISSUE_TEMPLATE/change_proposal.yaml b/.github/ISSUE_TEMPLATE/change_proposal.yaml index 79948d15f1..5ec7d809dc 100644 --- a/.github/ISSUE_TEMPLATE/change_proposal.yaml +++ b/.github/ISSUE_TEMPLATE/change_proposal.yaml @@ -44,6 +44,7 @@ body: - area:network - area:oci - area:os + - area:otel - area:peer - area:process - area:rpc diff --git a/.github/ISSUE_TEMPLATE/new-conventions.yaml b/.github/ISSUE_TEMPLATE/new-conventions.yaml index 710a297c9f..8190eb7eb6 100644 --- a/.github/ISSUE_TEMPLATE/new-conventions.yaml +++ b/.github/ISSUE_TEMPLATE/new-conventions.yaml @@ -53,6 +53,7 @@ body: - area:network - area:oci - area:os + - area:otel - area:peer - area:process - area:rpc