spec

Documentation

Index

• type Alert
• type Alerter
• type BurnRateAlert
  • func (a *BurnRateAlert) Alerter() Alerter
  • func (a *BurnRateAlert) ConsumedBudgetRatio() float64
  • func (a *BurnRateAlert) Name() string
  • func (a *BurnRateAlert) Window() BurnRateAlertWindow
• type BurnRateAlertMultiWindows
  • func (w *BurnRateAlertMultiWindows) LongWindow() Window
  • func (w *BurnRateAlertMultiWindows) ShortWindow() Window
  • func (w *BurnRateAlertMultiWindows) Window() Window
• type BurnRateAlertSingleWindow
  • func (w *BurnRateAlertSingleWindow) Window() Window
• type BurnRateAlertWindow
• type CalendarWindow
  • func (w *CalendarWindow) Duration() Duration
  • func (w *CalendarWindow) Name() string
  • func (w *CalendarWindow) Prometheus() *PrometheusWindow
  • func (w *CalendarWindow) Start() time.Time
• type Duration
• type ErrorBudgetAlert
  • func (a *ErrorBudgetAlert) Alerter() Alerter
  • func (a *ErrorBudgetAlert) ConsumedBudgetRatio() float64
  • func (a *ErrorBudgetAlert) Name() string
• type Indicator
• type Objective
  • func (o *Objective) Ratio() float64
  • func (o *Objective) Window() Window
• type PrometheusAlerter
  • func (a *PrometheusAlerter) Annotations() map[string]string
  • func (a *PrometheusAlerter) Labels() map[string]string
  • func (a *PrometheusAlerter) Name() string
• type PrometheusIndicator
  • func (pi *PrometheusIndicator) ErrorRatio() string
  • func (pi *PrometheusIndicator) Level() []string
• type PrometheusWindow
  • func (pw *PrometheusWindow) EvaluationInterval() Duration
• type RollingWindow
  • func (w *RollingWindow) Duration() Duration
  • func (w *RollingWindow) Name() string
  • func (w *RollingWindow) Prometheus() *PrometheusWindow
• type SLO
  • func (s *SLO) Alerts() []Alert
  • func (s *SLO) Annotations() map[string]string
  • func (s *SLO) Indicator() Indicator
  • func (s *SLO) Labels() map[string]string
  • func (s *SLO) Name() string
  • func (s *SLO) Objective() *Objective
  • func (s *SLO) Windows() []Window
• type Spec
  • func ToSpec(c *configspec.SpecConfig) (*Spec, error)
  • func (s *Spec) Annotations() map[string]string
  • func (s *Spec) Labels() map[string]string
  • func (s *Spec) Name() string
  • func (s *Spec) SLOs() []*SLO
• type Window

Types

type Alert

type Alert interface {
	Name() string
	Alerter() Alerter
}

type Alerter

type Alerter interface {
}

type BurnRateAlert

type BurnRateAlert struct {
	// contains filtered or unexported fields
}

func (*BurnRateAlert) Alerter

func (a *BurnRateAlert) Alerter() Alerter

func (*BurnRateAlert) ConsumedBudgetRatio

func (a *BurnRateAlert) ConsumedBudgetRatio() float64

func (*BurnRateAlert) Name

func (a *BurnRateAlert) Name() string

func (*BurnRateAlert) Window

func (a *BurnRateAlert) Window() BurnRateAlertWindow

type BurnRateAlertMultiWindows

type BurnRateAlertMultiWindows struct {
	// contains filtered or unexported fields
}

func (*BurnRateAlertMultiWindows) LongWindow

func (w *BurnRateAlertMultiWindows) LongWindow() Window

func (*BurnRateAlertMultiWindows) ShortWindow

func (w *BurnRateAlertMultiWindows) ShortWindow() Window

func (*BurnRateAlertMultiWindows) Window

func (w *BurnRateAlertMultiWindows) Window() Window

type BurnRateAlertSingleWindow

