SLO Summary Widget

SLO Summary Widget

Setup

Use the SLO Summary widget to track your SLOs (Service Level Objectives) on screenboards and timeboards. You can use Datadog’s Service Level Objectives page to create new SLOs and view all existing ones. You can then select an existing SLO and use the SLO Summary widget to display it on any dashboard.

Configuration

  1. On the dashboard page, add an SLO Summary widget.
  2. Select an SLO from the dropdown menu.
  3. Select up to three different time windows.

Note: The Global Time allows you to display your SLO’s status and error budget over arbitrary time periods within the past 90 days. Additionally, you can specify an optional unique SLO target for the arbitrary time period. Specifying an SLO target is required to display an error budget and for being able to color code the SLO status value as green or red. If no SLO target is specified only the SLO status is shown and the font color remains gray.

Options

Display preferences

Select whether to show or hide remaining error budget by toggling the Show error budget option. If you are visualizing a monitor-based SLO with multiple groups or multiple monitors, select your View mode:

  • For monitor-based SLOs configured with a single monitor broken into multiple groups, there are the following three view modes:

    • Status: displays the overall SLO status percentages and targets
    • Groups: displays a table of status percentages for each group
    • Both: displays both the overall SLO status percentages and targets and table of status percentages for each group
  • For monitor-based SLOs configured with multiple monitors, there are the following three view modes:

    • Status: displays the overall SLO status percentages and targets
    • Monitors: displays a table of status percentages for each monitor
    • Both: displays both the overall SLO status percentages and targets and table of status percentages for each monitor

Note: When the Global Time time window option is selected you can only use the Status view mode.

Title

Display a custom title for your widget by checking the Show a title check box:

You can optionally define the title’s size and alignment.

API

This widget can be used with the Dashboards API. See the Dashboards API documentation for additional reference.

The dedicated widget JSON schema definition for the service map widget is:

Expand All

Field

Type

Description

global_time_target

string

Defined global time target.

show_error_budget

boolean

Defined error budget.

slo_id

string

ID of the SLO displayed.

time_windows

[string]

Times being monitored.

title

string

Title of the widget.

title_align

enum

How to align the text on the widget. Allowed enum values: center,left,right

title_size

string

Size of the title.

type [required]

enum

Type of the SLO widget. Allowed enum values: slo

view_mode

enum

Define how you want the SLO to be displayed. Allowed enum values: overall,component,both

view_type [required]

string

Type of view displayed by the widget.

{
  "global_time_target": "string",
  "show_error_budget": false,
  "slo_id": "string",
  "time_windows": [],
  "title": "string",
  "title_align": "string",
  "title_size": "string",
  "type": "slo",
  "view_mode": "string",
  "view_type": "detail"
}

Further Reading

Additional helpful documentation, links, and articles: