Skip to main content

file output

Writes messages to files on disk based on a chosen codec.

# Config fields, showing default values
output:
  label: ""
  file:
    path: "" # No default (required)
    codec: "lines"

Messages can be written to different files by using interpolation functions in the path field. However, only one file is ever open at a given time, and therefore when the path changes the previously open file is closed.

Fields​

path​

The file to write to, if the file does not yet exist it will be created.

This field supports interpolation functions.

Type: string

codec​

The way in which the bytes of messages should be written out into the output data stream. It's possible to write lines using a custom delimiter with the delim:x codec, where x is the character sequence custom delimiter.

Type: string
Default: "lines"

OptionSummary
all-bytesOnly applicable to file based outputs. Writes each message to a file in full, if the file already exists the old content is deleted.
appendAppend each message to the output stream without any delimiter or special encoding.
delim:xAppend each message to the output stream followed by a custom delimiter.
linesAppend each message to the output stream followed by a line break.