From dadadfd6d23352c2bb611121f4203bb21ac3b2a6 Mon Sep 17 00:00:00 2001 From: Andrew Kroh Date: Wed, 23 Nov 2016 00:25:05 -0500 Subject: [PATCH] Clarify that json.message_key is optional in Filebeat I reordered the options based on importance (I put the optional config setting at the end). And I changed the wording to further clarify that the `json.message_key` setting is optional. Fixes #2864 --- .../configuration/filebeat-options.asciidoc | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/filebeat/docs/reference/configuration/filebeat-options.asciidoc b/filebeat/docs/reference/configuration/filebeat-options.asciidoc index 9c5490369d9..00a74cb8f8b 100644 --- a/filebeat/docs/reference/configuration/filebeat-options.asciidoc +++ b/filebeat/docs/reference/configuration/filebeat-options.asciidoc @@ -320,16 +320,11 @@ Example configuration: [source,yaml] ------------------------------------------------------------------------------------- -json.message_key: log json.keys_under_root: true json.add_error_key: true +json.message_key: log ------------------------------------------------------------------------------------- - -*`message_key`*:: JSON key on which to apply the line filtering and multiline settings. This key must be top level -and its value must be string, otherwise it is ignored. If no text key is defined, the line -filtering and multiline features cannot be used. - *`keys_under_root`*:: By default, the decoded JSON is placed under a "json" key in the output document. If you enable this setting, the keys are copied top level in the output document. The default is false. @@ -337,7 +332,14 @@ If you enable this setting, the keys are copied top level in the output document JSON object overwrite the fields that Filebeat normally adds (type, source, offset, etc.) in case of conflicts. *`add_error_key`*:: If this setting is enabled, Filebeat adds a "json_error" key in case of JSON -unmarshaling errors or when a text key is defined in the configuration but cannot be used. +unmarshalling errors or when a `message_key` is defined in the configuration but cannot be used. + +*`message_key`*:: An optional configuration setting that specifies a JSON key on +which to apply the line filtering and multiline settings. If specified the +key must be at the top level in the JSON object and the value associated with +the key must be a string, otherwise no filtering or multiline aggregation will +occur. + [[multiline]] ===== multiline