diff --git a/.chloggen/3343.yaml b/.chloggen/3343.yaml new file mode 100644 index 0000000000..669d9b2e1a --- /dev/null +++ b/.chloggen/3343.yaml @@ -0,0 +1,4 @@ +change_type: enhancement +component: event +note: Allow event body to represent a display message. +issues: [3343] diff --git a/docs/general/events.md b/docs/general/events.md index 04ad60e143..d8921ec41e 100644 --- a/docs/general/events.md +++ b/docs/general/events.md @@ -30,10 +30,11 @@ Semantic conventions that define events MUST document the event name and its att * [Attributes](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.54.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.54.0/specification/logs/data-model.md#field-body). - * 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 to represent a string display message of the event. + ## External event compatibility When recording events from an existing system as OpenTelemetry Events, it's common