csvedit
- Version: 3.0.2
- Released on: 2016-07-14
- Changelog
- Compatible: 5.1.1.1, 5.0.0, 2.4.1, 2.4.0, 2.3.4
CSV output.
Write events to disk in CSV or other delimited format Based on the file output, many config values are shared Uses the Ruby csv library internally
Synopsisedit
This plugin supports the following configuration options:
Required configuration options:
csv {
fields => ...
path => ...
}
Available configuration options:
| Setting | Input type | Required | Default value |
|---|---|---|---|
No |
|
||
No |
|
||
No |
|
||
No |
|
||
No |
|
||
Yes |
|||
No |
|
||
No |
|
||
No |
|
||
No |
|
||
No |
|||
Yes |
|||
No |
|
||
<<,>> |
No |
|
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
If the configured file is deleted, but an event is handled by the plugin, the plugin will recreate the file. Default ⇒ 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
Dir access mode to use. Note that due to the bug in jruby system umask
is ignored on linux: https://github.com/jruby/jruby/issues/3426
Setting it to -1 uses default OS value.
Example: "dir_mode" => 0750
enable_metricedit
- Value type is boolean
-
Default value is
true
Disable or enable metric logging for this specific plugin instance by default we record all the metrics we can, but you can disable metrics collection for a specific plugin.
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
File access mode to use. Note that due to the bug in jruby system umask
is ignored on linux: https://github.com/jruby/jruby/issues/3426
Setting it to -1 uses default OS value.
Example: "file_mode" => 0640
filename_failureedit
- Value type is string
-
Default value is
"_filepath_failures"
If the generated path is invalid, the events will be saved into this file and inside the defined path.
flush_intervaledit
- Value type is number
-
Default value is
2
Flush interval (in seconds) for flushing writes to log files. 0 will flush on every message.
gzipedit
- Value type is boolean
-
Default value is
false
Gzip the output stream before writing to disk.
idedit
- Value type is string
- There is no default value for this setting.
Add a unique ID to the plugin instance, this ID is used for tracking
information for a specific configuration of the plugin.
output {
stdout {
id => "ABC"
}
}
If you don’t explicitely set this variable Logstash will generate a unique name.
pathedit
- This is a required setting.
- Value type is string
- There is no default value for this setting.
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 log
rotation via the joda time format. This will use the event
timestamp.
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