SLO List Widget

Cette page n'est pas encore disponible en français, sa traduction est en cours.
Si vous avez des questions ou des retours sur notre projet de traduction actuel, n'hésitez pas à nous contacter.

The SLO List widget displays a subset of SLOs over their primary time window. All other configured time windows are available in the SLO’s side panel on the SLO page.

The SLO List widget displaying a list of SLOs

Setup

A search query defining the service as web-store in the SLO List widget editor

Configuration

  1. Add an SLO List widget to a dashboard.
  2. Use tags to filter the list of SLOs (such as service:foo, env:prod). Template variables are supported.
  3. Choose the maximum number of SLOs to display (the default is 100) and sort by either status or error budget.
  4. Optionally, give the widget a title.

When you are ready to create the widget, click Save.

API

This widget can be used with the Dashboards API. See the following table for the widget JSON schema definition:

Expand All

Champ

Type

Description

requests [required]

[object]

Array of one request object to display in the widget.

query [required]

object

Updated SLO List widget.

limit

int64

Maximum number of results to display in the table.

default: 100

query_string [required]

string

Widget query.

sort

[object]

Options for sorting results.

column [required]

string

Facet path for the column

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

request_type [required]

enum

Widget request type. Allowed enum values: slo_list

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 List widget. Allowed enum values: slo_list

default: slo_list

{
  "requests": [
    {
      "query": {
        "limit": "integer",
        "query_string": "env:prod AND service:my-app",
        "sort": [
          {
            "column": "",
            "order": "desc"
          }
        ]
      },
      "request_type": "slo_list"
    }
  ],
  "title": "string",
  "title_align": "string",
  "title_size": "string",
  "type": "slo_list"
}

Further Reading