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

[Lens] Consolidate and improve consistency when presenting warnings and errors #147485

Closed
MichaelMarcialis opened this issue Dec 13, 2022 · 1 comment · Fixed by #149262
Closed
Labels
Feature:Lens impact:medium Addressing this issue will have a medium level of impact on the quality/strength of our product. Team:Visualizations Visualization editors, elastic-charts and infrastructure

Comments

@MichaelMarcialis
Copy link
Contributor

MichaelMarcialis commented Dec 13, 2022

Lens currently presents warnings and errors in inconsistent ways. Within the Lens editor, warnings are listed in a warning popover that is triggered by a warning count button in the toolbar area. Errors can be either shown directly on the workspace or on individual dimension items. Outside of the Lens editor (in dashboards or embeddables), warnings are again listed in a warning popover that is triggered by a warning count button in the bottom-left corner of the visualization. Errors are only shown in the workspace. I think some improvements could be made on our part to consolidate warnings and errors together and ensure they are presented in a consistent and predictable manner for our users.

Additionally, per conversations happening within the related issues listed below, we're now discussing the possibility of allowing visualizations to still be rendered (if possible), regardless of the presence of errors/warnings. This would allow us to to at least show users what we are able to in instances where other aspects of a visualization can still be rendered and possibly be of value (will be beneficial for solutions and integration dashboards). Assuming we proceed with this direction, we can no longer assume that the workspace will be a viable place to house error messaging. In addition to the aforementioned desire consolidate and bring consistency to our presentation of errors and warnings, I'm thinking it may be prudent to explore the following:

  • Within the Lens editor, add the ability to display a warning or an error on an offending dimension item (or dimension group) whenever possible (whereas we currently only do this for errors).

  • Within the Lens editor and for dashboard/embedded Lens visualizations, list both errors and warnings in a popover triggered by an error/warning count button (whereas we currently only do this for warnings). This list can include all general visualization errors and warnings as well as those that are specific to individual dimensions (even if it repeats issues already shown at individual dimension items).

  • In both of the above scenarios, make it clear to distinguish between error and warning using iconography, color, etc.

If this is of interest, we'll need to come up with some concrete criteria to determine what is a warning versus what is an error. My current thinking is that anything that is always going to be unexpected or undesired by a user should always be considered an error (ex. deletion of a runtime field that was used in a dimension aggregation). Alternatively, if the issue isn't guaranteed to be unexpected or undesired but we want the user to be made aware, it should be considered a warning (ex. unexpected arrays values present in a field).

This will likely require some degree of design support for the creation of new iconography and guidance on how these consolidated warnings and errors should appear in different locations/scenarios.

Error in workspace example

image

Error on dimension item example

image

Warning in toolbar example

image

Related issues:

CCing @andrewctate.

@MichaelMarcialis MichaelMarcialis added Team:Visualizations Visualization editors, elastic-charts and infrastructure Feature:Lens labels Dec 13, 2022
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-visualizations @elastic/kibana-visualizations-external (Team:Visualizations)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature:Lens impact:medium Addressing this issue will have a medium level of impact on the quality/strength of our product. Team:Visualizations Visualization editors, elastic-charts and infrastructure
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants