From e04512bc1dc6d0e603a03a386e58bb97be46f544 Mon Sep 17 00:00:00 2001 From: Brandon Morelli Date: Wed, 8 Jan 2020 17:00:23 -0800 Subject: [PATCH] [docs] Fix ambiguous *.output documentation (#3093) --- .../outputs/console/docs/console.asciidoc | 22 +++++++++------- .../outputs/fileout/docs/fileout.asciidoc | 9 +++++-- .../outputs/kafka/docs/kafka.asciidoc | 13 ++++++++-- .../outputs/logstash/docs/logstash.asciidoc | 7 +++++- .../outputs/redis/docs/redis.asciidoc | 25 ++++--------------- 5 files changed, 42 insertions(+), 34 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. diff --git a/docs/copied-from-beats/outputs/fileout/docs/fileout.asciidoc b/docs/copied-from-beats/outputs/fileout/docs/fileout.asciidoc index aa0af27bb66..6922f8f7142 100644 --- a/docs/copied-from-beats/outputs/fileout/docs/fileout.asciidoc +++ b/docs/copied-from-beats/outputs/fileout/docs/fileout.asciidoc @@ -9,6 +9,11 @@ The File output dumps the transactions into a file where each transaction is in Currently, this output is used for testing, but it can be used as input for Logstash. +To use this output, edit the {beatname_uc} configuration file to disable the {es} +output by commenting it out, and enable the file output by adding `output.file`. + +Example configuration: + ["source","yaml",subs="attributes"] ------------------------------------------------------------------------------ output.file: @@ -21,14 +26,14 @@ output.file: ==== Configuration options -You can specify the following options in the `file` section of the +{beatname_lc}.yml+ config file: +You can specify the following `output.file` 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. +The default value is `true`. [[path]] ===== `path` diff --git a/docs/copied-from-beats/outputs/kafka/docs/kafka.asciidoc b/docs/copied-from-beats/outputs/kafka/docs/kafka.asciidoc index ce09e019ad8..48e79a4fd51 100644 --- a/docs/copied-from-beats/outputs/kafka/docs/kafka.asciidoc +++ b/docs/copied-from-beats/outputs/kafka/docs/kafka.asciidoc @@ -5,7 +5,11 @@ Kafka ++++ -The Kafka output sends the events to Apache Kafka. +The Kafka output sends events to Apache Kafka. + +To use this output, edit the {beatname_uc} configuration file to disable the {es} +output by commenting it out, and enable the Kafka output by uncommenting the +Kafka section. Example configuration: @@ -42,7 +46,12 @@ You can specify the following options in the `kafka` section of the +{beatname_l 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. +ifndef::apm-server[] +The default value is `true`. +endif::[] +ifdef::apm-server[] +The default value is `false`. +endif::[] ===== `hosts` diff --git a/docs/copied-from-beats/outputs/logstash/docs/logstash.asciidoc b/docs/copied-from-beats/outputs/logstash/docs/logstash.asciidoc index f13faa517ad..f0376af44cf 100644 --- a/docs/copied-from-beats/outputs/logstash/docs/logstash.asciidoc +++ b/docs/copied-from-beats/outputs/logstash/docs/logstash.asciidoc @@ -24,7 +24,7 @@ the {stack} getting started tutorial. Also see the documentation for the If you want to use {ls} to perform additional processing on the data collected by {beatname_uc}, you need to configure {beatname_uc} to use {ls}. -To do this, you edit the {beatname_uc} configuration file to disable the {es} +To do this, edit the {beatname_uc} configuration file to disable the {es} output by commenting it out and enable the {ls} output by uncommenting the logstash section: @@ -224,7 +224,12 @@ You can specify the following options in the `logstash` section of the The enabled config is a boolean setting to enable or disable the output. If set to false, the output is disabled. +ifndef::apm-server[] The default value is `true`. +endif::[] +ifdef::apm-server[] +The default value is `false`. +endif::[] [[hosts]] ===== `hosts` diff --git a/docs/copied-from-beats/outputs/redis/docs/redis.asciidoc b/docs/copied-from-beats/outputs/redis/docs/redis.asciidoc index 0d7dde88bfc..e5fdd29eb6b 100644 --- a/docs/copied-from-beats/outputs/redis/docs/redis.asciidoc +++ b/docs/copied-from-beats/outputs/redis/docs/redis.asciidoc @@ -11,6 +11,9 @@ The Redis output inserts the events into a Redis list or a Redis channel. This output plugin is compatible with the https://www.elastic.co/guide/en/logstash/current/plugins-inputs-redis.html[Redis input plugin] for Logstash. +To use this output, edit the {beatname_uc} configuration file to disable the {es} +output by commenting it out, and enable the Redis output by adding `output.redis`. + Example configuration: ["source","yaml",subs="attributes"] @@ -29,14 +32,14 @@ This output works with Redis 3.2.4. ==== Configuration options -You can specify the following options in the `redis` section of the +{beatname_lc}.yml+ config file: +You can specify the following `output.redis` 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. +The default value is `true`. ===== `hosts` @@ -143,24 +146,6 @@ Output codec configuration. If the `codec` section is missing, events will be js See <> for more information. -===== `host_topology` - -deprecated:[5.0.0] - -The Redis host to connect to when using topology map support. Topology map support is disabled if this option is not set. - -===== `password_topology` - -deprecated:[5.0.0] - -The password to use for authenticating with the Redis topology server. The default is no authentication. - -===== `db_topology` - -deprecated:[5.0.0] - -The Redis database number where the topology information is stored. The default is 1. - ===== `worker` The number of workers to use for each host configured to publish events to Redis. Use this setting along with the