From dbc3ccefe54514b7e0957f28b4eca69e43508516 Mon Sep 17 00:00:00 2001 From: Brandon Morelli Date: Mon, 30 Dec 2019 10:35:51 -0800 Subject: [PATCH] docs: console output --- .../outputs/console/docs/console.asciidoc | 22 +++++++++++-------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/docs/copied-from-beats/outputs/console/docs/console.asciidoc b/docs/copied-from-beats/outputs/console/docs/console.asciidoc index 102eb13c7c8..71f03f0f740 100644 --- a/docs/copied-from-beats/outputs/console/docs/console.asciidoc +++ b/docs/copied-from-beats/outputs/console/docs/console.asciidoc @@ -7,6 +7,11 @@ The Console output writes events in JSON format to stdout. +To use this output, edit the {beatname_uc} configuration file to disable the {es} +output by commenting it out, and enable the console output by adding `output.console`. + +Example configuration: + [source,yaml] ------------------------------------------------------------------------------ output.console: @@ -15,7 +20,14 @@ output.console: ==== Configuration options -You can specify the following options in the `console` section of the +{beatname_lc}.yml+ config file: +You can specify the following `output.console` options in the +{beatname_lc}.yml+ config file: + +===== `enabled` + +The enabled config is a boolean setting to enable or disable the output. If set +to false, the output is disabled. + +The default value is `true`. ===== `pretty` @@ -27,14 +39,6 @@ Output codec configuration. If the `codec` section is missing, events will be js See <> for more information. - -===== `enabled` - -The enabled config is a boolean setting to enable or disable the output. If set -to false, the output is disabled. - -The default value is true. - ===== `bulk_max_size` The maximum number of events to buffer internally during publishing. The default is 2048.