Add modal with details to shard error toast by kertal · Pull Request #41649 · elastic/kibana

kertal · 2019-07-22T07:52:55Z

Summary

When queries fail because of shard errors in discover, visualize, dashboard, the error message contains no details why it failed, which makes it hard to debug the problem. The target of this PR is to add more info to this error

Old version:

New version:

Fixes #5957

Testing

Here's a way to reproduce the error:

PUT repro1

PUT repro1/_mapping 
{
  "properties": {
    "targetfield": {
      "type": "keyword"
    }
  }
}

POST repro1/_doc
{
  "targetfield":"keywordcontent"
}


PUT repro2

PUT repro2/_mapping 
{
  "properties": {
    "targetfield": {
      "type": "text"
    }
  }
}


POST repro2/_doc
{
  "targetfield":"textcontent"
}

GET repro*/_search
{
    "aggs" : {
        "trigger_error" : {
            "terms" : {
                "field" : "targetfield"
            }
        }
    }
}

Add an Index Pattern in Kibana

Create the following Vis:

Checklist

Use ~~strikethroughs~~ to remove checklist items you don't feel are applicable to this PR.

This was checked for cross-browser compatibility, including a check against IE11
Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
~~- [ ] Documentation was added for features that require explanation or tutorials~~
Unit or functional tests were updated or added to match the most common scenarios
This was checked for keyboard-only and screenreader accessibility

For maintainers

~~- [ ] This was checked for breaking API changes and was labeled appropriately~~

This includes a feature addition or change that requires a release note and was labeled appropriately

elasticmachine · 2019-07-22T08:48:57Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

…rror

elasticmachine · 2019-07-23T12:34:05Z

Pinging @elastic/kibana-app

src/legacy/ui/public/courier/fetch/components/shard_failure_types.tsx

elasticmachine · 2019-07-23T13:14:46Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-07-24T07:28:52Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

- because of the new modal Prop 'className'

…rror

elasticmachine · 2019-07-24T09:29:56Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

…rror

kertal · 2019-07-29T12:39:44Z

FYI @cchaos I've fixed the broken display of the DescriptionList by setting the max-width of the list

.shardFailureModal__desc {
    max-width: 686px;
}

elasticmachine · 2019-07-29T12:55:57Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-07-29T13:36:53Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-07-29T14:35:28Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

- align it right - fix translations - remove EuiText from description for default toast formatting

timroes

Tested on Chrome Linux. Code LGTM

elasticmachine · 2019-07-29T15:47:02Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

* Add details to shard error toast * Implement failure modal with lots of details * Add jest tests * Update core API change because of the new modal Prop 'className'

kertal · 2019-07-30T05:17:50Z

Thank you all for this great cooperation here!

* Add details to shard error toast * Implement failure modal with lots of details * Add jest tests * Update core API change because of the new modal Prop 'className'

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

- 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>

Add details to shard error toast

dd3f5a8

kertal self-assigned this Jul 22, 2019

kertal added 2 commits July 23, 2019 14:15

Implement failure modal with lots of details

89cbbde

Merge remote-tracking branch 'upstream/master' into kertal-pr-shard-e…

887447d

…rror

kertal changed the title ~~Add details to shard error toast~~ Add modal with details to shard error toast Jul 23, 2019

kertal added the Team:Visualizations Team label for Lens, elastic-charts, Graph, legacy editors (TSVB, Visualize, Timelion) t// label Jul 23, 2019

kertal added Feature:Search Querying infrastructure in Kibana enhancement New value added to drive a business result v7.4.0 release_note:enhancement v8.0.0 and removed enhancement New value added to drive a business result labels Jul 23, 2019

timroes reviewed Jul 23, 2019

View reviewed changes

src/legacy/ui/public/courier/fetch/components/shard_failure_types.tsx Show resolved Hide resolved

kertal added 3 commits July 24, 2019 06:10

Rename types file tsx to ts

6b6a82b

Convert styles to SCSS

52575a0

Add jest test for rendering modal

0b28a3a

kertal requested a review from myasonik July 24, 2019 06:40

