[Discover] Improve shard error message formatting #161098

jughosta · 2023-07-03T13:52:44Z

Closes Improve shard error message formatting #156645

Summary

This PR updates UI of shards error modal.

Updated design

Before

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

Checklist

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Unit or functional tests were updated or added to match the most common scenarios
This renders correctly on smaller devices using a responsive layout. (You can test this in your browser)
This was checked for cross-browser compatibility

elasticmachine · 2023-07-03T15:04:09Z

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

kertal

LGTM 👍 thx for taking care of this. Tested locally and works as expected.

2 observations, potential follow ups

shard errors in Discover are still toasts ... they don't storm, but like error messages we should inline them. Same with embeddables on a dashboard ... there they could in theory create a storm, when you have a lot embeddables with different shard errors. Also on a dashboard it's not clear which toast belongs to which embeddables in such cases ... something we should aim to improve rather earlier than later, give that we should also aim to surface CCS to the user (like timeouts) ... but for sure nothing for this PR... here's the issue:
#155216

src/plugins/data/public/shard_failure_modal/shard_failure_description.tsx

src/plugins/data/public/shard_failure_modal/shard_failure_table.tsx

andreadelrio

@jughosta Great job! thanks for implementing so fast. LGTM. Just left a nit about the Show details button.

src/plugins/data/public/shard_failure_modal/shard_failure_description.tsx

…ription.tsx Co-authored-by: Andrea Del Rio <delrio.andre@gmail.com>

…s-error-modal

andreadelrio · 2023-07-10T17:48:42Z

@sophiec20 can you please let us know what you think of this proposal?

sophiec20 · 2023-07-25T13:41:06Z

One small point of feedback - what size font is the page heading?... does it need to be so dominant?... it is the largest and boldest font on the entire page (including the base page) ..

Otherwise LGTM and thank you ..

jughosta · 2023-07-26T11:24:59Z

Thanks, @sophiec20! Reduced the title size to 16px:

stratoula

I just tested it in Lens and is much better now.

I would personally have the Close button and the Copy response CTAs in a fixed position in the bottom, so even if you change tabs, you see this information in the exact same place.

But possibly this was the design (?)

jughosta · 2023-07-26T12:54:12Z

@stratoula Good point! Updated:

stratoula · 2023-07-26T13:02:54Z

Awww much better Julia, thanx ❤️

kibana-ci · 2023-07-26T13:59:28Z

💛 Build succeeded, but was flaky

Buildkite Build
Commit: 6140ff9

Failed CI Steps

FTR Configs #23

Test Failures

[job] [logs] FTR Configs #23 / endpoint When on the Endpoint Policy Details Page when on Ingest Policy Edit Package Policy page should allow updates to policy items

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`data`	458	462	+4

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`data`	53.0KB	53.9KB	+922.0B

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`data`	404.1KB	404.0KB	-65.0B

History

💚 Build #144781 succeeded 61a4117
💛 Build #144646 was flaky 93466d6
💔 Build #144554 failed 2aa3466
💚 Build #143095 succeeded 3c0180d
💚 Build #141228 succeeded 453d70c
💚 Build #140881 succeeded 06aba96

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

cc @jughosta

- 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 <delrio.andre@gmail.com> Co-authored-by: Stratoula Kalafateli <efstratia.kalafateli@elastic.co>

thekofimensah · 2023-09-20T18:15:59Z

This is an aside, I've always thought that the 10 pop ups that appear simultaneously whenever I get a shard error is overwhelming and the need to close each pop up is similarly annoying. Is there any attempt to address this? Or has this been dealt with in the more recent versions?

davismcphee · 2023-09-20T23:25:46Z

Hi @thekofimensah, I agree that seeing long lists of toast messages is really annoying. There's still work left to do, but we've been taking steps to address this issue in recent releases. These are some of the other improvements we've made already:

Both Discover and Lens now use inline warning displays for shard errors instead of toasts, and this applies to their Dashboard panels as well:
- [Discover] Inline shard failures warnings #161271
- [Lens] introduce unified user messages system #147818
We've reduced the number of separate shard failure warnings for the same request by consolidating them under a single "incomplete data" warning: refactor search source warnings to return a single warning for 'is_partial' results #165512
It's now possible to dismiss all toasts with a single action when several appear at once: Add dismiss all toast button for EuiGlobalToastList component eui#7111

We're also currently working on overhauling how we handle and surface shard failures and cross cluster search errors, so users can expect more improvements in these areas soon. Hope this helps!

thekofimensah · 2023-09-21T02:00:20Z

Amazing, thanks for the response. I've been deploying the stack for 8 years now so I'm seeing all the improvements and I've been enjoying seeing things evolve! If you ever need feedback or anything from someone on the outside, feel free to reach out :)

…

