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

[Reporting/CSV] Make searches used for export inspectable #162366

Closed
tsullivan opened this issue Jul 20, 2023 · 4 comments · Fixed by #171248
Closed

[Reporting/CSV] Make searches used for export inspectable #162366

tsullivan opened this issue Jul 20, 2023 · 4 comments · Fixed by #171248
Assignees
Labels
(Deprecated) Feature:Reporting Use Reporting:Screenshot, Reporting:CSV, or Reporting:Framework instead enhancement New value added to drive a business result Team:SharedUX Team label for AppEx-SharedUX (formerly Global Experience)

Comments

@tsullivan
Copy link
Member

tsullivan commented Jul 20, 2023

Clear and simple error messages aren't helpful in some cases with automated reports. We are able to add error messages and warnings from Elasticsearch into the report job metadata, but with automated reports the only artifact the end user handles often is the report content itself.

  1. CSV Reporting should handle the following condition: a search request to Elasticsearch fails with an error and there is no data to collect. In this condition, we should put the failure error into the report contents itself. This will ease troubleshooting that can be very difficult today when reports are generated with Watcher.

  2. We should raise diagnostic info out of the debug logs, by giving the user a way to "replay" the query in Dev Tools/console. This would improve triaging CSV issues when the root cause is performance issues with ES, as it gives a way to reproduce the hits on performance without creating a report. (Thanks to @sebelga for this idea.)

@tsullivan tsullivan added enhancement New value added to drive a business result (Deprecated) Feature:Reporting Use Reporting:Screenshot, Reporting:CSV, or Reporting:Framework instead Team:SharedUX Team label for AppEx-SharedUX (formerly Global Experience) labels Jul 20, 2023
@elasticmachine
Copy link
Contributor

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

@petrklapka
Copy link
Member

@tsullivan - if this would lead to SDH reduction, could be a good candidate for Reporting Scaling work package.

@tsullivan
Copy link
Member Author

Updated the description: increased the scope by adding the requirement for a button to replay the queries in Dev Tools/Console.

@tsullivan
Copy link
Member Author

In this condition, we should put the failure error into the report contents itself. This will ease troubleshooting that can be very difficult today when reports are generated with Watcher.

Adding this content turns out to be technically infeasible due to how the contents of the report come directly from the hits.hits section of the ES query response.

I'm focusing on the suggestion to have a "Open in Console" button visible on the report info side panel. This will yield the best user experience when they face performance with search performance, to eliminate the possibility the problem is in the CSV Reporting layer of the platform.

@tsullivan tsullivan changed the title [Reporting/CSV] Copy the error message in the CSV file result if search throws an error [Reporting/CSV] Make searches used for export inspectable Nov 8, 2023
tsullivan added a commit that referenced this issue Dec 6, 2023
## Summary

Resolves #162366

## Release note
Added a troubleshooting enhancement for Kibana CSV export to allow users
to inspect the queries used for collecting all of the data.

## Other changes:
* Expose the reporting `csv.scroll` settings to the browser.
* Lazy-load the report job info panel component.
* Fix a few mixups of "setup" and "start" contracts.

## Screenshots
<details>
<summary>Option in Stack Management for CSV report jobs</summary>

![image](https://github.com/elastic/kibana/assets/908371/a382bfee-ce1f-4229-bf89-bf8836328ad3)
</details>

<details>
<summary>Screencast</summary>


https://github.com/elastic/kibana/assets/908371/a2fba0f4-0ede-4d97-aad3-4b13351e24a3

</details>

## Checklist

Delete any items that are not applicable to this PR.

- [x] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios
- [x] Any UI touched in this PR is usable by keyboard only (learn more
about [keyboard accessibility](https://webaim.org/techniques/keyboard/))
- [x] Any UI touched in this PR does not create any new axe failures
(run axe in browser:
[FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/),
[Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US))
- [x] This was checked for [cross-browser
compatibility](https://www.elastic.co/support/matrix#matrix_browsers)

---------

Co-authored-by: kibanamachine <[email protected]>
Co-authored-by: Sébastien Loix <[email protected]>
Co-authored-by: Sébastien Loix <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
(Deprecated) Feature:Reporting Use Reporting:Screenshot, Reporting:CSV, or Reporting:Framework instead enhancement New value added to drive a business result Team:SharedUX Team label for AppEx-SharedUX (formerly Global Experience)
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants