document

type Document struct {
	// Name is the name of the SLO specification.
	Name string `yaml:"name" json:"name"`
	// Labels are the labels of the SLO specification.
	Labels map[string]string `yaml:"labels" json:"labels"`
	// Annotations are the annotations of the SLO specification.
	Annotations map[string]string `yaml:"annotations" json:"annotations"`
	// SLOs are SLO configurations.
	SLOs []SLO `yaml:"slos,omitempty" json:"slos,omitempty"`
}

type Indicator struct {
	// Source is the metric source of the indicator (e.g., prometheus, ...)
	Source string `yaml:"source" json:"source"`
	// Query is the query of the indicator.
	Query Query `yaml:"query" json:"query"`
}

type Objective struct {
	// Ratio is the target ratio of the SLO.
	Ratio float64 `yaml:"ratio" json:"ratio"`
	// WindowRef is the window name that refers to a window defined in SLOConfig.Windows.
	Window Window `yaml:"window" json:"window"`
}

type PrometheusQuery struct {
	ErrorRatio string `yaml:"errorRatio,omitempty" json:"errorRatio,omitempty"`
}

type Query interface {
	// contains filtered or unexported methods
}

type SLO struct {
	// Name is the name of the SLO.
	Name string `yaml:"name" json:"name"`
	// Labels are the labels of the SLO.
	Labels map[string]string `yaml:"labels" json:"labels"`
	// Annotations are the annotations of the SLO.
	Annotations map[string]string `yaml:"annotations" json:"annotations"`
	// Objective is the target of the SLO.
	Objective Objective `yaml:"objective" json:"objective"`
	// Indicator is the SLI for the SLO.
	Indicator Indicator `yaml:"indicator" json:"indicator"`
}

type Window struct {
	// Name is the name of the window.
	Name string `yaml:"name" json:"name"`
	// Type is the type of the window: either rolling or calendar.
	Type string `yaml:"type" json:"type"`
	// Duration is the duration of the window.
	Duration string `yaml:"duration" json:"duration"`
}