Resources / SLO

SLO

A service level objective: how often a product must be good, measured over a window, with the error budget and burn rates computed from samples (spec 0047 section 6).

Overview

APIplatform.etorm.com/v1alpha1
Resourceslos (cluster-scoped inside its cluster)
Short namesslo
Available inthe platform and project clusters
Statuswritten by a controller through /status

Minimal example

apiVersion: platform.etorm.com/v1alpha1
kind: SLO
metadata:
  name: example
spec:
  targetPercent: 50
  indicator: {}

Spec

FieldTypeRequiredDefaultAllowedDescription
targetPercentnumberyes50 to 99.999The share of samples that must be good over the window, in percent (for example 99.9).
windowSecondsinteger25920003600 to 7776000The window the objective is measured over (default 30 days).
sampleSecondsinteger30060 to 3600How often the indicator is sampled. Each sample is one write, so the default is five minutes.
fastBurnnumber14.4Burn rate over the last hour at which the objective counts as burning.
slowBurnnumber6Burn rate over the last six hours at which the objective counts as burning.
indicatorobjectyesWhat is sampled: exactly one of an Intent's Ready condition or a public probe.
indicator.intentRefobjectAn Intent in the same cluster: a sample is good when it is Ready.
indicator.intentRef.namestringyesName of the Intent.
indicator.probeobjectA public URL: a sample is good when it answers as expected.
indicator.probe.urlstringyesup to 512 charactersThe address to request with GET.
indicator.probe.expectCodeinteger200The HTTP status of a good answer.
indicator.probe.expectTextstringup to 256 charactersText a good answer contains.

Status

FieldTypeRequiredDefaultAllowedDescription
phasestring (one of)Pending, Ready, Burning, ExhaustedPending before the first sample, Ready while the budget lasts and no burn alert fires, Burning while one fires, Exhausted when the budget is spent.
statestring (one of)Healthy, Burning, Exhausted, UnknownHealthy while the budget lasts and no burn alert fires; Burning while one fires; Exhausted when the budget is spent.
goodintegerGood samples in the window.
totalintegerSamples in the window.
budgetRemainingnumberFraction of the error budget left, as a share of the whole window (1 is all of it, 0 none, negative overspent).
burnRate1hnumberHow many times faster than allowed the budget burned over the last hour.
burnRate6hnumberThe same over the last six hours.
lastSampleAtintegerUnix time of the newest sample.
recentstringThe last 72 samples, oldest first, as a string of 1 (good) and 0 (bad).
hourlylist of objectSamples per hour over the window, oldest first (bounded by the window).
hourly[].hourintegerUnix time of the start of the hour.
hourly[].goodintegerGood samples in the hour.
hourly[].totalintegerSamples in the hour.
conditionslist of objectReady (budget left, not burning) and Degraded (burning), spec 0047 section 2.
conditions[].typestringReady or Degraded.
conditions[].statusstringTrue, False or Unknown.
conditions[].reasonstringA word from the reason registry.
conditions[].messagestringA sentence.

Columns in listings

ColumnFrom
Target.spec.targetPercent
Budget-Left.status.budgetRemaining
Burn-1h.status.burnRate1h
State.status.state
Phase.status.phase

All resources