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

mgr/dashboard: Add a Silence button shortcut to alert notifications #47968

Merged
merged 1 commit into from Sep 13, 2022

Conversation

aaSharma14
Copy link
Contributor

@aaSharma14 aaSharma14 commented Sep 5, 2022

Add a shortcut to create a silence from the alert notification

Fixes: https://tracker.ceph.com/issues/57457
Signed-off-by: Aashish Sharmaaasharma@redhat.com

Screenshot from 2022-09-06 17-04-27

Contribution Guidelines

Checklist

  • Tracker (select at least one)
    • References tracker ticket
    • Very recent bug; references commit where it was introduced
    • New feature (ticket optional)
    • Doc update (no ticket needed)
    • Code cleanup (no ticket needed)
  • Component impact
    • Affects Dashboard, opened tracker ticket
    • Affects Orchestrator, opened tracker ticket
    • No impact that needs to be tracked
  • Documentation (select at least one)
    • Updates relevant documentation
    • No doc update is appropriate
  • Tests (select at least one)
Show available Jenkins commands
  • jenkins retest this please
  • jenkins test classic perf
  • jenkins test crimson perf
  • jenkins test signed
  • jenkins test make check
  • jenkins test make check arm64
  • jenkins test submodules
  • jenkins test dashboard
  • jenkins test dashboard cephadm
  • jenkins test api
  • jenkins test docs
  • jenkins render docs
  • jenkins test ceph-volume all
  • jenkins test ceph-volume tox
  • jenkins test windows

@aaSharma14 aaSharma14 requested a review from a team as a code owner September 5, 2022 05:58
@aaSharma14 aaSharma14 added this to In progress in Dashboard via automation Sep 5, 2022
@github-actions github-actions bot added the pybind label Sep 5, 2022
@epuertat
Copy link
Member

epuertat commented Sep 5, 2022

@aaSharma14 just a summary of my suggestions in the daily today:

  • I'd replace the "Silence" button with an icon action (🔕 , font-awesome bell-slash), and place it together the trash-bin icon.
  • Creating a silence currently requires filling out a couple of mandatory fields (which I always found annoying). What about pre-populating those fields (e.g.: autogenerated comment with the username and timestamp)?

That would be a user experience consistent/similar to what we have in our mobile phones: muting notifications is a 1-click workflow.

@aaSharma14 aaSharma14 force-pushed the add-alert-silence-button branch 3 times, most recently from 3201b0a to f6dd30f Compare September 5, 2022 11:46
@aaSharma14
Copy link
Contributor Author

@aaSharma14 just a summary of my suggestions in the daily today:

  • I'd replace the "Silence" button with an icon action (no_bell , font-awesome bell-slash), and place it together the trash-bin icon.
  • Creating a silence currently requires filling out a couple of mandatory fields (which I always found annoying). What about pre-populating those fields (e.g.: autogenerated comment with the username and timestamp)?

That would be a user experience consistent/similar to what we have in our mobile phones: muting notifications is a 1-click workflow.

Thank you for the suggestions @epuertat , I have updated the PR accordingly.

Copy link
Member

@epuertat epuertat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks really good, @aaSharma14 !

Did you try the bell icon in black&white, same as the tray can icon (just for consistency)?

image

After that I get the following:

image

That "created silence" notification is hard to relate to the previous action, since that uuid cannot be easily connected with that, and it's a bit redundant. What about any of these?:

  • Displaying a user friendly (silence) notification instead:
    image
  • Update the silenced alert (replacing the slashed bell icon with a regular bell icon, so clicking in that will un-silence the alert; and also emphasizing the fact that the alert is silenced with a large icon and gray-ish colors):
    image

BTW, I started working on a design to improve the notification section, would you like to get involved? https://docs.google.com/document/d/1-cedKvB3_6zQvoDbwFrWasXmv9bWLeJUCmRcJNAe3Mg/edit

@aaSharma14
Copy link
Contributor Author

Looks really good, @aaSharma14 !
Thanks @epuertat

Did you try the bell icon in black&white, same as the tray can icon (just for consistency)?
Yes, sure I'l update that

image

After that I get the following:

image

That "created silence" notification is hard to relate to the previous action, since that uuid cannot be easily connected with that, and it's a bit redundant. What about any of these?:

  • Displaying a user friendly (silence) notification instead:
    image
  • Update the silenced alert (replacing the slashed bell icon with a regular bell icon, so clicking in that will un-silence the alert; and also emphasizing the fact that the alert is silenced with a large icon and gray-ish colors):
    image
    Am not sure if this is possible because a silence can be created on 4 different filters, For example - If a silence is created on the job or instance attribute, it can silence multiple alerts at once, and we do not get the notifications for all the alerts that have been silenced by that filter. In short, silence notification can be for a group of alerts as well

BTW, I started working on a design to improve the notification section, would you like to get involved? https://docs.google.com/document/d/1-cedKvB3_6zQvoDbwFrWasXmv9bWLeJUCmRcJNAe3Mg/edit
Yeah sure, I will love to get involved in this.

@aaSharma14 aaSharma14 force-pushed the add-alert-silence-button branch 3 times, most recently from e1a2157 to 1fd4cdf Compare September 7, 2022 11:41
Copy link
Member

@epuertat epuertat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks ok to me, but there are still a couple of issues:

  • The alert silence id is still hard to relate to the actual alert:
    image
  • There's no visual feedback in the notifications on whether an alert was already muted or not (in fact you can create multiple silences for the same alert). That's why I was suggesting that once the "alert icon" has been clicked AND succeeded, it shoult be either disabled or toggled to an "unsilence alert" action:
    image

Dashboard automation moved this from In progress to Reviewer approved Sep 7, 2022
Copy link
Member

@nizamial09 nizamial09 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Awesome work here @aaSharma14 minor comments from me.

As we discussed in standup, let's go with this and find a way to improve the notification sidebar.

Also can you create one tracker for the changes we discussed in standup-

@nizamial09
Copy link
Member

Also could you please update the description with the latest screenshots.

@aaSharma14
Copy link
Contributor Author

jenkins test dashboard

@aaSharma14
Copy link
Contributor Author

jenkins test dashboard cephadm

2 similar comments
@aaSharma14
Copy link
Contributor Author

jenkins test dashboard cephadm

@aaSharma14
Copy link
Contributor Author

jenkins test dashboard cephadm

@nizamial09 nizamial09 moved this from Reviewer approved to Ready-to-merge in Dashboard Sep 13, 2022
@nizamial09
Copy link
Member

cephadm e2e failure tracked here: https://tracker.ceph.com/issues/57511

@nizamial09 nizamial09 merged commit edf3c0d into ceph:main Sep 13, 2022
12 of 13 checks passed
Dashboard automation moved this from Ready-to-merge to Done Sep 13, 2022
@nizamial09 nizamial09 deleted the add-alert-silence-button branch September 13, 2022 05:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
Dashboard
  
Done
3 participants