github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-06-27 18:51:07 -04:00
Code Issues Projects Releases Packages Wiki Activity

[DOCS] CSV reports limitations (#179225)

Browse source 
Adding CSV limitations section and seeing if we can backport into 7.17x
versions. It is a copy of https://github.com/elastic/kibana/pull/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="329b89a3-ec36-4dea-9983-b8ef441d0f2f">

---------

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
This commit is contained in:
amyjtechwriter 2024-03-22 15:53:07 +00:00 • committed by GitHub
parent 6d47e532a6
commit 224d0c91b2
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 17 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/user/reporting/index.asciidoc
View file

@ -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]. * *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. * *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. * *Permalinks* &mdash; Share a direct link to a *Discover* saved search, dashboard, or visualization.
@ -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} more about {ilm-init} policies, refer to the {es}
{ref}/index-lifecycle-management.html[{ilm-init} documentation]. {ref}/index-lifecycle-management.html[{ilm-init} documentation].
[float]
[[csv-limitations]]
=== CSV reports limitations
include::reporting-csv-limitations.asciidoc[]
[float] [float]
[[share-a-direct-link]] [[share-a-direct-link]]
== Share a direct link == Share a direct link

9
docs/user/reporting/reporting-csv-limitations.asciidoc Normal file
View file

@ -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.