docs/index.asciidoc in logstash-codec-edn_lines-3.0.6 vs docs/index.asciidoc in logstash-codec-edn_lines-3.1.0

- old
+ new

@@ -19,5 +19,39 @@ include::{include_path}/plugin_header.asciidoc[] ==== Description Reads and produces newline-delimited EDN format data. + +[id="plugins-{type}s-{plugin}-options"] +==== Edn_lines Codec configuration options + +[cols="<,<,<",options="header",] +|======================================================================= +|Setting |Input type|Required +| <<plugins-{type}s-{plugin}-target>> |<<string,string>>|No +|======================================================================= + +&nbsp; + +[id="plugins-{type}s-{plugin}-target"] +===== `target` + + * Value type is <<string,string>> + * There is no default value for this setting. + * The option is only relevant while decoding. + +Define the target field for placing the decoded fields. +If this setting is not set, data will be stored at the root (top level) of the event. + +For example, if you want data to be put under the `document` field: +[source,ruby] + input { + tcp { + port => 4242 + codec => edn_lines { + target => "[document]" + } + } + } + +