Back to Beats

Configure the Console output [console-output]

docs/reference/metricbeat/console-output.md

9.4.01.9 KB
Original Source

Configure the Console output [console-output]

The Console output writes events in JSON format to stdout.

::::{warning} The Console output should be used only for debugging issues as it can produce a large amount of logging data. ::::

To use this output, edit the Metricbeat configuration file to disable the {{es}} output by commenting it out, and enable the console output by adding output.console.

Example configuration:

yaml
output.console:
  pretty: true

Configuration options [_configuration_options_7]

You can specify the following output.console options in the metricbeat.yml config file:

enabled [_enabled_7]

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 [_pretty]

If pretty is set to true, events written to stdout will be nicely formatted. The default is false.

codec [_codec_4]

Output codec configuration. If the codec section is missing, events will be json encoded using the pretty option.

See Change the output codec for more information.

bulk_max_size [_bulk_max_size_4]

The maximum number of events to buffer internally during publishing. The default is 2048.

Specifying a larger batch size may add some latency and buffering during publishing. However, for Console output, this setting does not affect how events are published.

Setting bulk_max_size to values less than or equal to 0 disables the splitting of batches. When splitting is disabled, the queue decides on the number of events to be contained in a batch.

queue [_queue_6]

Configuration options for internal queue.

See Internal queue for more information.

Note:queue options can be set under metricbeat.yml or the output section but not both.