[8.x] [Reporting Docs for inspecting the query used for CSV export (#207001) (#207033)

# Backport

This will backport the following commits from `main` to `8.x`:
- [[Reporting Docs for inspecting the query used for CSV export
(#207001)](https://github.com/elastic/kibana/pull/207001)

<!--- 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-17T08:48:15Z","message":"[Reporting
Docs for inspecting the query used for CSV export (#207001)\n\nCloses
https://github.com/elastic/kibana/issues/191768\r\n\r\n---------\r\n\r\nCo-authored-by:
wajihaparvez
<wajiha.parvez@elastic.co>","sha":"a514c26d38e728cd75adba3945b5c41277f73957","branchLabelMapping":{"^v9.0.0$":"main","^v8.18.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","docs","Team:SharedUX","backport:prev-minor","v8.15.0","v8.16.0","backport:version","v8.17.0","v8.18.0"],"title":"[Reporting
Docs for inspecting the query used for CSV
export","number":207001,"url":"https://github.com/elastic/kibana/pull/207001","mergeCommit":{"message":"[Reporting
Docs for inspecting the query used for CSV export (#207001)\n\nCloses
https://github.com/elastic/kibana/issues/191768\r\n\r\n---------\r\n\r\nCo-authored-by:
wajihaparvez
<wajiha.parvez@elastic.co>","sha":"a514c26d38e728cd75adba3945b5c41277f73957"}},"sourceBranch":"main","suggestedTargetBranches":["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/207001","number":207001,"mergeCommit":{"message":"[Reporting
Docs for inspecting the query used for CSV export (#207001)\n\nCloses
https://github.com/elastic/kibana/issues/191768\r\n\r\n---------\r\n\r\nCo-authored-by:
wajihaparvez
<wajiha.parvez@elastic.co>","sha":"a514c26d38e728cd75adba3945b5c41277f73957"}},{"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-17 20:21:09 +11:00 committed by GitHub
parent 56ee044840
commit 02085b66f9
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -69,6 +69,21 @@ Such changes aren't guaranteed to solve the issue, but give the functionality a
chance of working in this use case.
Unfortunately, lowering the scroll size will require more requests to Elasticsearch during export, which adds more time overhead, which could unintentionally create more instances of auth token expiration errors.
[float]
[[reporting-troubleshooting-inspect-query-used-for-export]]
=== Inspecting the query used for CSV export
The listing of reports in *Stack Management > Reporting* allows you to inspect the query used for CSV export. It can be helpful to see the raw responses
from Elasticsearch, or determine if there are performance improvements to be gained by changing the way you query the data.
1. Go to **Stack Management > Reporting** and click the info icon next to a report.
2. In the footer of the report flyout, click **Actions**.
3. Click **Inspect query in Console** in the **Actions** menu.
4. This will open the *Console* application, pre-filled with the queries used to generate the CSV export.
[role="screenshot"]
image::https://images.contentstack.io/v3/assets/bltefdd0b53724fa2ce/blt4758e67aaec715d9/67897d0be92e090a6dc626a8/inspect-query-from-csv-export.gif[Inspect the query used for CSV export]
[float]
[[reporting-troubleshooting-csv-token-expired]]
=== Token expiration