Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 17 additions & 17 deletions docs/plugins/outputs/csv.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v3.0.10
:release_date: 2023-12-19
:changelog_url: https://github.com/logstash-plugins/logstash-output-csv/blob/v3.0.10/CHANGELOG.md
:include_path: ../include
:version: v3.0.11
:release_date: 2025-10-10
:changelog_url: https://github.com/logstash-plugins/logstash-output-csv/blob/v3.0.11/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
Expand Down Expand Up @@ -54,16 +54,16 @@ output plugins.
 

[id="plugins-{type}s-{plugin}-create_if_deleted"]
===== `create_if_deleted`
===== `create_if_deleted`

* Value type is <<boolean,boolean>>
* Default value is `true`

If the configured file is deleted, but an event is handled by the plugin,
If the configured file is deleted, but an event is handled by the plugin,
the plugin will recreate the file. Default => true

[id="plugins-{type}s-{plugin}-csv_options"]
===== `csv_options`
===== `csv_options`

* Value type is <<hash,hash>>
* Default value is `{}`
Expand All @@ -73,7 +73,7 @@ Full documentation is available on the http://ruby-doc.org/stdlib-2.0.0/libdoc/c
A typical use case would be to use alternative column or row separators eg: `csv_options => {"col_sep" => "\t" "row_sep" => "\r\n"}` gives tab separated data with windows line endings

[id="plugins-{type}s-{plugin}-dir_mode"]
===== `dir_mode`
===== `dir_mode`

* Value type is <<number,number>>
* Default value is `-1`
Expand All @@ -84,7 +84,7 @@ Setting it to -1 uses default OS value.
Example: `"dir_mode" => 0750`

[id="plugins-{type}s-{plugin}-fields"]
===== `fields`
===== `fields`

* This is a required setting.
* Value type is <<array,array>>
Expand All @@ -96,7 +96,7 @@ If a field does not exist on the event, an empty string will be written.
Supports field reference syntax eg: `fields => ["field1", "[nested][field]"]`.

[id="plugins-{type}s-{plugin}-file_mode"]
===== `file_mode`
===== `file_mode`

* Value type is <<number,number>>
* Default value is `-1`
Expand All @@ -107,7 +107,7 @@ Setting it to -1 uses default OS value.
Example: `"file_mode" => 0640`

[id="plugins-{type}s-{plugin}-filename_failure"]
===== `filename_failure`
===== `filename_failure`

* Value type is <<string,string>>
* Default value is `"_filepath_failures"`
Expand All @@ -116,7 +116,7 @@ If the generated path is invalid, the events will be saved
into this file and inside the defined path.

[id="plugins-{type}s-{plugin}-flush_interval"]
===== `flush_interval`
===== `flush_interval`

* Value type is <<number,number>>
* Default value is `2`
Expand All @@ -125,15 +125,15 @@ Flush interval (in seconds) for flushing writes to log files.
0 will flush on every message.

[id="plugins-{type}s-{plugin}-gzip"]
===== `gzip`
===== `gzip`

* Value type is <<boolean,boolean>>
* Default value is `false`

Gzip the output stream before writing to disk.

[id="plugins-{type}s-{plugin}-path"]
===== `path`
===== `path`

* This is a required setting.
* Value type is <<string,string>>
Expand All @@ -148,7 +148,7 @@ You can customise the line format using the `line` codec like:
[source,ruby]
-----
output {
file {
csv {
path => ...
codec => line { format => "custom format: %{message}"}
}
Expand All @@ -167,7 +167,7 @@ If you use an absolute path you cannot start with a dynamic string.
E.g: `/%{myfield}/`, `/test-%{myfield}/` are not valid paths

[id="plugins-{type}s-{plugin}-spreadsheet_safe"]
===== `spreadsheet_safe`
===== `spreadsheet_safe`

* Value type is <<boolean,boolean>>
* Default value is `true`
Expand All @@ -181,4 +181,4 @@ may not make the values safe in your spreadsheet application
include::{include_path}/{type}.asciidoc[]


:default_codec!:
:default_codec!: