diff --git a/.chloggen/2597.yaml b/.chloggen/2597.yaml new file mode 100644 index 000000000..3f01b2fd9 --- /dev/null +++ b/.chloggen/2597.yaml @@ -0,0 +1,8 @@ +change_type: enhancement +component: event +note: "Revive `event.name` attribute for use by non-OTLP exporters and logging libraries." +issues: [2597] +subtext: | + The `event.name` attribute is now undeprecated and can be used by: + - Non-OTLP exporters to emit the `EventName` + - Applications using existing logging libraries to add event name information that can be used to set the `EventName` field by Collector or SDK components diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index 2112d90db..2fa1a39f0 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -49,6 +49,7 @@ body: - area:elasticsearch - 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 c0999b4bc..3cc14bf09 100644 --- a/.github/ISSUE_TEMPLATE/change_proposal.yaml +++ b/.github/ISSUE_TEMPLATE/change_proposal.yaml @@ -41,6 +41,7 @@ body: - area:elasticsearch - 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 2e8c7b729..ff72d86a9 100644 --- a/.github/ISSUE_TEMPLATE/new-conventions.yaml +++ b/.github/ISSUE_TEMPLATE/new-conventions.yaml @@ -52,6 +52,7 @@ body: - area:elasticsearch - area:enduser - area:error + - area:event - area:exception - area:faas - area:feature-flag diff --git a/docs/registry/attributes/event.md b/docs/registry/attributes/event.md index 41eac0c4e..216c9e699 100644 --- a/docs/registry/attributes/event.md +++ b/docs/registry/attributes/event.md @@ -9,4 +9,6 @@ Attributes for Events represented using Log Records. | Attribute | Type | Description | Examples | Stability | |---|---|---|---|---| -| `event.name` | string | Identifies the class / type of event. | `browser.mouse.click`; `device.app.lifecycle` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by EventName top-level field on the LogRecord. | +| `event.name` | string | Identifies the class / type of event. [1] | `browser.mouse.click`; `device.app.lifecycle` | ![Development](https://img.shields.io/badge/-development-blue) | + +**[1] `event.name`:** This attribute SHOULD be used by non-OTLP exporters when destination does not support `EventName` or equivalent field. This attribute MAY be used by applications using existing logging libraries so that it can be used to set the `EventName` field by Collector or SDK components. diff --git a/model/event/deprecated/registry-deprecated.yaml b/model/event/deprecated/registry-deprecated.yaml deleted file mode 100644 index 701f3ba0a..000000000 --- a/model/event/deprecated/registry-deprecated.yaml +++ /dev/null @@ -1,17 +0,0 @@ -groups: - - id: registry.event.deprecated - type: attribute_group - display_name: Event Attributes - brief: > - Attributes for Events represented using Log Records. - attributes: - - id: event.name - type: string - stability: development - deprecated: - reason: uncategorized - note: > - Replaced by EventName top-level field on the LogRecord. - brief: > - Identifies the class / type of event. - examples: ["browser.mouse.click", "device.app.lifecycle"] diff --git a/model/event/registry.yaml b/model/event/registry.yaml new file mode 100644 index 000000000..02acfc1b2 --- /dev/null +++ b/model/event/registry.yaml @@ -0,0 +1,19 @@ +groups: + - id: registry.event + type: attribute_group + display_name: Event Attributes + brief: > + Attributes for Events represented using Log Records. + attributes: + - id: event.name + type: string + stability: development + brief: > + Identifies the class / type of event. + note: > + This attribute SHOULD be used by non-OTLP exporters + when destination does not support `EventName` or equivalent field. + This attribute MAY be used by applications using existing logging + libraries so that it can be used to set the `EventName` field by + Collector or SDK components. + examples: ["browser.mouse.click", "device.app.lifecycle"]