Skip to main content
Version: v4.29

write_kv

Writes events in a Key-Value format.

write_kv [field_separator=str, value_separator=str, list_separator=str,
          flatten_separator=str, null_value=str]

Description

Writes events in a Key-Value format, with one event per line. Nested data will be flattend, keys or values containing the given separators will be quoted and the special characters \n, \r, \ and " will be escaped.

field_separator = str (optional)

A string that shall separate the key-value pairs.

Must not be an empty string.

Defaults to " ".

value_separator = str (optional)

A string that shall separate key and value within key-value pair.

Must not be an empty string.

Defaults to "=".

list_separator = str (optional)

Must not be an empty string.

Defaults to ",".

flatten_separator = str (optional)

A string to join the keys of nested records with. For example, given flatten="."

Defaults to ".".

null_value = str (optional)

A string to represent null values.

Defaults to the empty string.

Examples

Conditionally quoted strings

from {x: "hello world", y: "hello=world"}
x="hello world" y:"hello=world"

Flattend output

from {x: {y: {z:0}, y2:42}, a: "string" }
write_kv
x.y.z=0 y.y2=42 a=string

See Also

read_kv