Skip to content

Commit ba43fe4

Browse files
pellaredlmolkova
andauthored
Revive event.name attribute (#2715)
Co-authored-by: Liudmila Molkova <[email protected]>
1 parent 33c54e5 commit ba43fe4

File tree

7 files changed

+33
-18
lines changed

7 files changed

+33
-18
lines changed

.chloggen/2597.yaml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
change_type: enhancement
2+
component: event
3+
note: "Revive `event.name` attribute for use by non-OTLP exporters and logging libraries."
4+
issues: [2597]
5+
subtext: |
6+
The `event.name` attribute is now undeprecated and can be used by:
7+
- Non-OTLP exporters to emit the `EventName`
8+
- Applications using existing logging libraries to add event name information that can be used to set the `EventName` field by Collector or SDK components

.github/ISSUE_TEMPLATE/bug_report.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ body:
4949
- area:elasticsearch
5050
- area:enduser
5151
- area:error
52+
- area:event
5253
- area:exception
5354
- area:faas
5455
- area:feature-flag

.github/ISSUE_TEMPLATE/change_proposal.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ body:
4141
- area:elasticsearch
4242
- area:enduser
4343
- area:error
44+
- area:event
4445
- area:exception
4546
- area:faas
4647
- area:feature-flag

.github/ISSUE_TEMPLATE/new-conventions.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ body:
5252
- area:elasticsearch
5353
- area:enduser
5454
- area:error
55+
- area:event
5556
- area:exception
5657
- area:faas
5758
- area:feature-flag

docs/registry/attributes/event.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,6 @@ Attributes for Events represented using Log Records.
99

1010
| Attribute | Type | Description | Examples | Stability |
1111
|---|---|---|---|---|
12-
| <a id="event-name" href="#event-name">`event.name`</a> | string | Identifies the class / type of event. | `browser.mouse.click`; `device.app.lifecycle` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Replaced by EventName top-level field on the LogRecord. |
12+
| <a id="event-name" href="#event-name">`event.name`</a> | string | Identifies the class / type of event. [1] | `browser.mouse.click`; `device.app.lifecycle` | ![Development](https://img.shields.io/badge/-development-blue) |
13+
14+
**[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.

model/event/deprecated/registry-deprecated.yaml

Lines changed: 0 additions & 17 deletions
This file was deleted.

model/event/registry.yaml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
groups:
2+
- id: registry.event
3+
type: attribute_group
4+
display_name: Event Attributes
5+
brief: >
6+
Attributes for Events represented using Log Records.
7+
attributes:
8+
- id: event.name
9+
type: string
10+
stability: development
11+
brief: >
12+
Identifies the class / type of event.
13+
note: >
14+
This attribute SHOULD be used by non-OTLP exporters
15+
when destination does not support `EventName` or equivalent field.
16+
This attribute MAY be used by applications using existing logging
17+
libraries so that it can be used to set the `EventName` field by
18+
Collector or SDK components.
19+
examples: ["browser.mouse.click", "device.app.lifecycle"]

0 commit comments

Comments
 (0)