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

Connector creation - improve error messaging from server #54386

Closed
peterschretlen opened this issue Jan 9, 2020 · 5 comments
Closed

Connector creation - improve error messaging from server #54386

peterschretlen opened this issue Jan 9, 2020 · 5 comments
Labels
connectivity Issues relating to connectivity between Kibana and external services estimate:small Small Estimated Level of Effort Feature:Actions/ConnectorsManagement Issues related to Connectors Management UX Feature:Actions Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) UX

Comments

@peterschretlen
Copy link
Contributor

(Review feedback from docs team on the connectors UI)

#48959 adds a connector creation flyout where you fill a form, and submitting it calls the create action API. We display server-side validation errors, but the messaging is not always clear.

Here are two specific examples:

Example 1: webhook
image

Example 2: email
image

  1. Is there a way to make these messages easier to read/understand to the user? Both are very
    verbose, and the problem is not made clear.

    • In the case of the email action, erhaps this validation could be done client-side.
    • For the webhook action, could we link to xpack.actions.whitelistedHosts documentation about the whitelisting setting (this page)?
  2. All the error messages should start with capital E - "Error validating..."

@peterschretlen peterschretlen added Feature:Actions Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) labels Jan 9, 2020
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-alerting-services (Team:Alerting Services)

@mikecote mikecote added this to Short Term in Make it Action Jan 21, 2020
@mikecote mikecote moved this from Short Term to Mid Term in Make it Action Feb 4, 2020
@mikecote mikecote moved this from Mid Term to 7.12 - Tentative in Make it Action Aug 6, 2020
@mikecote
Copy link
Contributor

Moving from 7.12 - Candidates to 7.x - Candidates.

@mikecote mikecote moved this from 7.12 - Candidates to 7.x - Candidates in Make it Action Dec 30, 2020
@mikecote mikecote removed this from 7.x - Candidates in Make it Action Jan 27, 2021
@mikecote mikecote added this to 7.x - Candidates in Kibana Alerting Jan 27, 2021
@mikecote
Copy link
Contributor

mikecote commented Feb 4, 2021

Moving from 7.x - Candidates to 8.x - Candidates (Backlog) after the latest 7.x planning session.

@mikecote mikecote moved this from 7.x - Candidates to 8.x - Candidates in Kibana Alerting Feb 4, 2021
@pmuellr
Copy link
Member

pmuellr commented Apr 23, 2021

The messages from config-schema can get overly wordy. We're really in need of a better solution for JS data validation, as config-schema is only intended for validating Kibana config values into TS-typed objects. It has a number of downsides including the types generated are read-only, so can't be reused for cases where we want construct data of the same shape to pass somewhere else (eg, tests). It also can cause issues if the validated objects are re-validated - durations turn into objects which when passed through the same validation again will fail.

I don't think there's much use in trying to "fix" anything here - except perhaps extremely annoying messages that we see frequently - since we really need to replace what we're using. For those extremely annoying messages, we can provide custom validate methods which produce nicer messages than config-schema does.

Leaving this open though, as I suspect we may get questions about the error messages in the future, and can point them here.

@gmmorris gmmorris added the Feature:Actions/ConnectorsManagement Issues related to Connectors Management UX label Jul 1, 2021
@gmmorris gmmorris added the loe:medium Medium Level of Effort label Jul 14, 2021
@gmmorris gmmorris added connectivity Issues relating to connectivity between Kibana and external services UX estimate:small Small Estimated Level of Effort labels Aug 13, 2021
@gmmorris gmmorris removed the loe:medium Medium Level of Effort label Sep 2, 2021
@mikecote mikecote removed this from Backlog in Kibana Alerting Jan 6, 2022
@kobelb kobelb added the needs-team Issues missing a team label label Jan 31, 2022
@botelastic botelastic bot removed the needs-team Issues missing a team label label Jan 31, 2022
@mikecote
Copy link
Contributor

Closing as no longer relevant.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
connectivity Issues relating to connectivity between Kibana and external services estimate:small Small Estimated Level of Effort Feature:Actions/ConnectorsManagement Issues related to Connectors Management UX Feature:Actions Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) UX
Projects
None yet
Development

No branches or pull requests

6 participants