Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove confusing description from Body field in Logs Data Model #3827

Merged
merged 17 commits into from
Feb 6, 2024
Merged
Show file tree
Hide file tree
Changes from 12 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ release.

- Fix `Resource` field type in Logs Data Model.
([#3826](https://github.com/open-telemetry/opentelemetry-specification/pull/3826))
- Remove confusing description from `Body` field in Logs Data Model to make it clear the Bridge API must support a structured body.
([#3827](https://github.com/open-telemetry/opentelemetry-specification/pull/3827))

### Resource

Expand Down
17 changes: 7 additions & 10 deletions specification/logs/data-model.md
Original file line number Diff line number Diff line change
Expand Up @@ -402,16 +402,13 @@ corresponding short names).

### Field: `Body`

Type: any.

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 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
pellared marked this conversation as resolved.
Show resolved Hide resolved
source. This field is optional.
pellared marked this conversation as resolved.
Show resolved Hide resolved
Type: [`any`](#type-any).
pellared marked this conversation as resolved.
Show resolved Hide resolved

Description: A value containing the body of the log record. 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. Body MUST support [`any` type](#type-any) to preserve the semantics of
structured logs emitted by the applications. This field is optional.
pellared marked this conversation as resolved.
Show resolved Hide resolved

### Field: `Resource`

Expand Down
Loading