:plugin: stdout
:type: output

///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: %VERSION%
:release_date: %RELEASE_DATE%
:changelog_url: %CHANGELOG_URL%
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////

[id="plugins-{type}-{plugin}"]

=== Stdout output plugin

include::{include_path}/plugin_header.asciidoc[]

==== Description

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.
[source,ruby]
    output {
      stdout {}
    }

Useful codecs include:

`rubydebug`: outputs event data using the ruby "awesome_print"
http://rubygems.org/gems/awesome_print[library]

[source,ruby]
    output {
      stdout { codec => rubydebug }
    }

`json`: outputs event data in structured JSON format
[source,ruby]
    output {
      stdout { codec => json }
    }


[id="plugins-{type}s-{plugin}-options"]
==== Stdout Output Configuration Options

This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> described later.

[cols="<,<,<",options="header",]
|=======================================================================
|Setting |Input type|Required
|=======================================================================

[id="plugins-{type}s-{plugin}-common-options"]
include::{include_path}/{type}.asciidoc[]