From 38b6b4b859e00709616437d1f7823f66a265ba68 Mon Sep 17 00:00:00 2001 From: Daniel Jaglowski Date: Tue, 3 Jan 2023 12:21:48 -0500 Subject: [PATCH] Clarify usage of log body for structured logs (#3023) See decision by Log SIG noted in [#3014](https://github.com/open-telemetry/opentelemetry-specification/pull/3014#issuecomment-1341417757) --- CHANGELOG.md | 2 ++ specification/logs/data-model.md | 7 ++++--- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 46567e2ab29..06d137f49a1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -78,6 +78,8 @@ release. ([#2969](https://github.com/open-telemetry/opentelemetry-specification/pull/2969)) - Make sure it is very clear we are not building a Logging API. ([#2966](https://github.com/open-telemetry/opentelemetry-specification/pull/2966)) +- Clarify usage of log body for structured logs + ([#3023](https://github.com/open-telemetry/opentelemetry-specification/pull/3023)) ### Resource diff --git a/specification/logs/data-model.md b/specification/logs/data-model.md index 9faab0e1b89..43d271aa136 100644 --- a/specification/logs/data-model.md +++ b/specification/logs/data-model.md @@ -419,9 +419,10 @@ Description: A value containing the body of the log record (see the description of `any` type above). Can be for example a human-readable string message (including multi-line) describing the event in a free form or it can be a structured data composed of arrays and maps of other values. First-party -Applications SHOULD use a string message. However, a structured body may be -necessary to preserve the semantics of some existing log formats. Can vary for -each occurrence of the event coming from the same source. This field is optional. +Applications SHOULD use a string message. However, a structured body SHOULD be +used to preserve the semantics of structured logs emitted by Third-party +Applications. Can vary for each occurrence of the event coming from the same +source. This field is optional. ### Field: `Resource`