csv

 

Synopsis

This plugin supports the following configuration options:

Required configuration options:

csv {
    fields => ...
    path => ...
}

Available configuration options:

Setting Input type Required Default value

codec

codec

No

"plain"

csv_options

hash

No

{}

fields

array

Yes

filename_failure

string

No

"_filepath_failures"

flush_interval

number

No

2

gzip

boolean

No

false

message_format

string

No

path

string

Yes

workers

number

No

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 on the Ruby CSV documentation page. 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

fields

  • This is a 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]"].

filename_failure

  • Value type is string
  • Default value is "_filepath_failures"

flush_interval

  • Value type is number
  • Default value is 2

gzip

  • Value type is boolean
  • Default value is false

message_format

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

path

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

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.