[Reporting/Docs] Tighten the language around CSV settings (#163505)

## Summary

Docs request to tighten the language around csv.maxSizeBytes on this
[page](https://www.elastic.co/guide/en/kibana/8.8/reporting-settings-kb.html#reporting-csv-settings).

- [x] test the links

Closes: https://github.com/elastic/kibana/issues/159112
Replaces: https://github.com/elastic/kibana/pull/161189

---------

Co-authored-by: Amy Jonsson <amy.jonsson@elastic.co>
Co-authored-by: amyjtechwriter <61687663+amyjtechwriter@users.noreply.github.com>
This commit is contained in:
Tim Sullivan 2023-08-15 09:18:49 -07:00 committed by GitHub
parent 0651662159
commit 9da44e3571
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -203,26 +203,40 @@ The `file:` protocol is always denied, even if no network policy is configured.
==== CSV settings ==== CSV settings
[[xpack-reporting-csv]] `xpack.reporting.csv.maxSizeBytes` {ess-icon}:: [[xpack-reporting-csv]] `xpack.reporting.csv.maxSizeBytes` {ess-icon}::
The maximum {byte-units}[byte size] of a CSV file before being truncated. This setting exists to prevent large exports from causing performance and storage issues. Can be specified as number of bytes. Defaults to `10mb`. The maximum {byte-units}[byte size] of a CSV file before being truncated. This setting exists to prevent large
exports from causing performance and storage issues. Can be specified as number of bytes. Defaults to `250mb`.
[NOTE] [NOTE]
============ ============
Setting `xpack.reporting.csv.maxSizeBytes` much larger than the default 10 MB limit has the potential to negatively affect the We recommend using CSV reports to export moderate amounts of data only. The feature enables analysis of data in
performance of {kib} and your {es} cluster. There is no enforced maximum for this setting, but a reasonable maximum value depends external tools, but it's not intended for bulk export or to backup {es} data. If you need to export more than
on multiple factors: 250 MB of CSV, rather than increasing `xpack.reporting.csv.maxSizeBytes`, please use filters to create multiple
smaller reports, or extract the data you need directly from {es}.
* The `http.max_content_length` setting in {es}. The following deployment configurations may lead to failed report jobs or incomplete reports:
* 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>>. * Any shard needed for search is unavailable.
* Data is stored on slow storage tiers.
* Network latency between nodes is high.
* {ccs-cap} is used.
To export large amounts of data we recommend using {es} APIs directly. See {ref}/point-in-time-api.html[Point
in time API], or {ref}/sql-rest-format.html#_csv[SQL with CSV response data format].
============ ============
`xpack.reporting.csv.scroll.size`:: `xpack.reporting.csv.scroll.size`::
Number of documents retrieved from {es} for each scroll iteration during a CSV export. Defaults to `500`. Number of documents retrieved from {es} for each scroll iteration during a CSV export. Defaults to `500`.
[NOTE]
============
You may need to lower this setting if the default number of documents creates a strain on network resources.
============
`xpack.reporting.csv.scroll.duration`:: `xpack.reporting.csv.scroll.duration`::
Amount of {time-units}[time] allowed before {kib} cleans the scroll context during a CSV export. Defaults to `30s`. Amount of {time-units}[time] allowed before {kib} cleans the scroll context during a CSV export. Defaults to `30s`.
[NOTE]
============
If search latency in {es} is sufficiently high, such as if you are using {ccs}, you may need to increase the setting.
============
`xpack.reporting.csv.checkForFormulas`:: `xpack.reporting.csv.checkForFormulas`::
Enables a check that warns you when there's a potential formula included in the output (=, -, +, and @ chars). See OWASP: https://www.owasp.org/index.php/CSV_Injection. Defaults to `true`. Enables a check that warns you when there's a potential formula included in the output (=, -, +, and @ chars). See OWASP: https://www.owasp.org/index.php/CSV_Injection. Defaults to `true`.
@ -231,7 +245,11 @@ Enables a check that warns you when there's a potential formula included in the
Escape formula values in cells with a `'`. See OWASP: https://www.owasp.org/index.php/CSV_Injection. Defaults to `true`. Escape formula values in cells with a `'`. See OWASP: https://www.owasp.org/index.php/CSV_Injection. Defaults to `true`.
`xpack.reporting.csv.enablePanelActionDownload`:: `xpack.reporting.csv.enablePanelActionDownload`::
deprecated:[7.9.0,This setting has no effect.] Enables CSV export from a saved search on a dashboard. This action is available in the dashboard panel menu for the saved search. *NOTE*: This setting exists for backwards compatibility, but is unused and hardcoded to `true`. CSV export from a saved search on a dashboard is enabled when Reporting is enabled. deprecated:[7.9.0,This setting has no effect.] Enables CSV export from a saved search on a dashboard. This action is available in the dashboard panel menu for the saved search.
[NOTE]
============
This setting exists for backwards compatibility, and is hardcoded to `true`. CSV export from a saved search on a dashboard is enabled when Reporting is enabled.
============
`xpack.reporting.csv.useByteOrderMarkEncoding`:: `xpack.reporting.csv.useByteOrderMarkEncoding`::
Adds a byte order mark (`\ufeff`) at the beginning of the CSV file. Defaults to `false`. Adds a byte order mark (`\ufeff`) at the beginning of the CSV file. Defaults to `false`.