type BurnRateAlertSingleWindow struct {
	// contains filtered or unexported fields
}

func (*BurnRateAlertSingleWindow) Window

func (w *BurnRateAlertSingleWindow) Window() Window

type BurnRateAlertWindow

type BurnRateAlertWindow interface {
	Window() Window
}

type CalendarWindow

type CalendarWindow struct {
	// contains filtered or unexported fields
}

func (*CalendarWindow) Duration

func (w *CalendarWindow) Duration() Duration

func (*CalendarWindow) Name

func (w *CalendarWindow) Name() string

func (*CalendarWindow) Prometheus

func (w *CalendarWindow) Prometheus() *PrometheusWindow

func (*CalendarWindow) Start

func (w *CalendarWindow) Start() time.Time

type Duration

type Duration = model.Duration

type ErrorBudgetAlert

type ErrorBudgetAlert struct {
	// contains filtered or unexported fields
}

func (*ErrorBudgetAlert) Alerter

func (a *ErrorBudgetAlert) Alerter() Alerter

func (*ErrorBudgetAlert) ConsumedBudgetRatio

func (a *ErrorBudgetAlert) ConsumedBudgetRatio() float64

func (*ErrorBudgetAlert) Name

func (a *ErrorBudgetAlert) Name() string

type Indicator

type Indicator interface {
}

type Objective

type Objective struct {
	// contains filtered or unexported fields
}

func (*Objective) Ratio

func (o *Objective) Ratio() float64

func (*Objective) Window

func (o *Objective) Window() Window

type PrometheusAlerter

type PrometheusAlerter struct {
	// contains filtered or unexported fields
}

func (*PrometheusAlerter) Annotations

func (a *PrometheusAlerter) Annotations() map[string]string

func (*PrometheusAlerter) Labels

func (a *PrometheusAlerter) Labels() map[string]string

func (*PrometheusAlerter) Name

func (a *PrometheusAlerter) Name() string

type PrometheusIndicator

type PrometheusIndicator struct {
	// contains filtered or unexported fields
}

func (*PrometheusIndicator) ErrorRatio

func (pi *PrometheusIndicator) ErrorRatio() string

func (*PrometheusIndicator) Level

func (pi *PrometheusIndicator) Level() []string

type PrometheusWindow

type PrometheusWindow struct {
	// contains filtered or unexported fields
}

func (*PrometheusWindow) EvaluationInterval

func (pw *PrometheusWindow) EvaluationInterval() Duration

type RollingWindow

type RollingWindow struct {
	// contains filtered or unexported fields
}

func (*RollingWindow) Duration

func (w *RollingWindow) Duration() Duration

func (*RollingWindow) Name

func (w *RollingWindow) Name() string

func (*RollingWindow) Prometheus

func (w *RollingWindow) Prometheus() *PrometheusWindow

type SLO

type SLO struct {
	// contains filtered or unexported fields
}

func (*SLO) Alerts

func (s *SLO) Alerts() []Alert

func (*SLO) Annotations

func (s *SLO) Annotations() map[string]string

func (*SLO) Indicator

func (s *SLO) Indicator() Indicator

func (*SLO) Labels

func (s *SLO) Labels() map[string]string

func (*SLO) Name

func (s *SLO) Name() string

func (*SLO) Objective

func (s *SLO) Objective() *Objective

func (*SLO) Windows

func (s *SLO) Windows() []Window

type Spec

type Spec struct {
	// contains filtered or unexported fields
}

func ToSpec

func ToSpec(c *configspec.SpecConfig) (*Spec, error)

func (*Spec) Annotations

func (s *Spec) Annotations() map[string]string

func (*Spec) Labels

func (s *Spec) Labels() map[string]string

func (*Spec) Name

func (s *Spec) Name() string

func (*Spec) SLOs

func (s *Spec) SLOs() []*SLO

type Window

type Window interface {
	Name() string
	Duration() Duration
	Prometheus() *PrometheusWindow
}