From 1612ca6c00164d5129047d96adc061c65c2e8aea Mon Sep 17 00:00:00 2001 From: Patrick Housley Date: Mon, 30 Oct 2023 09:20:16 -0500 Subject: [PATCH 1/7] Merging domain and name --- specification/logs/event-api.md | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/specification/logs/event-api.md b/specification/logs/event-api.md index 6c59ac226b3..9c3ffc6424d 100644 --- a/specification/logs/event-api.md +++ b/specification/logs/event-api.md @@ -30,11 +30,12 @@ From OpenTelemetry's perspective LogRecords and Events are both represented using the same [data model](./data-model.md). However, OpenTelemetry does recognize a subtle semantic difference between -LogRecords and Events: Events are LogRecords which have a `name` and `domain`. -Within a particular `domain`, the `name` uniquely defines a particular class or -type of event. Events with the same `domain` / `name` follow the same schema -which assists in analysis in observability platforms. Events are described in -more detail in the [semantic conventions](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/general/events.md). +LogRecords and Events: Events are LogRecords which have a unique `name` that +includes a `namespace`. The `namespace` and name are separated by a period. +The unique `name` defined a particular class or type of event. All events with +the same `name` follow the same schema which assists in analysis in observability +platforms. Events are described in more detail in the +[semantic conventions](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/general/events.md). While the logging space has a diverse legacy with many existing logging libraries in different languages, there is not ubiquitous alignment with @@ -65,8 +66,6 @@ on `EventLogger`. * `logger` - the delegate [Logger](./bridge-api.md#logger) used to emit `Events` as `LogRecord`s. -* `event_domain` - the domain of emitted events, used to set the `event.domain` - attribute. #### Emit Event @@ -88,7 +87,4 @@ The implementation MUST [emit](./bridge-api.md#emit-a-logrecord) the `logRecord` the `logger` specified when [creating the EventLogger](#create-eventlogger) after making the following changes: -* The `event_domain` specified - when [creating the EventLogger](#create-eventlogger) MUST be set as - the `event.domain` attribute on the `logRecord`. * The `event_name` MUST be set as the `event.name` attribute on the `logRecord`. From a751b4bacb1ee653fb3c10b34ee411d8b9fa79ed Mon Sep 17 00:00:00 2001 From: Patrick Housley Date: Fri, 17 Nov 2023 12:02:15 -0600 Subject: [PATCH 2/7] Update specification/logs/event-api.md Co-authored-by: jack-berg <34418638+jack-berg@users.noreply.github.com> --- specification/logs/event-api.md | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/specification/logs/event-api.md b/specification/logs/event-api.md index 9c3ffc6424d..a7a8f028cdb 100644 --- a/specification/logs/event-api.md +++ b/specification/logs/event-api.md @@ -30,12 +30,7 @@ From OpenTelemetry's perspective LogRecords and Events are both represented using the same [data model](./data-model.md). However, OpenTelemetry does recognize a subtle semantic difference between -LogRecords and Events: Events are LogRecords which have a unique `name` that -includes a `namespace`. The `namespace` and name are separated by a period. -The unique `name` defined a particular class or type of event. All events with -the same `name` follow the same schema which assists in analysis in observability -platforms. Events are described in more detail in the -[semantic conventions](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/general/events.md). +LogRecords and Events: Events are LogRecords which have a `name` which uniquely defines a particular class or type of event. All events with the same `name` follow the same schema which assists in analysis in observability platforms. Events are described in more detail in the [semantic conventions](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/general/events.md). While the logging space has a diverse legacy with many existing logging libraries in different languages, there is not ubiquitous alignment with From 156d5349b7f6ab975afe4c037def4c6d77c71055 Mon Sep 17 00:00:00 2001 From: Patrick Housley Date: Mon, 20 Nov 2023 07:55:41 -0600 Subject: [PATCH 3/7] fix formatting --- specification/logs/event-api.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/specification/logs/event-api.md b/specification/logs/event-api.md index a7a8f028cdb..c543e70c035 100644 --- a/specification/logs/event-api.md +++ b/specification/logs/event-api.md @@ -30,7 +30,11 @@ From OpenTelemetry's perspective LogRecords and Events are both represented using the same [data model](./data-model.md). However, OpenTelemetry does recognize a subtle semantic difference between -LogRecords and Events: Events are LogRecords which have a `name` which uniquely defines a particular class or type of event. All events with the same `name` follow the same schema which assists in analysis in observability platforms. Events are described in more detail in the [semantic conventions](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/general/events.md). +LogRecords and Events: Events are LogRecords which have a `name` which uniquely +defines a particular class or type of event. All events with the same `name` +follow the same schema which assists in analysis in observability platforms. +Events are described in more detail in the +[semantic conventions](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/general/events.md). While the logging space has a diverse legacy with many existing logging libraries in different languages, there is not ubiquitous alignment with @@ -74,7 +78,8 @@ This function MAY be named `logEvent`. attribute with the key `event.name`. Care MUST be taken by the implementation to not override or delete this attribute while the Event is emitted to preserve its identity. -* `logRecord` - the [LogRecord](./data-model.md#log-and-event-record-definition) representing the Event. +* `logRecord` - the [LogRecord](./data-model.md#log-and-event-record-definition) representing + the Event. **Implementation Requirements:** From 287bc1439b989210cb5b8189f63c7ed28f441b69 Mon Sep 17 00:00:00 2001 From: Patrick Housley Date: Mon, 20 Nov 2023 09:31:44 -0600 Subject: [PATCH 4/7] update changelog --- CHANGELOG.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 97339f5c48f..685a589d6b4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -18,6 +18,11 @@ release. ### Logs +- BREAKING: Remove `event.domain` from log event attributes. + ([#473](https://github.com/open-telemetry/semantic-conventions/pull/473)) +- BREAKING: Change `event.name` definition to include `namespace`. + ([#473](https://github.com/open-telemetry/semantic-conventions/pull/473)) + ### Resource ### OpenTelemetry Protocol From 74b669bf61ec790747e103e40bb9953ab1c90169 Mon Sep 17 00:00:00 2001 From: Patrick Housley Date: Mon, 20 Nov 2023 09:40:05 -0600 Subject: [PATCH 5/7] remove event.domain --- specification/versioning-and-stability.md | 1 - 1 file changed, 1 deletion(-) diff --git a/specification/versioning-and-stability.md b/specification/versioning-and-stability.md index 33d7a2aafa9..b2632067aad 100644 --- a/specification/versioning-and-stability.md +++ b/specification/versioning-and-stability.md @@ -212,7 +212,6 @@ Semantic Conventions defines the set of fields in the OTLP data model: - For log records that are [Log Events](logs/event-api.md) - The following data provided to [emit event](logs/event-api.md#emit-event): - The event name (the value of the `event.name` attribute) - - The event domain (the value of the `event.domain` attribute) Things not listed in the above are not expected to remain stable via semantic convention and are allowed (or expected) to change. A few examples: From 696a7738852788bcdb4ede0348d6e30b44121e64 Mon Sep 17 00:00:00 2001 From: Patrick Housley Date: Mon, 20 Nov 2023 14:32:04 -0600 Subject: [PATCH 6/7] fix changelog --- CHANGELOG.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c6f15dfcd81..3ce533f8d5e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -21,9 +21,9 @@ release. - Add definition for standard output log record exporter. ([#3741](https://github.com/open-telemetry/opentelemetry-specification/pull/3741)) - BREAKING: Remove `event.domain` from log event attributes. - ([#473](https://github.com/open-telemetry/semantic-conventions/pull/473)) + ([#3749](https://github.com/open-telemetry/opentelemetry-specification/pull/3749)) - BREAKING: Change `event.name` definition to include `namespace`. - ([#473](https://github.com/open-telemetry/semantic-conventions/pull/473)) + ([#3749](https://github.com/open-telemetry/opentelemetry-specification/pull/3749)) ### Resource From 00ed436230e60e78d4762fd703c1b0854bbce01c Mon Sep 17 00:00:00 2001 From: Patrick Housley Date: Mon, 27 Nov 2023 10:49:01 -0600 Subject: [PATCH 7/7] combine changelog entries --- CHANGELOG.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3ce533f8d5e..86959a78737 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -20,9 +20,7 @@ release. - Add definition for standard output log record exporter. ([#3741](https://github.com/open-telemetry/opentelemetry-specification/pull/3741)) -- BREAKING: Remove `event.domain` from log event attributes. - ([#3749](https://github.com/open-telemetry/opentelemetry-specification/pull/3749)) -- BREAKING: Change `event.name` definition to include `namespace`. +- BREAKING: Change `event.name` definition to include `namespace` and removed `event.domain` from log event attributes. ([#3749](https://github.com/open-telemetry/opentelemetry-specification/pull/3749)) ### Resource