kertal added 3 commits July 24, 2019 09:44

Update core API change

f391153

- because of the new modal Prop 'className'

Merge remote-tracking branch 'upstream/master' into kertal-pr-shard-e…

377311c

…rror

Fix duplicate translation

63b581d

Add more jest tests

6184c1d

kertal marked this pull request as ready for review July 24, 2019 10:05

kertal requested review from a team as code owners July 24, 2019 10:05

kertal requested a review from timroes July 24, 2019 10:08

kertal added 7 commits July 29, 2019 13:39

Cleanup of ShardFailureDescriptionHeader

79c80a3

Translate table column header

bbaad1f

Convert any types to unknown

f8a4036

Reformat description header

f2f8d5a

Update snapshot tests

0f8c0b0

IE11 DescriptionList width fix

102d495

Merge remote-tracking branch 'upstream/master' into kertal-pr-shard-e…

ecce5e8

…rror

kertal added 2 commits July 29, 2019 15:30

Remove unused EuiTitle

23e26b0

Improve ShardFailureDescriptionHeader component

ca6b3fb

kertal added 2 commits July 29, 2019 16:38

Improving the button starting the modal

c4b1440

- align it right - fix translations - remove EuiText from description for default toast formatting

SCSS formatting fix

893dfc1

timroes approved these changes Jul 29, 2019

View reviewed changes

kertal merged commit e452f43 into elastic:master Jul 29, 2019

kertal mentioned this pull request Jul 30, 2019

[7.x] Add modal with details to shard error toast (#41649) #42227

Merged

kertal added the backported label Jul 30, 2019

kertal mentioned this pull request Aug 1, 2019

Unexpected shard failures? #42410

Closed

kertal mentioned this pull request Sep 14, 2020

[Discover] Migrate discover.html Angular template to React #75784

Merged

1 task

kertal mentioned this pull request May 4, 2023

Improve shard error message formatting #156645

Closed

jughosta mentioned this pull request Jul 3, 2023

[Discover] Improve shard error message formatting #161098

Merged

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add modal with details to shard error toast#41649

Add modal with details to shard error toast#41649
kertal merged 39 commits intoelastic:masterfrom
kertal:kertal-pr-shard-error

kertal commented Jul 22, 2019 •

edited

Loading

Uh oh!

elasticmachine commented Jul 22, 2019

Uh oh!

elasticmachine commented Jul 23, 2019

Uh oh!

Uh oh!

elasticmachine commented Jul 23, 2019

Uh oh!

elasticmachine commented Jul 24, 2019

Uh oh!

elasticmachine commented Jul 24, 2019

Uh oh!

kertal commented Jul 29, 2019

Uh oh!

elasticmachine commented Jul 29, 2019

Uh oh!

elasticmachine commented Jul 29, 2019

Uh oh!

elasticmachine commented Jul 29, 2019

Uh oh!

timroes left a comment

Uh oh!

elasticmachine commented Jul 29, 2019

Uh oh!

kertal commented Jul 30, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Conversation

kertal commented Jul 22, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Testing

Checklist

For maintainers

Uh oh!

elasticmachine commented Jul 22, 2019

💚 Build Succeeded

Uh oh!

elasticmachine commented Jul 23, 2019

Uh oh!

Uh oh!

elasticmachine commented Jul 23, 2019

💔 Build Failed

Uh oh!

elasticmachine commented Jul 24, 2019

💔 Build Failed

Uh oh!

elasticmachine commented Jul 24, 2019

💚 Build Succeeded

Uh oh!

kertal commented Jul 29, 2019

Uh oh!

elasticmachine commented Jul 29, 2019

💔 Build Failed

Uh oh!

elasticmachine commented Jul 29, 2019

💔 Build Failed

Uh oh!

elasticmachine commented Jul 29, 2019

💔 Build Failed

Uh oh!

timroes left a comment

Choose a reason for hiding this comment

Uh oh!

elasticmachine commented Jul 29, 2019

💚 Build Succeeded

Uh oh!

kertal commented Jul 30, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

kertal commented Jul 22, 2019 •

edited

Loading