For other versions, see theVersioned plugin docs.
For questions about the plugin, open a topic in the Discuss forums. For bugs or feature requests, open an issue in Github.For the list of Elastic supported plugins, please consult the Elastic Support Matrix.
CSV output.
Write events to disk in CSV or other delimited formatBased on the file output, many config values are sharedUses the Ruby csv library internally
This plugin supports the following configuration options plus the Common Options described later.
| Setting | Input type | Required |
|---|---|---|
No |
||
No |
||
No |
||
Yes |
||
No |
||
No |
||
No |
||
No |
||
Yes |
||
No |
Also see Common Options for a list of options supported by alloutput plugins.
trueIf the configured file is deleted, but an event is handled by the plugin,the plugin will recreate the file. Default ⇒ true
{}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
-1Dir access mode to use. Note that due to the bug in jruby system umaskis ignored on linux: https://github.com/jruby/jruby/issues/3426Setting it to -1 uses default OS value.Example: "dir_mode" => 0750
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]"].
-1File access mode to use. Note that due to the bug in jruby system umaskis ignored on linux: https://github.com/jruby/jruby/issues/3426Setting it to -1 uses default OS value.Example: "file_mode" => 0640
"_filepath_failures"If the generated path is invalid, the events will be savedinto this file and inside the defined path.
2Flush interval (in seconds) for flushing writes to log files.0 will flush on every message.
This output writes events to files on disk. You can use fieldsfrom the event as parts of the filename and/or path.
By default, this output writes one event per line in json format.You can customise the line format using the line codec like
output { file { path => ... codec => line { format => "custom format: %{message}"} }}The path to the file to write. Event fields can be used here,like `/var/log/logstash/%{host}/%{application}`One may also utilize the path option for date-based logrotation via the joda time format. This will use the eventtimestamp.E.g.: `path => "./test-%{+YYYY-MM-dd}.txt"` to create`./test-2013-05-29.txt`
If you use an absolute path you cannot start with a dynamic string.E.g: /%{myfield}/, /test-%{myfield}/ are not valid paths
trueOption to not escape/munge string values. Please note turning off this optionmay not make the values safe in your spreadsheet application
The following configuration options are supported by all output plugins:
"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.
trueDisable or enable metric logging for this specific plugin instance.By default we record all the metrics we can, but you can disable metrics collectionfor a specific plugin.
Add a unique ID to the plugin configuration. If no ID is specified, Logstash will generate one.It is strongly recommended to set this ID in your configuration. This is particularly usefulwhen you have two or more plugins of the same type. For example, if you have 2 csv outputs.Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.
output { csv { id => "my_plugin_id" }}