Skip to content

Commit

Permalink
chore: Add UX note about encoding of log_schema keys (vectordotdev#17266
Browse files Browse the repository at this point in the history
)

* chore: Add UX note about encoding of log_schema keys

Will need to be updated when log namespacing is released.

Signed-off-by: Jesse Szwedko <jesse.szwedko@datadoghq.com>

* PR feedback

Signed-off-by: Jesse Szwedko <jesse.szwedko@datadoghq.com>

---------

Signed-off-by: Jesse Szwedko <jesse.szwedko@datadoghq.com>
  • Loading branch information
jszwedko authored May 16, 2023
1 parent 5b5ad16 commit dc6e54c
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/USER_EXPERIENCE_DESIGN.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ experience -- the purpose of this document.
1. [Source & sink boundaries](#source--sink-boundaries)
2. [Transform boundaries](#transform-boundaries)
4. [Upfront configuration](#upfront-configuration)
5. [Sink log encoding](#sink-log-encoding)
4. [Adherence](#adherence)
1. [Roles](#roles)
1. [Contributors](#contributors)
Expand Down Expand Up @@ -220,6 +221,13 @@ primary sink rejects events.
Users may need to intervene to update invalid configuration, for example in the
case of rotating invalid API keys.

### Sink log encoding

When encoding logs for sinks, fields indicated by `log_schema` keys should be mapped to where the
destination expects to find them in the encoded payloads. For example, if the sink requires
a "hostname", it should fetch it from the log event using `LogEvent#host_path` to fetch the value
from the appropriate field and place it in the encoded payload where the "hostname" is expected.

## Adherence

### Roles
Expand Down

0 comments on commit dc6e54c

Please sign in to comment.