[Discover] Add caused_by.type and caused_by.reason to error toast modal #70404

kertal · 2020-07-01T08:21:31Z

Summary

Improves the current error modal toast with additional information about what caused a Elasticsearch request to fail. Seems this info was provided in older 7.x versions differently and was part of the error message, but no longer is.

Before this PR:

Now the it's clear what caused the error, an unknown timezone:

Related to: #70352

How to test

Set the timezone of Kibana to MST in Advanced settings, that should trigger this error.

timroes · 2020-07-01T10:49:02Z

I removed the "Fix note", since I think it's not the fix to the mentioned issue, but just related to it. We should actually check which time zones are allowed by ES and only allow users to select those in Kibana. This PR nevertheless is of course useful and should go in, would just not close the issue with it.

tsullivan

LGTM!

elasticmachine · 2020-07-01T18:33:18Z

Pinging @elastic/kibana-app-arch (Team:AppArch)

pgayvallet · 2020-07-02T11:49:22Z

src/core/public/notifications/toasts/error_toast.tsx

-  error: Error;
+  error: RequestError;


I would:
1/ keep Error in ErrorToastProps as RequestError does not reflect the real type (is can be any kind of error)
2/ add a typeguard for RequestError: isRequestError = (e: Error): e is RequestError => error.body?.attributes?.error?.caused_by !== undefined

Use it in the block

if (isRequestError(error)) { text += `${error.body.attributes.error.caused_by.type}\n`; text += `${error.body.attributes.error.caused_by.reason}\n\n`; }

thx! adapted the code in this way

dear @pgayvallet , have some TypeScript errors here to resolve

const isRequestError = (e: Error): e is RequestError => e.body?.attributes?.error?.caused_by !== undefined;

Error message: Property 'body' does not exist on type 'Error'.

How can I resolve this? many thx

(e: Error) -> (e: any) should do the trick

thx, to omit any, I've implemented it the following way:

const isRequestError = (e: Error | RequestError): e is RequestError => { if ('body' in e) { return e.body?.attributes?.error?.caused_by !== undefined; } return false; };

kertal · 2020-07-02T19:17:54Z

Jenkins, test this

kertal · 2020-07-02T19:48:41Z

@elasticmachine merge upstream

…r-message-with-add-context

lukasolson

Code LGTM

kertal · 2020-07-06T05:57:45Z

@elasticmachine merge upstream

…r-message-with-add-context

kertal · 2020-07-08T08:55:07Z

@elasticmachine merge upstream

…r-message-with-add-context

kertal · 2020-07-13T10:38:56Z

@elasticmachine merge upstream

kertal · 2020-07-13T12:57:11Z

@elasticmachine merge upstream

…r-message-with-add-context

…h-add-context' of github.com:kertal/kibana into kertal-pr-2020-07-01-discover-improve-error-message-with-add-context

kibanamachine · 2020-07-13T15:52:14Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: 9a841ad

Build metrics

✅ unchanged

History

💚 Build #60848 succeeded c4f9e32
💔 Build #60813 failed dd6fc5d
💔 Build #58801 failed 4f3fd31
💔 Build #58453 failed 2ad5f2b
💔 Build #58441 failed 9f03725

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

