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

[Enterprise Search] Show error panel on ELSER API call errors #156273

Merged
merged 10 commits into from
May 2, 2023

Conversation

demjened
Copy link
Contributor

@demjened demjened commented May 1, 2023

Summary

This PR adds generic error handling for API calls that manage the ELSER model: creation (download), fetching and starting the deployment. If an error occurs, the ELSER panel is replaced with the error panel. The user can navigate to the ML Notifications page with a link, which might contain diagnostic information about the error.

ELSER_error_handling

Checklist

@demjened demjened marked this pull request as ready for review May 2, 2023 00:25
@demjened demjened requested a review from a team May 2, 2023 00:25
@demjened demjened added the release_note:skip Skip the PR/issue when compiling release notes label May 2, 2023
@kibana-ci
Copy link
Collaborator

💚 Build Succeeded

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id before after diff
enterpriseSearch 2078 2079 +1

Async chunks

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

id before after diff
enterpriseSearch 2.3MB 2.3MB +1.5KB
Unknown metric groups

ESLint disabled line counts

id before after diff
enterpriseSearch 19 21 +2
securitySolution 399 402 +3
total +5

Total ESLint disabled count

id before after diff
enterpriseSearch 20 22 +2
securitySolution 479 482 +3
total +5

History

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

@demjened demjened merged commit 5263339 into elastic:main May 2, 2023
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request May 2, 2023
## Summary

This PR adds generic error handling for API calls that manage the ELSER
model: creation (download), fetching and starting the deployment. If an
error occurs, the ELSER panel is replaced with the error panel. The user
can navigate to the ML Notifications page with a link, which might
contain diagnostic information about the error.

![ELSER_error_handling](https://user-images.githubusercontent.com/14224983/235535266-93e8e822-0603-4a10-8aab-ec77cd167bf6.gif)

### 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] Any UI touched in this PR is usable by keyboard only (learn more
about [keyboard accessibility](https://webaim.org/techniques/keyboard/))
- [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))

---------

Co-authored-by: kibanamachine <[email protected]>
(cherry picked from commit 5263339)
@kibanamachine
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
8.8

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

@demjened demjened changed the title [Enterprise Search] Show error panel on API call errors [Enterprise Search] Show error panel on ELSER API call errors May 2, 2023
kibanamachine added a commit that referenced this pull request May 2, 2023
…156273) (#156448)

# Backport

This will backport the following commits from `main` to `8.8`:
- [[Enterprise Search] Show error panel on API call errors
(#156273)](#156273)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Adam
Demjen","email":"[email protected]"},"sourceCommit":{"committedDate":"2023-05-02T20:42:13Z","message":"[Enterprise
Search] Show error panel on API call errors (#156273)\n\n##
Summary\r\n\r\nThis PR adds generic error handling for API calls that
manage the ELSER\r\nmodel: creation (download), fetching and starting
the deployment. If an\r\nerror occurs, the ELSER panel is replaced with
the error panel. The user\r\ncan navigate to the ML Notifications page
with a link, which might\r\ncontain diagnostic information about the
error.\r\n\r\n\r\n![ELSER_error_handling](https://user-images.githubusercontent.com/14224983/235535266-93e8e822-0603-4a10-8aab-ec77cd167bf6.gif)\r\n\r\n\r\n###
Checklist\r\n\r\n- [x] Any text added follows [EUI's
writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing),
uses\r\nsentence case text and includes
[i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)\r\n-
[x] [Unit or
functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere
updated or added to match the most common scenarios\r\n- [x] Any UI
touched in this PR is usable by keyboard only (learn more\r\nabout
[keyboard accessibility](https://webaim.org/techniques/keyboard/))\r\n-
[x] This renders correctly on smaller devices using a
responsive\r\nlayout. (You can test this [in
your\r\nbrowser](https://www.browserstack.com/guide/responsive-testing-on-local-server))\r\n\r\n---------\r\n\r\nCo-authored-by:
kibanamachine
<[email protected]>","sha":"52633391082d0332d0f41b45c81989e41f875ccf","branchLabelMapping":{"^v8.9.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:EnterpriseSearch","v8.8.0","v8.9.0"],"number":156273,"url":"https://github.com/elastic/kibana/pull/156273","mergeCommit":{"message":"[Enterprise
Search] Show error panel on API call errors (#156273)\n\n##
Summary\r\n\r\nThis PR adds generic error handling for API calls that
manage the ELSER\r\nmodel: creation (download), fetching and starting
the deployment. If an\r\nerror occurs, the ELSER panel is replaced with
the error panel. The user\r\ncan navigate to the ML Notifications page
with a link, which might\r\ncontain diagnostic information about the
error.\r\n\r\n\r\n![ELSER_error_handling](https://user-images.githubusercontent.com/14224983/235535266-93e8e822-0603-4a10-8aab-ec77cd167bf6.gif)\r\n\r\n\r\n###
Checklist\r\n\r\n- [x] Any text added follows [EUI's
writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing),
uses\r\nsentence case text and includes
[i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)\r\n-
[x] [Unit or
functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere
updated or added to match the most common scenarios\r\n- [x] Any UI
touched in this PR is usable by keyboard only (learn more\r\nabout
[keyboard accessibility](https://webaim.org/techniques/keyboard/))\r\n-
[x] This renders correctly on smaller devices using a
responsive\r\nlayout. (You can test this [in
your\r\nbrowser](https://www.browserstack.com/guide/responsive-testing-on-local-server))\r\n\r\n---------\r\n\r\nCo-authored-by:
kibanamachine
<[email protected]>","sha":"52633391082d0332d0f41b45c81989e41f875ccf"}},"sourceBranch":"main","suggestedTargetBranches":["8.8"],"targetPullRequestStates":[{"branch":"8.8","label":"v8.8.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.9.0","labelRegex":"^v8.9.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/156273","number":156273,"mergeCommit":{"message":"[Enterprise
Search] Show error panel on API call errors (#156273)\n\n##
Summary\r\n\r\nThis PR adds generic error handling for API calls that
manage the ELSER\r\nmodel: creation (download), fetching and starting
the deployment. If an\r\nerror occurs, the ELSER panel is replaced with
the error panel. The user\r\ncan navigate to the ML Notifications page
with a link, which might\r\ncontain diagnostic information about the
error.\r\n\r\n\r\n![ELSER_error_handling](https://user-images.githubusercontent.com/14224983/235535266-93e8e822-0603-4a10-8aab-ec77cd167bf6.gif)\r\n\r\n\r\n###
Checklist\r\n\r\n- [x] Any text added follows [EUI's
writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing),
uses\r\nsentence case text and includes
[i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)\r\n-
[x] [Unit or
functional\r\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\r\nwere
updated or added to match the most common scenarios\r\n- [x] Any UI
touched in this PR is usable by keyboard only (learn more\r\nabout
[keyboard accessibility](https://webaim.org/techniques/keyboard/))\r\n-
[x] This renders correctly on smaller devices using a
responsive\r\nlayout. (You can test this [in
your\r\nbrowser](https://www.browserstack.com/guide/responsive-testing-on-local-server))\r\n\r\n---------\r\n\r\nCo-authored-by:
kibanamachine
<[email protected]>","sha":"52633391082d0332d0f41b45c81989e41f875ccf"}}]}]
BACKPORT-->

Co-authored-by: Adam Demjen <[email protected]>
@demjened demjened deleted the demjened/elser-error-handling branch May 5, 2023 15:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release_note:skip Skip the PR/issue when compiling release notes Team:EnterpriseSearch v8.8.0 v8.9.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants