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

Improve shard error message formatting #156645

Closed
kertal opened this issue May 4, 2023 · 5 comments · Fixed by #161098
Closed

Improve shard error message formatting #156645

kertal opened this issue May 4, 2023 · 5 comments · Fixed by #161098
Assignees
Labels
bug Fixes for quality problems that affect the customer experience cosmetic :DataDiscovery/fix-it-week Feature:Discover Discover Application impact:medium Addressing this issue will have a medium level of impact on the quality/strength of our product. loe:medium Medium Level of Effort 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 May 4, 2023

We introduced a modal providing details to shard errors in v7.4.0 with PR #41649

It allows users to get details about shard errors, before just the message "x of y shards failed" was detailed.

Here's how the modal looks like

The following should be improved

  • Row expansion

    • Avoid using bold in error messages
    • Avoid the big gaps between labels and values
    • Reduce the font size in the header
    • Row expansion should just display a list of field values, rather than trying to construct a meaningful sentence.
  • Table

    • Move node to row expansion to provide more space for the other columns (it's not very useful).
@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 May 4, 2023
@elasticmachine
Copy link
Contributor

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

@kertal kertal added the enhancement New value added to drive a business result label May 4, 2023
@kertal kertal added the papercut Small "burr" in the product that we should fix. label Jun 19, 2023
@davismcphee davismcphee added loe:medium Medium Level of Effort impact:medium Addressing this issue will have a medium level of impact on the quality/strength of our product. labels Jun 22, 2023
@sophiec20
Copy link
Contributor

Note that this can look particularly scary in very large environments and esp with long (CCS) index names.

image

@sophiec20 sophiec20 added cosmetic bug Fixes for quality problems that affect the customer experience and removed enhancement New value added to drive a business result labels Jun 28, 2023
@jughosta jughosta self-assigned this Jun 28, 2023
@kertal
Copy link
Member Author

kertal commented Jun 28, 2023

Thx @sophiec20 for providing additional feedback, I do agree we should aim to fix this dated UI. Apart from the layout, I think the information presented here to debug shard errors, something like this would be useful for CCS failures, telling users about timeouts in certain CCS clusters or something like this (Once this information would be available in a search request result, which isn't currently the case)

@sophiec20
Copy link
Contributor

Yes, and we can make it better in increments, starting with a more succinct, cleaner and simpler presentation of today's elasticsearch errors. As a follow up, we can work with es to improve error handling.

@andreadelrio
Copy link
Contributor

Given that values of these columns can get quite long (see index and node names in Sophie's examples) why don’t we try an inverted layout instead?

image image

This new layout does away with the unnecessary repetition of information we have in the current one. See:
Frame 2

Some things to consider:

  • When there's only one page, I recommend we hide the pagination component. That would make the modal cleaner.

jughosta added a commit that referenced this issue Jul 26, 2023
- Closes #156645

## Summary

This PR updates UI of shards error modal.

### Updated design
<img width="500" alt="Screenshot 2023-07-07 at 10 05 00"
src="https://github.com/elastic/kibana/assets/1415710/a099a436-61fd-4522-b231-88a0d1179061">

![Jul-07-2023
10-20-13](https://github.com/elastic/kibana/assets/1415710/23069476-9aae-4c76-9e39-586a382dcf70)



### Before
<img width="500" alt="image 2"
src="https://github.com/elastic/kibana/assets/4016496/d3c067d9-2d18-4fcc-8db0-573defcb9b44">


For testing, please follow instruction from
#41649 and drop `targetfield` on
Lens page.


### Checklist

- [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: Andrea Del Rio <[email protected]>
Co-authored-by: Stratoula Kalafateli <[email protected]>
ThomThomson pushed a commit to ThomThomson/kibana that referenced this issue Aug 1, 2023
- Closes elastic#156645

## Summary

This PR updates UI of shards error modal.

### Updated design
<img width="500" alt="Screenshot 2023-07-07 at 10 05 00"
src="https://github.com/elastic/kibana/assets/1415710/a099a436-61fd-4522-b231-88a0d1179061">

![Jul-07-2023
10-20-13](https://github.com/elastic/kibana/assets/1415710/23069476-9aae-4c76-9e39-586a382dcf70)



### Before
<img width="500" alt="image 2"
src="https://github.com/elastic/kibana/assets/4016496/d3c067d9-2d18-4fcc-8db0-573defcb9b44">


For testing, please follow instruction from
elastic#41649 and drop `targetfield` on
Lens page.


### Checklist

- [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: Andrea Del Rio <[email protected]>
Co-authored-by: Stratoula Kalafateli <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Fixes for quality problems that affect the customer experience cosmetic :DataDiscovery/fix-it-week Feature:Discover Discover Application impact:medium Addressing this issue will have a medium level of impact on the quality/strength of our product. loe:medium Medium Level of Effort 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.

7 participants