…al (elastic#70404)

…al (#70404) (#71595)

* master: (314 commits) [APM] Use status_code field to calculate error rate (elastic#71109) [Observability] Change appLink passing the date range (elastic#71259) [Security] Add Timeline improvements (elastic#71506) adjust vislib bar opacity (elastic#71421) Fix ScopedHistory mock and adapt usages (elastic#71404) [Security Solution] Add hook for reading/writing resolver query params (elastic#70809) [APM] Bug fixes from ML integration testing (elastic#71564) [Discover] Add caused_by.type and caused_by.reason to error toast modal (elastic#70404) [Security Solution] Add 3rd level breadcrumb to admin page (elastic#71275) [Security Solution][Exceptions] Exception modal bulk close alerts that match exception attributes (elastic#71321) Change signal.rule.risk score mapping from keyword to float (elastic#71126) Added help text where needed on connectors and alert actions UI (elastic#69601) [SIEM][Detections] Value Lists Management Modal (elastic#67068) [test] Skips test preventing promotion of ES snapshot elastic#71582 [test] Skips test preventing promotion of ES snapshot elastic#71555 [ILM] Fix alignment of the timing field (elastic#71273) [SIEM][Detection Engine][Lists] Adds the ability for exception lists to be multi-list queried. (elastic#71540) initial telemetry setup (elastic#69330) [Reporting] Formatting fixes for CSV export in Discover, CSV download from Dashboard panel (elastic#67027) Search across spaces (elastic#67644) ...

…t-apps-page-titles * 'master' of github.com:elastic/kibana: (88 commits) [ML] Functional tests - disable DFA creation and cloning tests [APM] Use status_code field to calculate error rate (elastic#71109) [Observability] Change appLink passing the date range (elastic#71259) [Security] Add Timeline improvements (elastic#71506) adjust vislib bar opacity (elastic#71421) Fix ScopedHistory mock and adapt usages (elastic#71404) [Security Solution] Add hook for reading/writing resolver query params (elastic#70809) [APM] Bug fixes from ML integration testing (elastic#71564) [Discover] Add caused_by.type and caused_by.reason to error toast modal (elastic#70404) [Security Solution] Add 3rd level breadcrumb to admin page (elastic#71275) [Security Solution][Exceptions] Exception modal bulk close alerts that match exception attributes (elastic#71321) Change signal.rule.risk score mapping from keyword to float (elastic#71126) Added help text where needed on connectors and alert actions UI (elastic#69601) [SIEM][Detections] Value Lists Management Modal (elastic#67068) [test] Skips test preventing promotion of ES snapshot elastic#71582 [test] Skips test preventing promotion of ES snapshot elastic#71555 [ILM] Fix alignment of the timing field (elastic#71273) [SIEM][Detection Engine][Lists] Adds the ability for exception lists to be multi-list queried. (elastic#71540) initial telemetry setup (elastic#69330) [Reporting] Formatting fixes for CSV export in Discover, CSV download from Dashboard panel (elastic#67027) ... # Conflicts: # x-pack/plugins/index_management/public/application/index.tsx

* master: (72 commits) [test] Skips test preventing promotion of ES snapshot elastic#71612 [Logs UI] Remove UUID from Alert Instances (elastic#71340) [Metrics UI] Remove UUID from Alert Instance IDs (elastic#71335) [ML] Functional tests - disable DFA creation and cloning tests [APM] Use status_code field to calculate error rate (elastic#71109) [Observability] Change appLink passing the date range (elastic#71259) [Security] Add Timeline improvements (elastic#71506) adjust vislib bar opacity (elastic#71421) Fix ScopedHistory mock and adapt usages (elastic#71404) [Security Solution] Add hook for reading/writing resolver query params (elastic#70809) [APM] Bug fixes from ML integration testing (elastic#71564) [Discover] Add caused_by.type and caused_by.reason to error toast modal (elastic#70404) [Security Solution] Add 3rd level breadcrumb to admin page (elastic#71275) [Security Solution][Exceptions] Exception modal bulk close alerts that match exception attributes (elastic#71321) Change signal.rule.risk score mapping from keyword to float (elastic#71126) Added help text where needed on connectors and alert actions UI (elastic#69601) [SIEM][Detections] Value Lists Management Modal (elastic#67068) [test] Skips test preventing promotion of ES snapshot elastic#71582 [test] Skips test preventing promotion of ES snapshot elastic#71555 [ILM] Fix alignment of the timing field (elastic#71273) ...

Add caused_by.type and caused_by.reason to error toast modal

efbd532

kertal self-assigned this Jul 1, 2020

kertal added Team:Visualizations Visualization editors, elastic-charts and infrastructure Feature:Discover Discover Application Team:AppArch labels Jul 1, 2020

tsullivan approved these changes Jul 1, 2020

View reviewed changes

kertal marked this pull request as ready for review July 1, 2020 18:33

kertal requested a review from a team as a code owner July 1, 2020 18:33

pgayvallet reviewed Jul 2, 2020

View reviewed changes

Add isRequestError function

9f03725

kertal requested a review from pgayvallet July 2, 2020 12:55

pgayvallet approved these changes Jul 2, 2020

View reviewed changes

Merge branch 'master' into kertal-pr-2020-07-01-discover-improve-erro…

2ad5f2b

…r-message-with-add-context

lukasolson approved these changes Jul 2, 2020

View reviewed changes

kertal added release_note:skip Skip the PR/issue when compiling release notes v7.9.0 v8.0.0 labels Jul 2, 2020

Merge branch 'master' into kertal-pr-2020-07-01-discover-improve-erro…

4f3fd31

…r-message-with-add-context

Merge branch 'master' into kertal-pr-2020-07-01-discover-improve-erro…

bd6fec3

…r-message-with-add-context

Fix types

dd6fc5d

elasticmachine and others added 2 commits July 13, 2020 06:57

Merge branch 'master' into kertal-pr-2020-07-01-discover-improve-erro…

c4f9e32

…r-message-with-add-context

Improve types

0febd1e

Merge branch 'kertal-pr-2020-07-01-discover-improve-error-message-wit…

9a841ad

…h-add-context' of github.com:kertal/kibana into kertal-pr-2020-07-01-discover-improve-error-message-with-add-context

kertal merged commit 24d29a3 into elastic:master Jul 14, 2020

kertal mentioned this pull request Jul 14, 2020

[7.x] [Discover] Add caused_by.type and caused_by.reason to error toast modal (#70404) #71595

Merged

kertal added a commit to kertal/kibana that referenced this pull request Jul 14, 2020

[Discover] Add caused_by.type and caused_by.reason to error toast mod…

c017591

…al (elastic#70404)

kertal added a commit that referenced this pull request Jul 14, 2020

[Discover] Add caused_by.type and caused_by.reason to error toast mod…

b4a5162

…al (#70404) (#71595)

rylnd mentioned this pull request Oct 17, 2020

EQL: Error responses do not include caused_by fields elastic/elasticsearch#63855

Closed

rylnd mentioned this pull request Oct 27, 2020

[Notifications] Add more error context to error toasts #81857

Closed

pgayvallet mentioned this pull request Nov 2, 2020

[Notifications] Error Toasts display top-level error type and reason in addition to caused_by #81965

Closed

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Discover] Add caused_by.type and caused_by.reason to error toast modal #70404

[Discover] Add caused_by.type and caused_by.reason to error toast modal #70404

kertal commented Jul 1, 2020 •

edited

Loading

timroes commented Jul 1, 2020

tsullivan left a comment

elasticmachine commented Jul 1, 2020

pgayvallet Jul 2, 2020

kertal Jul 2, 2020

kertal Jul 6, 2020

pgayvallet Jul 8, 2020

kertal Jul 14, 2020 •

edited

Loading

kertal commented Jul 2, 2020

kertal commented Jul 2, 2020

lukasolson left a comment

kertal commented Jul 6, 2020

kertal commented Jul 8, 2020

kertal commented Jul 13, 2020

kertal commented Jul 13, 2020

kibanamachine commented Jul 13, 2020

[Discover] Add caused_by.type and caused_by.reason to error toast modal #70404

[Discover] Add caused_by.type and caused_by.reason to error toast modal #70404

Conversation

kertal commented Jul 1, 2020 • edited Loading

Summary

How to test

timroes commented Jul 1, 2020

tsullivan left a comment

Choose a reason for hiding this comment

elasticmachine commented Jul 1, 2020

pgayvallet Jul 2, 2020

Choose a reason for hiding this comment

kertal Jul 2, 2020

Choose a reason for hiding this comment

kertal Jul 6, 2020

Choose a reason for hiding this comment

pgayvallet Jul 8, 2020

Choose a reason for hiding this comment

kertal Jul 14, 2020 • edited Loading

Choose a reason for hiding this comment

kertal commented Jul 2, 2020

kertal commented Jul 2, 2020

lukasolson left a comment

Choose a reason for hiding this comment

kertal commented Jul 6, 2020

kertal commented Jul 8, 2020

kertal commented Jul 13, 2020

kertal commented Jul 13, 2020

kibanamachine commented Jul 13, 2020

💚 Build Succeeded

Build metrics

History

kertal commented Jul 1, 2020 •

edited

Loading

kertal Jul 14, 2020 •

edited

Loading