From 51813f68cabbf07bc0f1c3a30471d2cb65b0417c Mon Sep 17 00:00:00 2001 From: Alexandra Konrad <10500694+trisch-me@users.noreply.github.com> Date: Wed, 10 Apr 2024 08:06:05 +0200 Subject: [PATCH] [chore] move event to registry (#907) Co-authored-by: Alexander Wert Co-authored-by: Liudmila Molkova --- .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/event.md | 15 +++++++++++++++ docs/general/events.md | 2 +- model/logs/events.yaml | 13 +------------ model/registry/event.yaml | 18 ++++++++++++++++++ 8 files changed, 39 insertions(+), 13 deletions(-) create mode 100644 docs/attributes-registry/event.md create mode 100644 model/registry/event.yaml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index 850464b1c..2639c9942 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 69dec212c..46733b2f7 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 aa3679844..a89d94a13 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 diff --git a/docs/attributes-registry/README.md b/docs/attributes-registry/README.md index 766e390a9..466920641 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 000000000..c377cf506 --- /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 73668bb42..1cf9f33ab 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 157690105..b07e25a8d 100644 --- a/model/logs/events.yaml +++ b/model/logs/events.yaml @@ -1,19 +1,8 @@ groups: - id: event type: attribute_group - prefix: event 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 000000000..aa69709b6 --- /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']