helpers

Documentation

Index

• Constants
• func CreateAlertingRule() (*monitoringv1.PrometheusRule, error)
• func CreatePrometheusRule(slo *openslov1.SLO, sli *openslov1.SLI) (*monitoringv1.PrometheusRule, error)
• func DeleteMimirRuleGroup(log logr.Logger, mimirClient *mimirclient.MimirClient, ...) error
• func GetMimirRuleGroup(log logr.Logger, mimirClient *mimirclient.MimirClient, ...) *rwrulefmt.RuleGroup
• func NewMimirRule(slo *openslov1.SLO, rule *monitoringv1.PrometheusRule, ...) (mimirRule *oskov1alpha1.MimirRule, err error)
• func NewMimirRuleGroups(rule *monitoringv1.PrometheusRule, ...) ([]oskov1alpha1.RuleGroup, error)
• func UpdateMimirRuleGroup(log logr.Logger, mimirClient *mimirclient.MimirClient, ...) error
• type AlertRuleTemplateData
• type MimirClientConfig
  • func (m *MimirClientConfig) NewMimirClient() (*mimirclient.MimirClient, error)
• type MonitoringRuleSet
  • func (mrs *MonitoringRuleSet) SetupRules() ([]monitoringv1.RuleGroup, error)
• type RuleTemplateData

Constants

const (
	RecordPrefix = "osko"
)

Functions

func CreateAlertingRule

func CreateAlertingRule() (*monitoringv1.PrometheusRule, error)

func CreatePrometheusRule

func CreatePrometheusRule(slo *openslov1.SLO, sli *openslov1.SLI) (*monitoringv1.PrometheusRule, error)

func DeleteMimirRuleGroup

func DeleteMimirRuleGroup(log logr.Logger, mimirClient *mimirclient.MimirClient, ruleGroup *rwrulefmt.RuleGroup) error

func GetMimirRuleGroup

func GetMimirRuleGroup(log logr.Logger, mimirClient *mimirclient.MimirClient, rule *monitoringv1.PrometheusRule) *rwrulefmt.RuleGroup

func NewMimirRule

func NewMimirRule(slo *openslov1.SLO, rule *monitoringv1.PrometheusRule, connectionDetails *oskov1alpha1.ConnectionDetails) (mimirRule *oskov1alpha1.MimirRule, err error)

func NewMimirRuleGroups

func NewMimirRuleGroups(rule *monitoringv1.PrometheusRule, connectionDetails *oskov1alpha1.ConnectionDetails) ([]oskov1alpha1.RuleGroup, error)

func UpdateMimirRuleGroup

func UpdateMimirRuleGroup(log logr.Logger, mimirClient *mimirclient.MimirClient, existingGroup *rwrulefmt.RuleGroup, desiredGroup *rwrulefmt.RuleGroup) error

Types

type AlertRuleTemplateData

type AlertRuleTemplateData struct {
	Metric     string
	Service    string
	Window     string
	RecordName string
	Labels     string
	For        string
}

AlertRuleTemplateData holds data to fill the PromQL template for alerting rules.

type MimirClientConfig

type MimirClientConfig struct {
	Address  string
	TenantId string
}

func (*MimirClientConfig) NewMimirClient

func (m *MimirClientConfig) NewMimirClient() (*mimirclient.MimirClient, error)

type MonitoringRuleSet

type MonitoringRuleSet struct {
	Slo        *openslov1.SLO
	Sli        *openslov1.SLI
	TargetRule monitoringv1.Rule
	BaseRule   monitoringv1.Rule
	GoodRule   monitoringv1.Rule
	TotalRule  monitoringv1.Rule
	BaseWindow string
}

func (*MonitoringRuleSet) SetupRules

func (mrs *MonitoringRuleSet) SetupRules() ([]monitoringv1.RuleGroup, error)

SetupRules constructs rule groups for monitoring based on SLO and SLI configurations.

type RuleTemplateData

type RuleTemplateData struct {
	Metric     string
	Service    string
	Window     string
	Extended   bool
	RecordName string
	Labels     string
}

RuleTemplateData holds data to fill the PromQL template.