Skip to content

Commit 1bf4775

Browse files
updated docs for 9.1 (#1935)
1 parent 6bd8dfa commit 1bf4775

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

docs/plugins/outputs/csv.asciidoc

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@
66
///////////////////////////////////////////
77
START - GENERATED VARIABLES, DO NOT EDIT!
88
///////////////////////////////////////////
9-
:version: v3.0.10
10-
:release_date: 2023-12-19
11-
:changelog_url: https://github.com/logstash-plugins/logstash-output-csv/blob/v3.0.10/CHANGELOG.md
12-
:include_path: ../include
9+
:version: v3.0.11
10+
:release_date: 2025-10-10
11+
:changelog_url: https://github.com/logstash-plugins/logstash-output-csv/blob/v3.0.11/CHANGELOG.md
12+
:include_path: ../../../../logstash/docs/include
1313
///////////////////////////////////////////
1414
END - GENERATED VARIABLES, DO NOT EDIT!
1515
///////////////////////////////////////////
@@ -54,16 +54,16 @@ output plugins.
5454
 
5555

5656
[id="plugins-{type}s-{plugin}-create_if_deleted"]
57-
===== `create_if_deleted`
57+
===== `create_if_deleted`
5858

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

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

6565
[id="plugins-{type}s-{plugin}-csv_options"]
66-
===== `csv_options`
66+
===== `csv_options`
6767

6868
* Value type is <<hash,hash>>
6969
* Default value is `{}`
@@ -73,7 +73,7 @@ Full documentation is available on the http://ruby-doc.org/stdlib-2.0.0/libdoc/c
7373
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
7474

7575
[id="plugins-{type}s-{plugin}-dir_mode"]
76-
===== `dir_mode`
76+
===== `dir_mode`
7777

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

8686
[id="plugins-{type}s-{plugin}-fields"]
87-
===== `fields`
87+
===== `fields`
8888

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

9898
[id="plugins-{type}s-{plugin}-file_mode"]
99-
===== `file_mode`
99+
===== `file_mode`
100100

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

109109
[id="plugins-{type}s-{plugin}-filename_failure"]
110-
===== `filename_failure`
110+
===== `filename_failure`
111111

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

118118
[id="plugins-{type}s-{plugin}-flush_interval"]
119-
===== `flush_interval`
119+
===== `flush_interval`
120120

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

127127
[id="plugins-{type}s-{plugin}-gzip"]
128-
===== `gzip`
128+
===== `gzip`
129129

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

133133
Gzip the output stream before writing to disk.
134134

135135
[id="plugins-{type}s-{plugin}-path"]
136-
===== `path`
136+
===== `path`
137137

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

169169
[id="plugins-{type}s-{plugin}-spreadsheet_safe"]
170-
===== `spreadsheet_safe`
170+
===== `spreadsheet_safe`
171171

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

183183

184-
:default_codec!:
184+
:default_codec!:

0 commit comments

Comments
 (0)