slo

package
v0.10.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 30, 2026 License: Apache-2.0 Imports: 14 Imported by: 1

Documentation

Index

Constants

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

Variables

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

Functions

This section is empty.

Types

type Alerting added in v0.5.0 

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

type AlertingSeverities added in v0.10.0 

type AlertingSeverities struct {
	Absent       string
	FastBurn     string
	MediumBurn   string
	SlowBurn     string
	LongTermBurn string
}

type BoolGaugeIndicator added in v0.6.0 

type BoolGaugeIndicator struct {
	Metric
	Grouping []string
}

type GenerationOptions added in v0.10.0 

type GenerationOptions struct {
	// EnablePrometheus3Migration enables generation of rules compatible with both
	// Prometheus 2 and 3. This transforms le label matchers from exact matches
	// (e.g., le="1") to regex matches (e.g., le=~"1(\.0)?") to handle the
	// Prometheus 3 change where classic histogram bucket labels are normalized to floats.
	// This only affects classic histograms (Latency indicators); native histograms
	// (LatencyNative indicators) are not affected by this change.
	EnablePrometheus3Migration bool
	// ExternalURL is the base URL for Pyrra, used to generate direct links to the
	// Pyrra UI in alert annotations (pyrra_url annotation).
	ExternalURL string
}

GenerationOptions contains configuration for rule generation.

type Indicator 

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

type IndicatorType added in v0.6.0 

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 added in v0.7.0 

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

	PerformanceOverAccuracy bool
	RuleOutput              RuleOutput

	Alerting  Alerting
	Indicator Indicator
}

func (Objective) AbsentDuration added in v0.6.3 

func (o Objective) AbsentDuration() model.Duration

AbsentDuration calculates the duration when absent alerts should fire. The idea is as follows: Use the most critical of the multi burn rate alerts. For that alert to fire, both the short AND long windows have to be above the threshold. The long window takes the - longest - to fire. Assuming absence of the metric means 100% error rate, the time it takes to fire is the duration for the long window to go above the threshold (factor * objective). Finally, we add the "for" duration we add to the multi burn rate alerts.

func (Objective) AlertName added in v0.5.0 

func (o Objective) AlertName() string

func (Objective) AlertNameAbsent added in v0.8.0 

func (o Objective) AlertNameAbsent() string

func (Objective) Alerts 

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

func (Objective) Burnrate 

func (o Objective) Burnrate(timerange time.Duration, opts GenerationOptions) string

func (Objective) BurnrateName added in v0.4.3 

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

func (Objective) Burnrates 

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

func (Objective) DurationRange added in v0.5.0 

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

func (Objective) ErrorsRange 

func (o Objective) ErrorsRange(timerange time.Duration, opts GenerationOptions) string

func (Objective) Exhausts added in v0.7.0 

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

func (Objective) GenericRules added in v0.5.0 

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

func (Objective) Grouping added in v0.4.1 

func (o Objective) Grouping() []string

func (Objective) HasWindows added in v0.4.0 

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

func (Objective) IncreaseRules added in v0.3.0 

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

IncreaseRules returns a single RuleGroup with all increase rules.

func (Objective) IndicatorType added in v0.6.0 

func (o Objective) IndicatorType() IndicatorType

func (Objective) Name 

func (o Objective) Name() string

func (Objective) QueryBurnrate added in v0.4.3 

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

func (Objective) QueryErrorBudget 

func (o Objective) QueryErrorBudget(opts GenerationOptions) string

func (Objective) QueryErrors 

func (o Objective) QueryErrors(window model.Duration, opts GenerationOptions) 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, opts GenerationOptions) 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, opts GenerationOptions) string

func (Objective) SplitIncreaseRules added in v0.10.0 

func (o Objective) SplitIncreaseRules(opts GenerationOptions) (short, long monitoringv1.RuleGroup, err error)

SplitIncreaseRules returns two separate rule groups when PerformanceOverAccuracy is enabled:

  • short: 5m increase recording rules and absent alerts (run on Prometheus)
  • long: subquery rules over the full window (run on Thanos)

When PerformanceOverAccuracy is false, short is empty and long contains all rules.

func (Objective) Windows added in v0.4.0 

func (o Objective) Windows() []Window

type RatioIndicator 

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

type RuleOutput added in v0.10.0 

type RuleOutput struct {
	ShortRulesLabels         map[string]string
	LongRulesLabels          map[string]string
	EnableDescriptionAsLabel bool
}

type Window added in v0.4.0 

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

func Windows added in v0.4.0 

func Windows(sloWindow time.Duration) []Window

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.