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

[SLO] Create an embeddable alert summary #167575

Open
6 of 11 tasks
mgiota opened this issue Sep 28, 2023 · 7 comments
Open
6 of 11 tasks

[SLO] Create an embeddable alert summary #167575

mgiota opened this issue Sep 28, 2023 · 7 comments
Assignees
Labels
Feature:SLO needs-refinement A reason and acceptance criteria need to be defined for this issue Team:obs-ux-management Observability Management User Experience Team

Comments

@mgiota
Copy link
Contributor

mgiota commented Sep 28, 2023

Slack Thread

🍒 Summary

We should allow users to add an alerts summary to their dashboards with predefined filters. This would allow SREs to see a summary of the alerts for the SLOs they are viewing on the dashboard.

🎨 Design requirements

  • Select multiple SLOs
  • Add KQL query for additional filters the alerts
  • @maciejforcone to provide updated design for current alert summary widget
  • Empty States:
    • When there are no rules
    • When there are no active or recovered alerts

Acceptance criteria

Screenshot 2023-11-16 at 13 51 37

Tasks

@mgiota mgiota added Team: Actionable Observability - DEPRECATED For Observability Alerting and SLOs use "Team:obs-ux-management", for AIops "Team:obs-knowledge" Feature:SLO labels Sep 28, 2023
@elasticmachine
Copy link
Contributor

Pinging @elastic/actionable-observability (Team: Actionable Observability)

@mgiota mgiota self-assigned this Oct 25, 2023
@simianhacker simianhacker changed the title [SLO] Create an embeddable alert table [SLO] Create an embeddable alert summary Oct 27, 2023
@mgiota
Copy link
Contributor Author

mgiota commented Nov 7, 2023

According to the [Slack thread](Slack thread) of this issue, untracked alerts shouldn't be included in the calculation of total alerts. Total alerts = Active + Recovered

Update: We will not include Total alerts in the widget, just Active Alerts.

@mgiota mgiota added the Team:obs-ux-management Observability Management User Experience Team label Nov 8, 2023
@elasticmachine
Copy link
Contributor

Pinging @elastic/obs-ux-management-team (Team:obs-ux-management)

@mgiota
Copy link
Contributor Author

mgiota commented Nov 8, 2023

I summarize here the points that were discussed in the Slack Thread with @maciejforcone while refining this issue

  • Shall we display total number of alerts or shall we just focus on the number of Active alerts? (leave out recovered and untracked alerts).
  • Technically I managed to display the alerts table in the embeddable, so we are thinking to display the table as well.
    • One question we had is if it makes sense to show only active alerts
    • Leave it to the user to show also recovered alerts
    • Does it make sense to the team to display the table as well or shall we focus only to the summary widget as part of this ticket.

@mgiota
Copy link
Contributor Author

mgiota commented Nov 9, 2023

Update:

  • We will focus on the Alert Summary widget first and later on we can make it configurable so that user can select what else they might want to see list of alerts, activity chart, possibly recovered alerts.

  • We will show only number of Active alerts (no recovered alerts)

  • The UI will look very similar to the current SLO Overview widget, but we decided not to use the Metric chart, because it doesn't support badges at the moment and we need badges for displaying the selected SLO names.

  • Because the user can select many SLOs and there is of course not much space, we decided to display only the first one (truncated if needed) with a +5 more badge Screenshot 2023-11-09 at 13 56 00

  • That's why we need to support the Edit settings option in the embeddable, which will open the SLO modal configuration with the selected SLOs. _Technically the Edit settings can be achieved by adding triggers and actions to the embeddable (I will use Links and ML Anomaly Detection embeddables as an inspiration on how to do this)

Screenshot 2023-11-09 at 13 50 46
  • We need to set an initial width and height to the alert embeddable similar to this
  • Clicking on the alert widget leads to Observabilty Alerts pages filtered by sloIds, sloInstanceIds and active status
  • Support empty states
  • Should honor dashboard's time picker
  • Should honor manual refresh button

@emma-raffenne emma-raffenne removed the Team: Actionable Observability - DEPRECATED For Observability Alerting and SLOs use "Team:obs-ux-management", for AIops "Team:obs-knowledge" label Nov 9, 2023
@mgiota
Copy link
Contributor Author

mgiota commented Nov 13, 2023

@maciejforcone When user selects multiple SLOs, where one can have active alerts and the other one has no active alerts (could be either 0 alerts or no alert rules), how do we display it with current design? What color has the widget, what is the title and what is the badge color of the selected SLOs? Combining the information of multiple SLOs with current design is restrictive. What do you think? Maybe we shouldn't allow the selection of multiple SLOs? Any other suggestion?

@mgiota
Copy link
Contributor Author

mgiota commented Feb 15, 2024

@maciejforcone Does it make sense to still work on this one? Since the Overview embeddable now shows the number of active alerts (for one SLO), I was thinking maybe this is redundant. I can continue working on this one, if you think it will be useful information for the user though.

@jasonrhodes jasonrhodes added the needs-refinement A reason and acceptance criteria need to be defined for this issue label Jun 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature:SLO needs-refinement A reason and acceptance criteria need to be defined for this issue Team:obs-ux-management Observability Management User Experience Team
Projects
None yet
Development

No branches or pull requests

5 participants