model/alert.go

Rama main · réplica de lectura del repositorio original.

package model

import (
	"fmt"

	"github.com/coroot/coroot/timeseries"
	"github.com/dustin/go-humanize/english"
)

type AlertRule struct {
	LongWindow        timeseries.Duration
	ShortWindow       timeseries.Duration
	BurnRateThreshold float32
	Severity          Status
}

var (
	AlertRules = []AlertRule{
		{LongWindow: timeseries.Hour, ShortWindow: 5 * timeseries.Minute, BurnRateThreshold: 14.4, Severity: CRITICAL},
		{LongWindow: 6 * timeseries.Hour, ShortWindow: 15 * timeseries.Minute, BurnRateThreshold: 6, Severity: CRITICAL},
	}
	MaxAlertRuleWindow      timeseries.Duration
	MaxAlertRuleShortWindow timeseries.Duration
	MinAlertRuleShortWindow timeseries.Duration

	IncidentTimeOffset = timeseries.Hour + 5*timeseries.Minute // long + short window of the first rule
	AlertTimeOffset    = timeseries.Hour
)

func init() {
	MaxAlertRuleWindow = timeseries.Hour
	MaxAlertRuleShortWindow = 5 * timeseries.Minute
	for _, r := range AlertRules {
		if r.ShortWindow > r.LongWindow {
			panic("invalid rule")
		}
		if r.LongWindow > MaxAlertRuleWindow {
			MaxAlertRuleWindow = r.LongWindow
		}
		if r.ShortWindow > MaxAlertRuleShortWindow {
			MaxAlertRuleShortWindow = r.ShortWindow
		}
		if MinAlertRuleShortWindow == 0 || r.ShortWindow < MinAlertRuleShortWindow {
			MinAlertRuleShortWindow = r.ShortWindow
		}
	}
}

type BurnRate struct {
	LongWindowPercentage  float32             `json:"long_window_percentage"`
	ShortWindowPercentage float32             `json:"short_window_percentage"`
	LongWindowBurnRate    float32             `json:"long_window_burn_rate"`
	ShortWindowBurnRate   float32             `json:"short_window_burn_rate"`
	LongWindow            timeseries.Duration `json:"long_window"`
	ShortWindow           timeseries.Duration `json:"short_window"`
	Severity              Status              `json:"severity"`
	Threshold             float32             `json:"threshold"`
}

func (br BurnRate) FormatSLOStatus() string {
	hours := int(br.LongWindow / timeseries.Hour)
	return fmt.Sprintf("error budget burn rate is %.1fx within %s", br.LongWindowBurnRate, english.Plural(hours, "hour", ""))
}

type AlertDetail struct {
	Name  string `json:"name"`
	Value string `json:"value"`
	Code  bool   `json:"code,omitempty"`
}

type Alert struct {
	Id                  string              `json:"id"`
	Fingerprint         string              `json:"fingerprint"`
	RuleId              string              `json:"rule_id"`
	ProjectId           string              `json:"project_id"`
	ApplicationId       ApplicationId       `json:"application_id"`
	ApplicationCategory ApplicationCategory `json:"application_category,omitempty"`
	Severity            Status              `json:"severity"`
	Summary             string              `json:"summary"`
	Details             []AlertDetail       `json:"details,omitempty"`
	OpenedAt            timeseries.Time     `json:"opened_at"`
	ResolvedAt          timeseries.Time     `json:"resolved_at"`
	ManuallyResolvedAt  timeseries.Time     `json:"manually_resolved_at"`
	UpdatedAt           timeseries.Time     `json:"updated_at"`
	Suppressed          bool                `json:"suppressed"`
	ResolvedBy          string              `json:"resolved_by,omitempty"`
	Report              AuditReportName     `json:"report,omitempty"`
	PatternWords        string              `json:"-"`
}

func (a *Alert) IsFiring() bool {
	return a.ResolvedAt == 0
}