Skip to content

Commit

Permalink
[DOCS] CSV reports limitations (#179225)
Browse files Browse the repository at this point in the history
Adding CSV limitations section and seeing if we can backport into 7.17x
versions. It is a copy of #175208
which has been merged into 8.13. Let's see if this works 🤞
<img width="1184" alt="Screenshot 2024-03-22 at 09 24 50"
src="https://github.com/elastic/kibana/assets/61687663/329b89a3-ec36-4dea-9983-b8ef441d0f2f">

---------

Co-authored-by: Kibana Machine <[email protected]>
  • Loading branch information
amyjtechwriter and kibanamachine authored Mar 22, 2024
1 parent 6d47e53 commit 224d0c9
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/user/reporting/index.asciidoc
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* &mdash; 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
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.

0 comments on commit 224d0c9

Please sign in to comment.