csv

Milestone: 1

Synopsis

This is what it might look like in your config file:

output {
  csv {
    codec => ... # codec (optional), default: "plain"
    csv_options => ... # hash (optional), default: {}
    fields => ... # array (required)
    flush_interval => ... # number (optional), default: 2
    gzip => ... # boolean (optional), default: false
    max_size => ... # string (optional)
    message_format => ... # string (optional)
    path => ... # string (required)
    workers => ... # number (optional), default: 1
  }
}

Details

codec

• 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.

csv_options

• Value type is hash
• Default value is {}

Options for CSV output. This is passed directly to the Ruby stdlib to_csv function. Full documentation is available here: [http://ruby-doc.org/stdlib-2.0.0/libdoc/csv/rdoc/index.html]. A typical use case would be to use alternative column or row seperators eg: csv_options => {"col_sep" => "\t" "row_sep" => "\r\n"} gives tab seperated data with windows line endings

exclude_tags DEPRECATED

• DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
• Value type is array
• Default value is []

Only handle events without any of these tags. Note this check is additional to type and tags.

fields (required setting)

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

The field names from the event that should be written to the CSV file. Fields are written to the CSV in the same order as the array. If a field does not exist on the event, an empty string will be written. Supports field reference syntax eg: fields => ["field1", "[nested][field]"].

flush_interval

• Value type is number
• Default value is 2

gzip

• Value type is boolean
• Default value is false

max_size

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

message_format

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

path (required setting)

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

tags DEPRECATED

• DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
• Value type is array
• Default value is []

Only handle events with all of these tags. Note that if you specify a type, the event must also match that type. Optional.

type DEPRECATED

• DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
• Value type is string
• Default value is ""

The type to act on. If a type is given, then this output will only act on messages with the same type. See any input plugin’s “type” attribute for more. Optional.

workers

• Value type is number
• Default value is 1

The number of workers to use for this output. Note that this setting may not be useful for all outputs.

---

This is documentation from lib/logstash/outputs/csv.rb