v1

README

v1

import "github.com/slok/sloth/pkg/prometheus/alertwindows/v1"

Index

• Constants
• type AlertWindows
• type PageWindow
• type QuickSlowWindow
• type Spec
• type TicketWindow
• type Window

Constants

const APIVersion = "sloth.slok.dev/v1"

const Kind = "AlertWindows"

type AlertWindows

type AlertWindows struct {
    Kind       string `yaml:"kind"`
    APIVersion string `yaml:"apiVersion"`
    Spec       Spec   `yaml:"spec"`
}

type PageWindow

PageWindow represents the configuration for page alerting.

type PageWindow struct {
    QuickSlowWindow `yaml:",inline"`
}

type QuickSlowWindow

type QuickSlowWindow struct {
    // Quick represents the windows for the quick alerting trigger.
    Quick Window `yaml:"quick"`
    // Slow represents the windows for the slow alerting trigger.
    Slow Window `yaml:"slow"`
}

type Spec

Spec represents the root type of the Alerting window.

type Spec struct {
    // SLOPeriod is the full slo period used for this windows.
    SLOPeriod prometheusmodel.Duration `yaml:"sloPeriod"`
    // Page represents the configuration for the page alerting windows.
    Page PageWindow `yaml:"page"`
    // Ticket represents the configuration for the ticket alerting windows.
    Ticket TicketWindow `yaml:"ticket"`
}

type TicketWindow

PageWindow represents the configuration for ticket alerting.

type TicketWindow struct {
    QuickSlowWindow `yaml:",inline"`
}

type Window

type Window struct {
    // ErrorBudgetPercent is the max error budget consumption allowed in the window.
    ErrorBudgetPercent float64 `yaml:"errorBudgetPercent"`
    // Shortwindow is the window that will stop the alerts when a huge amount of
    // error budget has been consumed but the error has already gone.
    ShortWindow prometheusmodel.Duration `yaml:"shortWindow"`
    // Longwindow is the window used to get the error budget for all the window.
    LongWindow prometheusmodel.Duration `yaml:"longWindow"`
}

Generated by gomarkdoc

Documentation

Index

• Constants
• type AlertWindows
• type PageWindow
• type QuickSlowWindow
• type Spec
• type TicketWindow
• type Window

Constants

const APIVersion = "sloth.slok.dev/v1"

const Kind = "AlertWindows"

Types

type AlertWindows

type AlertWindows struct {
	Kind       string `yaml:"kind"`
	APIVersion string `yaml:"apiVersion"`
	Spec       Spec   `yaml:"spec"`
}

type PageWindow

type PageWindow struct {
	QuickSlowWindow `yaml:",inline"`
}

PageWindow represents the configuration for page alerting.

type QuickSlowWindow

type QuickSlowWindow struct {
	// Quick represents the windows for the quick alerting trigger.
	Quick Window `yaml:"quick"`
	// Slow represents the windows for the slow alerting trigger.
	Slow Window `yaml:"slow"`
}

type Spec

type Spec struct {
	// SLOPeriod is the full slo period used for this windows.
	SLOPeriod prometheusmodel.Duration `yaml:"sloPeriod"`
	// Page represents the configuration for the page alerting windows.
	Page PageWindow `yaml:"page"`
	// Ticket represents the configuration for the ticket alerting windows.
	Ticket TicketWindow `yaml:"ticket"`
}

Spec represents the root type of the Alerting window.

type TicketWindow

type TicketWindow struct {
	QuickSlowWindow `yaml:",inline"`
}

PageWindow represents the configuration for ticket alerting.

type Window

type Window struct {
	// ErrorBudgetPercent is the max error budget consumption allowed in the window.
	ErrorBudgetPercent float64 `yaml:"errorBudgetPercent"`
	// Shortwindow is the window that will stop the alerts when a huge amount of
	// error budget has been consumed but the error has already gone.
	ShortWindow prometheusmodel.Duration `yaml:"shortWindow"`
	// Longwindow is the window used to get the error budget for all the window.
	LongWindow prometheusmodel.Duration `yaml:"longWindow"`
}