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

[Discover] Inline shard error warnings #155216

Closed
kertal opened this issue Apr 19, 2023 · 1 comment · Fixed by #161271
Closed

[Discover] Inline shard error warnings #155216

kertal opened this issue Apr 19, 2023 · 1 comment · Fixed by #161271
Assignees
Labels
Feature:Discover Discover Application impact:medium Addressing this issue will have a medium level of impact on the quality/strength of our product. papercut Small "burr" in the product that we should fix. Team:DataDiscovery Discover, search (e.g. data plugin and KQL), data views, saved searches. For ES|QL, use Team:ES|QL.

Comments

@kertal
Copy link
Member

kertal commented Apr 19, 2023

When there's a shard error in Discover, it is displayed as a toast.

Bildschirmfoto 2023-04-19 um 06 03 36

We recently switched errors to be rendered inline in

#152311

Warnings like the inline shard error one should be rendered similar to the banner style of an error message (but as a warning, so yellow)

The same should apply to warning when rendering saved searches on a dashboard, because shard errors are also displayed with toasts:

Bildschirmfoto 2023-04-19 um 06 04 45

In development mode it can be simulated by instlling all our demo data, create a data view with the index pattern kibana* without timestamp, and replace

body.query = buildEsQuery(index, query, filters, esQueryConfigs);

with

// body.query = buildEsQuery(index, query, filters, esQueryConfigs);
    body.query = {
      error_query: {
        indices: [
          {
            name: 'kibana_sample_data_ecommerce',
            shard_ids: [0, 1],
            error_type: 'exception',
            message: 'Everythings is fine! I swear!',
          },
          {
            name: 'kibana_sample_data_logs',
            shard_ids: [0, 1],
            error_type: 'exception',
            message: 'Next time I return results! I swear!',
          },
        ],
      },
    };

This triggers a shard error

@kertal kertal added Feature:Discover Discover Application Team:DataDiscovery Discover, search (e.g. data plugin and KQL), data views, saved searches. For ES|QL, use Team:ES|QL. labels Apr 19, 2023
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-data-discovery (Team:DataDiscovery)

@kertal kertal added 8.9 candidate impact:high Addressing this issue will have a high level of impact on the quality/strength of our product. labels Apr 19, 2023
@kertal kertal added the papercut Small "burr" in the product that we should fix. label Apr 25, 2023
@kertal kertal added impact:medium Addressing this issue will have a medium level of impact on the quality/strength of our product. and removed impact:high Addressing this issue will have a high level of impact on the quality/strength of our product. labels Jun 13, 2023
@kertal kertal assigned mattkime and jughosta and unassigned mattkime Jul 26, 2023
jughosta added a commit that referenced this issue Aug 10, 2023
- Closes #155216

## Summary

This PR replaces shard falures toasts with inline warnings in Discover.

- [x] Intercept shard failures in Discover main app
- [x] Show inline warnings above the grid instead
- [x] Handle NoResultsFound case too
- [x] Implement for Discover context app
- [x] Implement for saved search embeddable on Dashboard
- [x] Can we inline timeouts too?
- [x] Check SQL view
- [x] Add tests


Discover view with shard failures
<img width="400" alt="Screenshot 2023-07-06 at 14 23 48"
src="https://github.com/elastic/kibana/assets/1415710/a0799aa0-9d2e-42ee-b89b-e0e1180220a5">

Discover view with shard failures (and no results)
<img width="400" alt="Screenshot 2023-07-07 at 13 24 50"
src="https://github.com/elastic/kibana/assets/1415710/28dc2bad-9776-4aa9-8f51-219d1c87487a">

Dashboard view with shard failures
<img width="400" alt="Screenshot 2023-07-06 at 16 15 49"
src="https://github.com/elastic/kibana/assets/1415710/2a68c19a-1ca8-4f10-a9f5-4aa56f9160b0">

Surrounding documents view with shard failures
<img width="400" alt="Screenshot 2023-07-10 at 17 26 31"
src="https://github.com/elastic/kibana/assets/1415710/ade63cfe-a1c2-4c22-8823-58dcfef9357f">

Discover view with timeouts
<img width="400" alt="Screenshot 2023-07-07 at 16 47 27"
src="https://github.com/elastic/kibana/assets/1415710/0101be19-a555-4f96-b963-7fe418d51fb5">

Dashboard view with timeouts
<img width="400" alt="Screenshot 2023-07-07 at 16 48 18"
src="https://github.com/elastic/kibana/assets/1415710/82979365-4129-4385-8a13-9c139e1acbf1">

Surrounding documents view with timeouts
<img width="400" alt="Screenshot 2023-07-11 at 15 03 41"
src="https://github.com/elastic/kibana/assets/1415710/0ea41b79-ac6b-4456-9cfa-0d038b10da7d">

## Testing

For testing please uncomment
https://github.com/elastic/kibana/blob/3f102cf688dbfe87fd901cf7f8b59680ff62e5b8/src/plugins/data/common/search/search_source/search_source.ts#L922
or
https://github.com/elastic/kibana/blob/3f102cf688dbfe87fd901cf7f8b59680ff62e5b8/src/plugins/data/common/search/search_source/search_source.ts#L547
and switch to `kibana*` data view.


### Checklist

Delete any items that are not applicable to this PR.

- [x] Any text added follows [EUI's writing
guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses
sentence case text and includes [i18n
support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)
- [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] This renders correctly on smaller devices using a responsive
layout. (You can test this [in your
browser](https://www.browserstack.com/guide/responsive-testing-on-local-server))
- [x] This was checked for [cross-browser
compatibility](https://www.elastic.co/support/matrix#matrix_browsers)

---------

Co-authored-by: Davis McPhee <[email protected]>
Co-authored-by: kibanamachine <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature:Discover Discover Application impact:medium Addressing this issue will have a medium level of impact on the quality/strength of our product. papercut Small "burr" in the product that we should fix. Team:DataDiscovery Discover, search (e.g. data plugin and KQL), data views, saved searches. For ES|QL, use Team:ES|QL.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants