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

[DOCS] CSV reports limitations #179225

Merged
merged 6 commits into from
Mar 22, 2024
Merged

[DOCS] CSV reports limitations #179225

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
63fb284
Adding CSV limitations section and going to try backport to 7.17.x
amyjtechwriter Mar 22, 2024
31d6f84
Merge branch '7.17' into csv-reports-limitations
kibanamachine Mar 22, 2024
4b9a1ea
broken link fix, I hope
amyjtechwriter Mar 22, 2024
9a03493
Merge branch 'csv-reports-limitations' of github.com:amyjtechwriter/k…
amyjtechwriter Mar 22, 2024
dcce617
Update docs/user/reporting/reporting-csv-limitations.asciidoc
amyjtechwriter Mar 22, 2024
1aed1c3
Update docs/user/reporting/reporting-csv-limitations.asciidoc
amyjtechwriter Mar 22, 2024
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
8 changes: 8 additions & 0 deletions docs/user/reporting/index.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ You access the options from the *Share* menu in the toolbar. The sharing options

* *PNG Reports* — Generate and download a PNG file of a dashboard or visualization. PNG reports are a link:https://www.elastic.co/subscriptions[subscription feature].

* *CSV Reports* &mdash; Generate and download CSV files of saved searches. <<csv-limitations,Certain limitations apply>>.

* *CSV Reports* &mdash; Generate and download a CSV file of a *Discover* saved search.

* *Permalinks* &mdash; Share a direct link to a *Discover* saved search, dashboard, or visualization.
Expand Down Expand Up @@ -72,6 +74,12 @@ NOTE: Reports are stored in {es} and managed by the `kibana-reporting` {ilm}
more about {ilm-init} policies, refer to the {es}
{ref}/index-lifecycle-management.html[{ilm-init} documentation].

[float]
[[csv-limitations]]
=== CSV reports limitations

include::reporting-csv-limitations.asciidoc[]

[float]
[[share-a-direct-link]]
== Share a direct link
Expand Down
9 changes: 9 additions & 0 deletions docs/user/reporting/reporting-csv-limitations.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
We recommend using CSV reports to export moderate amounts of data only. The feature enables analysis of data in external tools, but it is not intended for bulk export or to backup Elasticsearch data. Report timeout and incomplete data issues are likely if you are exporting data where:

- More than 250 MB of data is being exported
- Data is stored on slow storage tiers
- Any shard needed for the search is unavailable
- Network latency between nodes is high
- Cross-cluster search is used

To work around the limitations, use filters to create multiple smaller reports, or extract the data you need directly with the Elasticsearch APIs. See {ref}/scroll-api.html[Scroll API], {ref}/point-in-time-api.html[Point in time API], or {ref}/sql-rest-format.html#_csv[SQL] with CSV response data format. <<reporting-settings-kb, Reporting parameters>> can be adjusted to overcome some of these limiting scenarios. Results are dependent on data size, availability, and latency factors and are not guaranteed.