Skip to content

Commit

Permalink
Explain expected usage of log body (#2096)
Browse files Browse the repository at this point in the history
Resolves #2066 and #1752

Supports #2068

## Changes

Adds a note to the log data model which explains the intended usage of the `Body` field. 

## Additional Context

Extensive discussion has been had on this issue on [#1613](#1613 (comment)), as well as in the Log SIG group.
  • Loading branch information
djaglowski authored Nov 4, 2021
1 parent 0c70e96 commit 32d6965
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions specification/logs/data-model.md
Original file line number Diff line number Diff line change
Expand Up @@ -398,8 +398,10 @@ 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. Can vary for each
occurrence of the event coming from the same source. This field is optional.
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.

### Field: `Resource`

Expand Down

0 comments on commit 32d6965

Please sign in to comment.