stdout

edit
  • Version: 3.1.0
  • Released on: 2016-08-22
  • Changelog
  • Compatible: 5.1.1.1, 5.0.0, 2.4.1, 2.4.0, 2.3.4

A simple output which prints to the STDOUT of the shell running Logstash. This output can be quite convenient when debugging plugin configurations, by allowing instant access to the event data after it has passed through the inputs and filters.

For example, the following output configuration, in conjunction with the Logstash -e command-line flag, will allow you to see the results of your event pipeline for quick iteration.

    output {
      stdout {}
    }

Useful codecs include:

rubydebug: outputs event data using the ruby "awesome_print" library

    output {
      stdout { codec => rubydebug }
    }

json: outputs event data in structured JSON format

    output {
      stdout { codec => json }
    }

 

Synopsis

edit

This plugin supports the following configuration options:

Required configuration options:

stdout {
}

Available configuration options:

Setting Input type Required Default value

codec

codec

No

"plain"

enable_metric

boolean

No

true

id

string

No

workers

<<,>>

No

1

Details

edit

 

codec

edit
  • Value type is codec
  • Default value is "plain"

The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output, without needing a separate filter in your Logstash pipeline.

enable_metric

edit
  • Value type is boolean
  • Default value is true

Disable or enable metric logging for this specific plugin instance by default we record all the metrics we can, but you can disable metrics collection for a specific plugin.

  • Value type is string
  • There is no default value for this setting.

Add a unique ID to the plugin instance, this ID is used for tracking information for a specific configuration of the plugin.

output {
 stdout {
   id => "ABC"
 }
}

If you don’t explicitely set this variable Logstash will generate a unique name.

workers

edit
  • Value type is string
  • Default value is 1

TODO remove this in Logstash 6.0 when we no longer support the :legacy type This is hacky, but it can only be herne