slo

Documentation

Index

• type Class
• type Classes
  • func (c Classes) FindClass(name string) (*Class, error)
• type ClassesDefinition
• type ExprBlock
  • func (block *ExprBlock) ComputeExpr(window, le string) string
  • func (block *ExprBlock) ComputeQuantile(window string, quantile float64) string
  • func (block *ExprBlock) GetShortWindow() bool
• type Objectives
  • func (o *Objectives) LatencyBuckets() []string
• type SLO
  • func (slo *SLO) GenerateAlertRules(sloClass *Class, disableTicket bool) []rulefmt.RuleNode
  • func (slo *SLO) GenerateGroupRules(sloClass *Class, disableTicket bool) []rulefmt.RuleGroup
• type SLOSpec

Types

type Class

type Class struct {
	Name       string     `yaml:"name"`
	Objectives Objectives `yaml:"objectives"`
}

Class represents a template of objectives this is important to achieve scalable SLO policies read more at: https://landing.google.com/sre/workbook/chapters/alerting-on-slos/#alerting_at_scale

type Classes

type Classes []Class

func (Classes) FindClass

func (c Classes) FindClass(name string) (*Class, error)

FindClass finds for a given name, if not found return an error

type ClassesDefinition

type ClassesDefinition struct {
	Classes Classes `yaml:"classes"`
}

type ExprBlock

type ExprBlock struct {
	AlertMethod string           `yaml:"alertMethod"`
	AlertWindow string           `yaml:"alertWindow"`
	BurnRate    float64          `yaml:"burnRate"`
	AlertWait   string           `yaml:"alertWait"`
	Windows     []methods.Window `yaml:"windows"`
	ShortWindow *bool            `yaml:"shortWindow"`
	Buckets     []string         `yaml:"buckets"` // used to define buckets of histogram when using latency expression
	Expr        string           `yaml:"expr"`
}

func (*ExprBlock) ComputeExpr

func (block *ExprBlock) ComputeExpr(window, le string) string

func (*ExprBlock) ComputeQuantile

func (block *ExprBlock) ComputeQuantile(window string, quantile float64) string

func (*ExprBlock) GetShortWindow

func (block *ExprBlock) GetShortWindow() bool

type Objectives

type Objectives struct {
	Availability float64                 `yaml:"availability"`
	Latency      []methods.LatencyTarget `yaml:"latency"`
	Window       model.Duration          `yaml:"window"`
}

func (*Objectives) LatencyBuckets

func (o *Objectives) LatencyBuckets() []string

LatencyBuckets returns all boundaries of latencies is the same boundaries of a prometheus histogram (aka: le) used to calculate latency SLOs

type SLO

type SLO struct {
	Name       string `yaml:"name"`
	Class      string `yaml:"class"`
	Objectives Objectives

	HonorLabels bool `yaml:"honorLabels"`

	TrafficRateRecord     ExprBlock         `yaml:"trafficRateRecord"`
	ErrorRateRecord       ExprBlock         `yaml:"errorRateRecord"`
	LatencyRecord         ExprBlock         `yaml:"latencyRecord"`
	LatencyQuantileRecord ExprBlock         `yaml:"latencyQuantileRecord"`
	Labels                map[string]string `yaml:"labels"`
	Annotations           map[string]string `yaml:"annotations"`
}

func (*SLO) GenerateAlertRules

func (slo *SLO) GenerateAlertRules(sloClass *Class, disableTicket bool) []rulefmt.RuleNode

func (*SLO) GenerateGroupRules

func (slo *SLO) GenerateGroupRules(sloClass *Class, disableTicket bool) []rulefmt.RuleGroup

type SLOSpec

type SLOSpec struct {
	SLOS    []SLO   `yaml:"slos"`
	Classes Classes `yaml:"classes"`
}