Skip to content

SAT Monitoring Specification

Spec

The specification for Monitoring has the following fields.

The specification is not entirely finalised or fixed. Field names and types may change over the course of the project.

Types

RawMetric

No description available

name

string (required)
Name of the raw metric

sensor

string (required)
Sensor type

config

map (required)
Configuration for the metric e.g. scope_contexts: k8s.cgroup.cpu results-aggregation: SUM

collection_frequency

string (required)
Frequency of collection e.g. "30 sec"

collection_output

string (required)
Output type e.g. "all"

CompositeMetric

Composite metric definition.

name

string (required)
Name of the composite metric

formula

string (required)
Formula for the composite metric e.g. mean( cpu_util_instance )

collection_frequency

string (required)
Frequency of collection e.g. "30 sec"

collection_output

string (required)
Output type e.g. "all"

window_type

string (required)
Type of window e.g. "sliding"

window_size

string (required)
Size of the window e.g. "5 min"

grouping

string (required)
Grouping type e.g. "per_zone", "per_host", "per_region" # possibly "cross-swarms"

SLO

Service Level Objective (SLO) data type.

name

string (required)
Name of the SLO

metric

string
Name of the metric to apply the SLO on

operator

string
Operator for the SLO e.g. ">"

threshold

float
Threshold value for the SLO e.g. 80.0

and_list

list
List of SLOs to AND together

or_list

list
List of SLOs to OR together

constraint

string
Constraint for the SLO e.g. "cpu_util_prct > 80"