From fade05677b17275bf5287b0f13254c785250b391 Mon Sep 17 00:00:00 2001
From: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Date: Wed, 8 Jan 2025 03:06:54 +1100
Subject: [PATCH] [8.14] [Reporting/CSV/Docs] Specify maximum value for
 scroll.duration setting (#205765) (#205772)

# Backport

This will backport the following commits from `main` to `8.14`:
- [[Reporting/CSV/Docs] Specify maximum value for scroll.duration
setting (#205765)](https://github.com/elastic/kibana/pull/205765)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Tim
Sullivan","email":"tsullivan@users.noreply.github.com"},"sourceCommit":{"committedDate":"2025-01-07T15:36:41Z","message":"[Reporting/CSV/Docs]
Specify maximum value for scroll.duration setting (#205765)\n\n##
Summary\r\n\r\nUpdates Reporting CSV export documentation to specify
there is a maximum\r\nvalue for `xpack.reporting.csv.scroll.size`, which
is
10000.","sha":"c3c6bfba08eab59c08095e86ae35b621deb06242","branchLabelMapping":{"^v9.0.0$":"main","^v8.18.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","v8.13.0","v8.14.0","v8.15.0","v8.16.0","backport:version","v8.17.0","v8.18.0"],"title":"[Reporting/CSV/Docs]
Specify maximum value for scroll.duration
setting","number":205765,"url":"https://github.com/elastic/kibana/pull/205765","mergeCommit":{"message":"[Reporting/CSV/Docs]
Specify maximum value for scroll.duration setting (#205765)\n\n##
Summary\r\n\r\nUpdates Reporting CSV export documentation to specify
there is a maximum\r\nvalue for `xpack.reporting.csv.scroll.size`, which
is
10000.","sha":"c3c6bfba08eab59c08095e86ae35b621deb06242"}},"sourceBranch":"main","suggestedTargetBranches":["8.13","8.14","8.15","8.16","8.17","8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/205765","number":205765,"mergeCommit":{"message":"[Reporting/CSV/Docs]
Specify maximum value for scroll.duration setting (#205765)\n\n##
Summary\r\n\r\nUpdates Reporting CSV export documentation to specify
there is a maximum\r\nvalue for `xpack.reporting.csv.scroll.size`, which
is
10000.","sha":"c3c6bfba08eab59c08095e86ae35b621deb06242"}},{"branch":"8.13","label":"v8.13.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.14","label":"v8.14.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.15","label":"v8.15.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.16","label":"v8.16.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.17","label":"v8.17.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.x","label":"v8.18.0","branchLabelMappingKey":"^v8.18.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Tim Sullivan <tsullivan@users.noreply.github.com>
---
 docs/settings/reporting-settings.asciidoc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/settings/reporting-settings.asciidoc b/docs/settings/reporting-settings.asciidoc
index 3a3c811209145..6aada7752ac67 100644
--- a/docs/settings/reporting-settings.asciidoc
+++ b/docs/settings/reporting-settings.asciidoc
@@ -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.