Skip to content

Commit

Permalink
docs: updates to output config (#15272)
Browse files Browse the repository at this point in the history
  • Loading branch information
bmorelli25 authored Jan 14, 2020
1 parent bf8cb74 commit 8bf06e3
Show file tree
Hide file tree
Showing 5 changed files with 42 additions and 34 deletions.
22 changes: 13 additions & 9 deletions libbeat/outputs/console/docs/console.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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`

Expand All @@ -27,14 +39,6 @@ Output codec configuration. If the `codec` section is missing, events will be js

See <<configuration-output-codec>> 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.
Expand Down
9 changes: 7 additions & 2 deletions libbeat/outputs/fileout/docs/fileout.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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`
Expand Down
13 changes: 11 additions & 2 deletions libbeat/outputs/kafka/docs/kafka.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,11 @@
<titleabbrev>Kafka</titleabbrev>
++++

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:

Expand Down Expand Up @@ -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`

Expand Down
7 changes: 6 additions & 1 deletion libbeat/outputs/logstash/docs/logstash.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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`
Expand Down
25 changes: 5 additions & 20 deletions libbeat/outputs/redis/docs/redis.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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"]
Expand All @@ -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`

Expand Down Expand Up @@ -143,24 +146,6 @@ Output codec configuration. If the `codec` section is missing, events will be js

See <<configuration-output-codec>> 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
Expand Down

0 comments on commit 8bf06e3

Please sign in to comment.