slo

Documentation

Index

• Constants
• Variables
• type Alerting
• type BoolGaugeIndicator
• type Indicator
• type IndicatorType
• type LatencyIndicator
• type LatencyNativeIndicator
• type Metric
  • func (m Metric) Metric() string
• type MultiBurnRateAlert
• type Objective
  • func (o Objective) AlertName() string
  • func (o Objective) AlertNameAbsent() string
  • func (o Objective) Alerts() ([]MultiBurnRateAlert, error)
  • func (o Objective) Burnrate(timerange time.Duration) string
  • func (o Objective) BurnrateName(rate time.Duration) string
  • func (o Objective) Burnrates() (monitoringv1.RuleGroup, error)
  • func (o Objective) DurationRange(timerange time.Duration, percentile float64) string
  • func (o Objective) ErrorsRange(timerange time.Duration) string
  • func (o Objective) Exhausts(factor float64) model.Duration
  • func (o Objective) GenericRules() (monitoringv1.RuleGroup, error)
  • func (o Objective) Grouping() []string
  • func (o Objective) HasWindows(short, long model.Duration) (Window, bool)
  • func (o Objective) IncreaseRules() (monitoringv1.RuleGroup, error)
  • func (o Objective) IndicatorType() IndicatorType
  • func (o Objective) Name() string
  • func (o Objective) QueryBurnrate(timerange time.Duration, groupingMatchers []*labels.Matcher) (string, error)
  • func (o Objective) QueryErrorBudget() string
  • func (o Objective) QueryErrors(window model.Duration) string
  • func (o Objective) QueryTotal(window model.Duration) string
  • func (o Objective) RequestRange(timerange time.Duration) string
  • func (o Objective) Windows() []Window
• type RatioIndicator
• type Window
  • func Windows(sloWindow time.Duration) []Window

Constants

const (
	// PropagationLabelsPrefix provides a way to propagate labels from the
	// ObjectMeta to the PrometheusRule.
	PropagationLabelsPrefix = "pyrra.dev/"
)

Variables

var ErrGroupingUnsupported = errors.New("objective with grouping not supported in generic rules")

Types

type Alerting

type Alerting struct {
	Disabled   bool // deprecated, use Burnrates instead
	Burnrates  bool
	Absent     bool
	Name       string
	AbsentName string
}

type BoolGaugeIndicator

type BoolGaugeIndicator struct {
	Metric
	Grouping []string
}

type Indicator

type Indicator struct {
	Ratio         *RatioIndicator
	Latency       *LatencyIndicator
	LatencyNative *LatencyNativeIndicator
	BoolGauge     *BoolGaugeIndicator
}

type IndicatorType

type IndicatorType int

const (
	Unknown       IndicatorType = iota
	Ratio         IndicatorType = iota
	Latency       IndicatorType = iota
	LatencyNative IndicatorType = iota
	BoolGauge     IndicatorType = iota
)

type LatencyIndicator

type LatencyIndicator struct {
	Success  Metric
	Total    Metric
	Grouping []string
}

type LatencyNativeIndicator

type LatencyNativeIndicator struct {
	Latency  model.Duration
	Total    Metric
	Grouping []string
}

type Metric

type Metric struct {
	Name          string
	LabelMatchers []*labels.Matcher
}

func (Metric) Metric

func (m Metric) Metric() string

type MultiBurnRateAlert

type MultiBurnRateAlert struct {
	Severity string
	Short    time.Duration
	Long     time.Duration
	For      time.Duration
	Factor   float64

	QueryShort string
	QueryLong  string
}

type Objective

type Objective struct {
	Labels      labels.Labels
	Annotations map[string]string
	Description string
	Target      float64
	Window      model.Duration
	Config      string

	Alerting  Alerting
	Indicator Indicator
}

func (Objective) AlertName

func (o Objective) AlertName() string

func (Objective) AlertNameAbsent

func (o Objective) AlertNameAbsent() string

func (Objective) Alerts

func (o Objective) Alerts() ([]MultiBurnRateAlert, error)

func (Objective) Burnrate

func (o Objective) Burnrate(timerange time.Duration) string

func (Objective) BurnrateName

func (o Objective) BurnrateName(rate time.Duration) string

func (Objective) Burnrates

func (o Objective) Burnrates() (monitoringv1.RuleGroup, error)

func (Objective) DurationRange

func (o Objective) DurationRange(timerange time.Duration, percentile float64) string

func (Objective) ErrorsRange

func (o Objective) ErrorsRange(timerange time.Duration) string

func (Objective) Exhausts

func (o Objective) Exhausts(factor float64) model.Duration

func (Objective) GenericRules

func (o Objective) GenericRules() (monitoringv1.RuleGroup, error)

func (Objective) Grouping

func (o Objective) Grouping() []string

func (Objective) HasWindows

func (o Objective) HasWindows(short, long model.Duration) (Window, bool)

func (Objective) IncreaseRules

func (o Objective) IncreaseRules() (monitoringv1.RuleGroup, error)

func (Objective) IndicatorType

func (o Objective) IndicatorType() IndicatorType

func (Objective) Name

func (o Objective) Name() string

func (Objective) QueryBurnrate

func (o Objective) QueryBurnrate(timerange time.Duration, groupingMatchers []*labels.Matcher) (string, error)

func (Objective) QueryErrorBudget

func (o Objective) QueryErrorBudget() string

func (Objective) QueryErrors

func (o Objective) QueryErrors(window model.Duration) string

QueryErrors returns a PromQL query to get the amount of request errors during the window.

func (Objective) QueryTotal

func (o Objective) QueryTotal(window model.Duration) string

QueryTotal returns a PromQL query to get the total amount of requests served during the window.

func (Objective) RequestRange

func (o Objective) RequestRange(timerange time.Duration) string

func (Objective) Windows

func (o Objective) Windows() []Window

type RatioIndicator

type RatioIndicator struct {
	Errors   Metric
	Total    Metric
	Grouping []string
}

type Window

type Window struct {
	Severity severity
	For      time.Duration
	Long     time.Duration
	Short    time.Duration
	Factor   float64
}

func Windows

func Windows(sloWindow time.Duration) []Window