From b3d8e78d0f58e156a12614320d7bbe078a9cc20f Mon Sep 17 00:00:00 2001 From: Robert Pajak Date: Tue, 27 Jan 2026 20:09:09 +0100 Subject: [PATCH 1/8] Update event body usage guidelines to allow representation of display messages --- docs/general/events.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/general/events.md b/docs/general/events.md index 67881a6ee5..96cc9a32a5 100644 --- a/docs/general/events.md +++ b/docs/general/events.md @@ -30,10 +30,12 @@ Semantic conventions that define events MUST document the event name and its att * [Attributes](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.53.0/specification/logs/data-model.md#field-attributes) SHOULD be used to represent details and provide additional context about the event. -* Events SHOULD NOT use [body](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.53.0/specification/logs/data-model.md#field-body). - * Events SHOULD specify a [severity number](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.53.0/specification/logs/data-model.md#field-severitynumber). +* Events MAY use [body](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.53.0/specification/logs/data-model.md#field-body) + to represent the display message of the event, + which is RECOMMENDED to be of string type. + ## External event compatibility When recording events from an existing system as OpenTelemetry Events, it's common From 0a00a99bf5be3536712b62ee28616d51543b2f88 Mon Sep 17 00:00:00 2001 From: Robert Pajak Date: Tue, 27 Jan 2026 20:12:21 +0100 Subject: [PATCH 2/8] add changelog entry --- .chloggen/3343.yaml | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 .chloggen/3343.yaml diff --git a/.chloggen/3343.yaml b/.chloggen/3343.yaml new file mode 100644 index 0000000000..fb0cdfde4d --- /dev/null +++ b/.chloggen/3343.yaml @@ -0,0 +1,4 @@ +change_type: enhancement +component: event +note: Update event body usage guidelines to allow representation of display messages +issues: [3343] From b96f18c6736c57b9fdcb058ae20b80dae6bcb1d8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Paj=C4=85k?= Date: Tue, 27 Jan 2026 20:13:36 +0100 Subject: [PATCH 3/8] Update 3343.yaml --- .chloggen/3343.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.chloggen/3343.yaml b/.chloggen/3343.yaml index fb0cdfde4d..24aa0da2a1 100644 --- a/.chloggen/3343.yaml +++ b/.chloggen/3343.yaml @@ -1,4 +1,4 @@ change_type: enhancement component: event -note: Update event body usage guidelines to allow representation of display messages +note: Allow event body to represent a display message issues: [3343] From c54e19934c8cab39e1308beda72e6899054ffde6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Paj=C4=85k?= Date: Tue, 27 Jan 2026 21:10:38 +0100 Subject: [PATCH 4/8] Update 3343.yaml --- .chloggen/3343.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.chloggen/3343.yaml b/.chloggen/3343.yaml index 24aa0da2a1..669d9b2e1a 100644 --- a/.chloggen/3343.yaml +++ b/.chloggen/3343.yaml @@ -1,4 +1,4 @@ change_type: enhancement component: event -note: Allow event body to represent a display message +note: Allow event body to represent a display message. issues: [3343] From 60bda621a634e6309579e9ca79bafdb460965dbd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Paj=C4=85k?= Date: Fri, 30 Jan 2026 17:30:22 +0100 Subject: [PATCH 5/8] Update docs/general/events.md --- docs/general/events.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/general/events.md b/docs/general/events.md index 96cc9a32a5..cad6788ec7 100644 --- a/docs/general/events.md +++ b/docs/general/events.md @@ -35,6 +35,8 @@ Semantic conventions that define events MUST document the event name and its att * Events MAY use [body](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.53.0/specification/logs/data-model.md#field-body) to represent the display message of the event, which is RECOMMENDED to be of string type. + Some (e.g. HTTP) semantic conventions MAY + have their own specific rules on using body. ## External event compatibility From d4c6008b10a408d51977de731eee9e0140e8a870 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Paj=C4=85k?= Date: Thu, 12 Feb 2026 11:23:31 +0100 Subject: [PATCH 6/8] Revert semconv specific rules --- docs/general/events.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/general/events.md b/docs/general/events.md index cad6788ec7..96cc9a32a5 100644 --- a/docs/general/events.md +++ b/docs/general/events.md @@ -35,8 +35,6 @@ Semantic conventions that define events MUST document the event name and its att * Events MAY use [body](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.53.0/specification/logs/data-model.md#field-body) to represent the display message of the event, which is RECOMMENDED to be of string type. - Some (e.g. HTTP) semantic conventions MAY - have their own specific rules on using body. ## External event compatibility From c07676a0a13548d5630e50a1dafb989c2946e39e Mon Sep 17 00:00:00 2001 From: Robert Pajak Date: Tue, 17 Feb 2026 12:26:54 +0100 Subject: [PATCH 7/8] refine event body usage guidelines in semantic conventions --- docs/general/events.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/general/events.md b/docs/general/events.md index c74208ec7d..31ed51ed2d 100644 --- a/docs/general/events.md +++ b/docs/general/events.md @@ -32,9 +32,8 @@ Semantic conventions that define events MUST document the event name and its att * Events SHOULD specify a [severity number](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.54.0/specification/logs/data-model.md#field-severitynumber). -* Events MAY use [body](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.54.0/specification/logs/data-model.md#field-body) - to represent the display message of the event, - which is RECOMMENDED to be of string type. +* Events SHOULD NOT use [body](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.54.0/specification/logs/data-model.md#field-body) + except of a string display message of the event. ## External event compatibility From 6ebeb5e8321b8fc683b9f84ad4e51645ec754975 Mon Sep 17 00:00:00 2001 From: Trask Stalnaker Date: Tue, 17 Feb 2026 10:05:30 -0800 Subject: [PATCH 8/8] Update docs/general/events.md --- docs/general/events.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/general/events.md b/docs/general/events.md index 31ed51ed2d..d8921ec41e 100644 --- a/docs/general/events.md +++ b/docs/general/events.md @@ -33,7 +33,7 @@ Semantic conventions that define events MUST document the event name and its att * Events SHOULD specify a [severity number](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.54.0/specification/logs/data-model.md#field-severitynumber). * Events SHOULD NOT use [body](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.54.0/specification/logs/data-model.md#field-body) - except of a string display message of the event. + except to represent a string display message of the event. ## External event compatibility