Skip to content

Commit

Permalink
[Reporting/CSV/Docs] Specify maximum value for scroll.duration setting (
Browse files Browse the repository at this point in the history
elastic#205765)

## Summary

Updates Reporting CSV export documentation to specify there is a maximum
value for `xpack.reporting.csv.scroll.size`, which is 10000.

(cherry picked from commit c3c6bfb)
  • Loading branch information
tsullivan committed Jan 7, 2025
1 parent 31b74b6 commit a4b20f6
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/settings/reporting-settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ in time API], or {ref}/sql-rest-format.html#_csv[SQL with CSV response data form
============

`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. The maximum value is `10000`. Defaults to `500`.
[NOTE]
============
You may need to lower this setting if the default number of documents creates a strain on network resources.
Expand Down

0 comments on commit a4b20f6

Please sign in to comment.