Skip to content

Commit bf90405

Browse files
authored
[Reporting] Add contextual documentation for CSV Max Bytes setting (#80782) (#80883)
* [Reporting] Add contextual documentation for CSV Max Bytes setting * Update reporting-settings.asciidoc * updates per feedback
1 parent 7934ccc commit bf90405

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

docs/settings/reporting-settings.asciidoc

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ You can configure `xpack.reporting` settings in your `kibana.yml` to:
1010
* <<reporting-kibana-server-settings,Control how the {report-features} communicate with the {kib} server>>
1111
* <<reporting-job-queue-settings,Manage background jobs>>
1212
* <<reporting-capture-settings,Capture screenshots>>
13+
* <<reporting-csv-settings,Increase the byte limit for CSV exports>>
1314

1415
[float]
1516
[[general-reporting-settings]]
@@ -65,7 +66,7 @@ proxy host requires that the {kib} server has network access to the proxy.
6566

6667
[NOTE]
6768
============
68-
Reporting authenticates requests on the Kibana page only when the hostname matches the
69+
Reporting authenticates requests on the {kib} page only when the hostname matches the
6970
<<xpack-kibanaServer-hostname, `xpack.reporting.kibanaServer.hostname`>> setting. Therefore Reporting would fail if the
7071
set value redirects to another server. For that reason, `"0"` is an invalid setting
7172
because, in the Reporting browser, it becomes an automatic redirect to `"0.0.0.0"`.
@@ -214,6 +215,23 @@ a| `xpack.reporting.capture.browser`
214215
| The maximum {ref}/common-options.html#byte-units[byte size] of a CSV file before being truncated. This setting exists to
215216
prevent large exports from causing performance and storage issues. Can be specified as number of bytes.
216217
Defaults to `10mb`.
218+
|===
219+
220+
[NOTE]
221+
============
222+
Setting `xpack.reporting.csv.maxSizeBytes` much larger than the default 10 MB limit has the potential to negatively affect the
223+
performance of {kib} and your {es} cluster. There is no enforced maximum for this setting, but a reasonable maximum value depends
224+
on multiple factors:
225+
226+
* The `http.max_content_length` setting in {es}.
227+
* Network proxies, which are often configured by default to block large requests with a 413 error.
228+
* The amount of memory available to the {kib} server, which limits the size of CSV data that must be held temporarily.
229+
230+
For information about {kib} memory limits, see <<production, using {kib} in a production environment>>.
231+
============
232+
233+
[cols="2*<"]
234+
|===
217235

218236
| `xpack.reporting.csv.scroll.size`
219237
| Number of documents retrieved from {es} for each scroll iteration during a CSV

0 commit comments

Comments
 (0)