github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 17:59:23 -04:00
Code Issues Projects Releases Packages Wiki Activity

[8.16] [Reporting/CSV/Docs] Specify maximum value for scroll.duration setting (#205765) (#205774)

Browse source 
# Backport

This will backport the following commits from `main` to `8.16`:
- [[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>
This commit is contained in:
Kibana Machine 2025-01-08 03:09:21 +11:00 • committed by GitHub
parent 1fd0eb1205
commit f9cf378727
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 1 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/settings/reporting-settings.asciidoc
View file

@ -271,7 +271,7 @@ The maximum {byte-units}[byte size] of a CSV file before being truncated. This s
exports from causing performance and storage issues. Can be specified as a number of bytes. Defaults to `250mb`.
`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.