[Reporting] Add contextual documentation for CSV Max Bytes setting (#…

…80782) (#80890) (#80901) * [Reporting] Add contextual documentation for CSV Max Bytes setting * Update reporting-settings.asciidoc * updates per feedback # Conflicts: # docs/settings/reporting-settings.asciidoc
elastic · Oct 16, 2020 · 82dac17 · 82dac17
1 parent 3b2e47c
commit 82dac17
Showing 1 changed file with 19 additions and 2 deletions.
diff --git a/docs/settings/reporting-settings.asciidoc b/docs/settings/reporting-settings.asciidoc
@@ -10,6 +10,7 @@ You can configure `xpack.reporting` settings in your `kibana.yml` to:
 * <<reporting-kibana-server-settings,Control how the {report-features} communicate with the {kib} server>>
 * <<reporting-job-queue-settings,Manage background jobs>>
 * <<reporting-capture-settings,Capture screenshots>>
+* <<reporting-csv-settings,Increase the byte limit for CSV exports>>
 
 [float]
 [[general-reporting-settings]]
@@ -63,7 +64,6 @@ proxy host requires that the {kib} server has network access to the proxy.
 
 |===
 
-
 [float]
 [[reporting-job-queue-settings]]
 ==== Background job settings
@@ -168,7 +168,24 @@ When `xpack.reporting.capture.browser.type` is set to `chromium` (default) you c
 | [[xpack-reporting-csv]] `xpack.reporting.csv.maxSizeBytes`
   | The maximum size of a CSV file before being truncated. This setting exists to prevent
   large exports from causing performance and storage issues.
-  Defaults to `10485760` (10mB).
+  Defaults to `10485760` (10 MB).
+|===
+
+[NOTE]
+============
+Setting `xpack.reporting.csv.maxSizeBytes` much larger than the default 10 MB limit has the potential to negatively affect the
+performance of {kib} and your {es} cluster. There is no enforced maximum for this setting, but a reasonable maximum value depends
+on multiple factors:
+
+* The `http.max_content_length` setting in {es}.
+* Network proxies, which are often configured by default to block large requests with a 413 error.
+* The amount of memory available to the {kib} server, which limits the size of CSV data that must be held temporarily.
+
+For information about {kib} memory limits, see <<production, using {kib} in a production environment>>.
+============
+
+[cols="2*<"]
+|===
 
 | `xpack.reporting.csv.scroll.size`
   | Number of documents retrieved from {es} for each scroll iteration during a CSV