On Wed, Sep 20, 2023, 4:26 PM Davis McPhee ***@***.***> wrote: Hi @thekofimensah <https://github.com/thekofimensah>, I agree that seeing long lists of toast messages is really annoying. There's still work left to do, but we've been taking steps to address this issue in recent releases. These are some of the other improvements we've made already: - Both Discover and Lens now use inline warning displays for shard errors instead of toasts, and this applies to their Dashboard panels as well: - #161271 <#161271> - #147818 <#147818> - We've reduced the number of separate shard failure warnings for the same request by consolidating them under a single "incomplete data" warning: #165512 <#165512> - It's now possible to dismiss all toasts with a single action when several appear at once: elastic/eui#7111 <elastic/eui#7111> We're also currently working on overhauling how we handle and surface shard failures and cross cluster search errors, so users can expect more improvements in these areas soon. Hope this helps! — Reply to this email directly, view it on GitHub <#161098 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AFSNDF7PAO2266RX62XQ5LDX3N3QRANCNFSM6AAAAAAZ4PYKKQ> . You are receiving this because you were mentioned.Message ID: ***@***.***>

jughosta added 2 commits June 30, 2023 15:32

[Discover] Fix existing styles

1d0f343

[Discover] Switch to a simpler view

f8c3155

jughosta added release_note:enhancement backport:skip This commit does not require backporting Team:DataDiscovery Discover App Team (Document Explorer, Saved Search, Surrounding documents, Graph) labels Jul 3, 2023

jughosta self-assigned this Jul 3, 2023

jughosta added 2 commits July 3, 2023 15:57

[Discover] Clean up translations

e48c955

Merge branch 'main' into 156645-update-shards-error-modal

a4c27f1

jughosta marked this pull request as ready for review July 3, 2023 15:04

jughosta requested review from a team as code owners July 3, 2023 15:04

kertal approved these changes Jul 4, 2023

View reviewed changes

src/plugins/data/public/shard_failure_modal/shard_failure_description.tsx Show resolved Hide resolved

src/plugins/data/public/shard_failure_modal/shard_failure_table.tsx Show resolved Hide resolved

Merge branch 'main' into 156645-update-shards-error-modal

90bcc80

andreadelrio approved these changes Jul 6, 2023

View reviewed changes

src/plugins/data/public/shard_failure_modal/shard_failure_description.tsx Outdated Show resolved Hide resolved

jughosta and others added 7 commits July 6, 2023 09:00

Update src/plugins/data/public/shard_failure_modal/shard_failure_desc…

7d3f1cd

…ription.tsx Co-authored-by: Andrea Del Rio <delrio.andre@gmail.com>

[Discover] Update snapshots

19f238d

Merge branch 'main' into 156645-update-shards-error-modal

dd5f074

[Discover] Make it more compact

9405150

Merge remote-tracking branch 'upstream/main' into 156645-update-shard…

9e26dbc

…s-error-modal

[Discover] Update snapshots

06aba96

Merge branch 'main' into 156645-update-shards-error-modal

453d70c

jughosta added 3 commits July 18, 2023 10:14

Merge branch 'main' into 156645-update-shards-error-modal

3c0180d

Merge branch 'main' into 156645-update-shards-error-modal

2aa3466

Merge branch 'main' into 156645-update-shards-error-modal

9c22251

jughosta added 2 commits July 25, 2023 15:55

Merge branch 'main' into 156645-update-shards-error-modal

93466d6

[Discover] Reduce modal title size

f1ff6af

[Discover] Update snapshot

61a4117

Merge branch 'main' into 156645-update-shards-error-modal

aef8da9

stratoula approved these changes Jul 26, 2023

View reviewed changes

[Discover] Push buttons to the bottom of the modal

6140ff9

jughosta enabled auto-merge (squash) July 26, 2023 13:10

jughosta merged commit 41e2363 into elastic:main Jul 26, 2023
22 checks passed

kibanamachine added the v8.10.0 label Jul 26, 2023

jughosta deleted the 156645-update-shards-error-modal branch September 21, 2023 09:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Discover] Improve shard error message formatting #161098

[Discover] Improve shard error message formatting #161098

jughosta commented Jul 3, 2023 •

edited

elasticmachine commented Jul 3, 2023

kertal left a comment •

edited

andreadelrio left a comment

andreadelrio commented Jul 10, 2023

sophiec20 commented Jul 25, 2023 •

edited

jughosta commented Jul 26, 2023

stratoula left a comment

jughosta commented Jul 26, 2023

stratoula commented Jul 26, 2023

kibana-ci commented Jul 26, 2023

thekofimensah commented Sep 20, 2023

davismcphee commented Sep 20, 2023

thekofimensah commented Sep 21, 2023 via email

[Discover] Improve shard error message formatting #161098

[Discover] Improve shard error message formatting #161098

Conversation

jughosta commented Jul 3, 2023 • edited

Summary

Updated design

Before

Checklist

elasticmachine commented Jul 3, 2023

kertal left a comment • edited

Choose a reason for hiding this comment

andreadelrio left a comment

Choose a reason for hiding this comment

andreadelrio commented Jul 10, 2023

sophiec20 commented Jul 25, 2023 • edited

jughosta commented Jul 26, 2023

stratoula left a comment

Choose a reason for hiding this comment

jughosta commented Jul 26, 2023

stratoula commented Jul 26, 2023

kibana-ci commented Jul 26, 2023

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

Metrics [docs]

Module Count

Async chunks

Page load bundle

History

thekofimensah commented Sep 20, 2023

davismcphee commented Sep 20, 2023

thekofimensah commented Sep 21, 2023 via email

jughosta commented Jul 3, 2023 •

edited

kertal left a comment •

edited

sophiec20 commented Jul 25, 2023 •

edited