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.

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] Clarifying CSV limitations #175208

Merged
merged 3 commits into from
Jan 25, 2024
Merged

Conversation

Dosant
Copy link
Contributor

@Dosant Dosant commented Jan 22, 2024

Copy link
Contributor

Documentation preview:

@Dosant Dosant changed the title add csv limitations docs [Docs] Clarifying CSV limitations Jan 22, 2024
@Dosant Dosant requested a review from tsullivan January 22, 2024 14:43
@Dosant Dosant added release_note:skip Skip the PR/issue when compiling release notes docs Team:SharedUX Team label for AppEx-SharedUX (formerly Global Experience) (Deprecated) Feature:Reporting Use Reporting:Screenshot, Reporting:CSV, or Reporting:Framework instead labels Jan 22, 2024
@Dosant Dosant marked this pull request as ready for review January 22, 2024 14:44
@Dosant Dosant requested a review from a team as a code owner January 22, 2024 14:44
@elasticmachine
Copy link
Contributor

Pinging @elastic/appex-sharedux (Team:SharedUX)

@Dosant
Copy link
Contributor Author

Dosant commented Jan 22, 2024

/ci

@kibana-ci
Copy link
Collaborator

💚 Build Succeeded

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

Copy link
Member

@tsullivan tsullivan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few tweaks

- Cross-cluster search is used
- ES|QL is used and result row count exceeds the limits of ES|QL queries

Use filters to create multiple smaller reports, or extract the data you need directly with the Elasticsearch APIs. See Point in time API, or SQL with CSV response data format. 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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Use filters to create multiple smaller reports, or extract the data you need directly with the Elasticsearch APIs. See Point in time API, or SQL with CSV response data format. 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.
To work around the limitations, use filters to create multiple smaller reports, or extract the data you need directly with the Elasticsearch APIs. See Point in time API, or SQL with CSV response data format. 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.

I think scroll should be included here as well, and the phrases should be linked.

Point-in-time API: https://www.elastic.co/guide/en/elasticsearch/reference/current/point-in-time-api.html
Scroll API: https://www.elastic.co/guide/en/elasticsearch/reference/current/scroll-api.html
SQL with CSV response: https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-rest-format.html

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! I also added a link to reporting settings and mentioned ES|QL with csv response type

@Dosant Dosant requested a review from tsullivan January 23, 2024 11:20
Copy link
Member

@tsullivan tsullivan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@Dosant
Copy link
Contributor Author

Dosant commented Jan 25, 2024

@elasticmachine merge upstream

@Dosant Dosant enabled auto-merge (squash) January 25, 2024 15:46
@Dosant Dosant merged commit 2ea91b1 into elastic:main Jan 25, 2024
6 checks passed
@kibanamachine kibanamachine added v8.13.0 backport:skip This commit does not require backporting labels Jan 25, 2024
@Dosant Dosant self-assigned this Feb 7, 2024
CoenWarmer pushed a commit to CoenWarmer/kibana that referenced this pull request Feb 15, 2024
## Summary 

Adding CSV limitations section
amyjtechwriter added a commit that referenced this pull request Mar 22, 2024
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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:skip This commit does not require backporting (Deprecated) Feature:Reporting Use Reporting:Screenshot, Reporting:CSV, or Reporting:Framework instead docs release_note:skip Skip the PR/issue when compiling release notes Team:SharedUX Team label for AppEx-SharedUX (formerly Global Experience) v8.13.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants