Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Merged
merged 4 commits into from
Oct 16, 2020
Merged

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

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4340a4e
[Reporting] Add contextual documentation for CSV Max Bytes setting
tsullivan Oct 15, 2020
744c833
Update reporting-settings.asciidoc
tsullivan Oct 15, 2020
2cd905e
updates per feedback
tsullivan Oct 16, 2020
2acdc34
Merge branch 'master' into reporting/docs/csv-limits
tsullivan Oct 16, 2020
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
20 changes: 19 additions & 1 deletion docs/settings/reporting-settings.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]]
Expand Down Expand Up @@ -65,7 +66,7 @@ proxy host requires that the {kib} server has network access to the proxy.

[NOTE]
============
Reporting authenticates requests on the Kibana page only when the hostname matches the
Reporting authenticates requests on the {kib} page only when the hostname matches the
<<xpack-kibanaServer-hostname, `xpack.reporting.kibanaServer.hostname`>> setting. Therefore Reporting would fail if the
set value redirects to another server. For that reason, `"0"` is an invalid setting
because, in the Reporting browser, it becomes an automatic redirect to `"0.0.0.0"`.
Expand Down Expand Up @@ -214,6 +215,23 @@ a| `xpack.reporting.capture.browser`
| The maximum {ref}/common-options.html#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`.
|===

[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
Expand Down