From 4584cb5629a3a9fd25da82819c672d7c67df07e6 Mon Sep 17 00:00:00 2001 From: Alexandra Konrad Date: Mon, 8 Apr 2024 22:09:13 +0200 Subject: [PATCH 1/3] move event to registry --- docs/attributes-registry/README.md | 1 + docs/attributes-registry/event.md | 15 +++++++++++++++ docs/general/events.md | 2 +- model/logs/events.yaml | 12 +----------- model/registry/event.yaml | 18 ++++++++++++++++++ 5 files changed, 36 insertions(+), 12 deletions(-) create mode 100644 docs/attributes-registry/event.md create mode 100644 model/registry/event.yaml diff --git a/docs/attributes-registry/README.md b/docs/attributes-registry/README.md index c9f832ec74..7128bae766 100644 --- a/docs/attributes-registry/README.md +++ b/docs/attributes-registry/README.md @@ -43,6 +43,7 @@ Currently, the following namespaces exist: * [Disk](disk.md) * [End user](enduser.md) * [Error](error.md) +* [Event](event.md) * [Exception](exception.md) * [FaaS](faas.md) * [Feature Flag](feature-flag.md) diff --git a/docs/attributes-registry/event.md b/docs/attributes-registry/event.md new file mode 100644 index 0000000000..c377cf5068 --- /dev/null +++ b/docs/attributes-registry/event.md @@ -0,0 +1,15 @@ + + +# Event + +## Event Attributes + + +| Attribute | Type | Description | Examples | Stability | +|---|---|---|---|---| +| `event.name` | string | Identifies the class / type of event. [1] | `browser.mouse.click`; `device.app.lifecycle` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | + +**[1]:** Event names are subject to the same rules as [attribute names](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.31.0/specification/common/attribute-naming.md). Notably, event names are namespaced to avoid collisions and provide a clean separation of semantics for events in separate domains like browser, mobile, and kubernetes. + diff --git a/docs/general/events.md b/docs/general/events.md index 73668bb423..1cf9f33abb 100644 --- a/docs/general/events.md +++ b/docs/general/events.md @@ -55,7 +55,7 @@ that identify the class of Events but not the instance of the Event. | Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability | |---|---|---|---|---|---| -| `event.name` | string | Identifies the class / type of event. [1] | `browser.mouse.click`; `device.app.lifecycle` | `Required` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| [`event.name`](../attributes-registry/event.md) | string | Identifies the class / type of event. [1] | `browser.mouse.click`; `device.app.lifecycle` | `Required` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | **[1]:** Event names are subject to the same rules as [attribute names](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.31.0/specification/common/attribute-naming.md). Notably, event names are namespaced to avoid collisions and provide a clean separation of semantics for events in separate domains like browser, mobile, and kubernetes. diff --git a/model/logs/events.yaml b/model/logs/events.yaml index 1576901054..bde5ee9fb0 100644 --- a/model/logs/events.yaml +++ b/model/logs/events.yaml @@ -5,15 +5,5 @@ groups: brief: > This document defines attributes for Events represented using Log Records. attributes: - - id: name - type: string - stability: experimental + - ref: event.name requirement_level: required - brief: > - Identifies the class / type of event. - note: > - Event names are subject to the same rules as [attribute names](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.31.0/specification/common/attribute-naming.md). - Notably, event names are namespaced to avoid collisions and provide a clean - separation of semantics for events in separate domains like browser, mobile, and - kubernetes. - examples: ['browser.mouse.click', 'device.app.lifecycle'] diff --git a/model/registry/event.yaml b/model/registry/event.yaml new file mode 100644 index 0000000000..aa69709b69 --- /dev/null +++ b/model/registry/event.yaml @@ -0,0 +1,18 @@ +groups: + - id: registry.event + prefix: event + type: attribute_group + brief: > + Attributes for Events represented using Log Records. + attributes: + - id: name + type: string + stability: experimental + brief: > + Identifies the class / type of event. + note: > + Event names are subject to the same rules as [attribute names](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.31.0/specification/common/attribute-naming.md). + Notably, event names are namespaced to avoid collisions and provide a clean + separation of semantics for events in separate domains like browser, mobile, and + kubernetes. + examples: ['browser.mouse.click', 'device.app.lifecycle'] From 859685b3e5602ba7e1b5ebe8b7eff8feee6d5434 Mon Sep 17 00:00:00 2001 From: Alexandra Konrad Date: Mon, 8 Apr 2024 22:11:08 +0200 Subject: [PATCH 2/3] update 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 138ec6c592..a092aec365 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -35,6 +35,7 @@ body: - area:dns - area:enduser - area:error + - area:event - area:exception - area:faas - area:feature-flag diff --git a/.github/ISSUE_TEMPLATE/change_proposal.yaml b/.github/ISSUE_TEMPLATE/change_proposal.yaml index 117491cb40..20a46cad35 100644 --- a/.github/ISSUE_TEMPLATE/change_proposal.yaml +++ b/.github/ISSUE_TEMPLATE/change_proposal.yaml @@ -28,6 +28,7 @@ body: - area:dns - area:enduser - area:error + - area:event - area:exception - area:faas - area:feature-flag diff --git a/.github/ISSUE_TEMPLATE/new-conventions.yaml b/.github/ISSUE_TEMPLATE/new-conventions.yaml index f663263c59..ffebb79b57 100644 --- a/.github/ISSUE_TEMPLATE/new-conventions.yaml +++ b/.github/ISSUE_TEMPLATE/new-conventions.yaml @@ -37,6 +37,7 @@ body: - area:dns - area:enduser - area:error + - area:event - area:exception - area:faas - area:feature-flag From d148f849aaaf83ae79bec062f6f54c05712601bf Mon Sep 17 00:00:00 2001 From: Alexandra Konrad Date: Mon, 8 Apr 2024 22:11:42 +0200 Subject: [PATCH 3/3] remove prefix --- model/logs/events.yaml | 1 - 1 file changed, 1 deletion(-) diff --git a/model/logs/events.yaml b/model/logs/events.yaml index bde5ee9fb0..b07e25a8df 100644 --- a/model/logs/events.yaml +++ b/model/logs/events.yaml @@ -1,7 +1,6 @@ groups: - id: event type: attribute_group - prefix: event brief: > This document defines attributes for Events represented using Log Records. attributes: