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

Add SLO dashboard panel docs #3503

Merged
merged 1 commit into from
Jan 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
23 changes: 20 additions & 3 deletions docs/en/observability/slo-overview.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,17 +31,34 @@ Burn rate:: The rate at which your service consumes your err

[discrete]
[[slo-in-elastic]]
== SLO Dashboard
From the SLO dashboard list, you can see all of your SLOs and a quick summary of what's happening in each one:
== SLO overview
From the SLO overview, you can see all of your SLOs and a quick summary of what's happening in each one:
Comment on lines +34 to +35
Copy link
Member Author

Choose a reason for hiding this comment

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

Note that I changed this from "SLO Dashboard" to "SLO overview".

  1. I don't see any indication in the product that this is called "SLO Dashboard."
  2. I wanted to reduce confusion between this content and the new "SLO Dashboard panels." Do you think this change is okay, @mdbirnstiehl ?


[role="screenshot"]
image::images/slo-dashboard.png[]

Click an SLO from the dashboard to see a detailed view. This view includes SLI history, error budget burn down charts, and current active alerts if you've set any <<slo-burn-rate-alert,SLO burn rate alert rules>> for the SLO.
Click an SLO to see a detailed view. This view includes SLI history, error budget burn down charts, and current active alerts if you've set any <<slo-burn-rate-alert,SLO burn rate alert rules>> for the SLO.

[role="screenshot"]
image::images/slo-detailed-view.png[]

[discrete]
[[slo-dashboard-panels]]
== SLO dashboard panels

SLO data is also available as Dashboard _panels_.
Panels allow you to curate custom data views and visualizations to bring clarity to your data.

Available SLO panels include:

* *SLO Overview*: Visualize a selected SLO's health, including name, current SLI value, target, and status.
* *SLO Alerts*: Visualize one or more SLO alerts, including status, rule name, duration, and reason. In addition, configure and update alerts, or create cases directly from the panel.

[role="screenshot"]
image::images/slo-dashboard-panel.png[]

See {kibana-ref}/dashboard.html[Dashboard and visualizations] to learn how to add panels to a Dashboard.

[discrete]
[[slo-overview-next-steps]]
== Next steps
Expand Down
Loading