csvedit

 

Synopsisedit

This plugin supports the following configuration options:

Required configuration options:

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

Available configuration options:

Detailsedit

 

codecedit

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

create_if_deletededit

  • Value type is boolean
  • Default value is true

csv_optionsedit

  • 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

dir_modeedit

  • Value type is number
  • Default value is -1

fieldsedit

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

file_modeedit

  • Value type is number
  • Default value is -1

filename_failureedit

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

flush_intervaledit

  • Value type is number
  • Default value is 2

gzipedit

  • Value type is boolean
  • Default value is false

message_format (DEPRECATED)edit

  • DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
  • Value type is string
  • There is no default value for this setting.

pathedit

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

spreadsheet_safeedit

  • Value type is boolean
  • Default value is true

Option to not escape/munge string values. Please note turning off this option may not make the values safe in your spreadsheet application

workersedit

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