alerting

Documentation

Index

• Constants
• func ParseGlobalRuleEnforceMatchers(rule *alertingv2beta1.GlobalRule) []*promlabels.Matcher
• type ClusterRuleGroupReconciler
  • func (r *ClusterRuleGroupReconciler) Reconcile(ctx context.Context, req reconcile.Request) (reconcile.Result, error)
  • func (r *ClusterRuleGroupReconciler) SetupWithManager(mgr ctrl.Manager) error
• type EnforceExprFunc
  • func CreateEnforceExprFunc(enforceRuleMatchers []*promlabels.Matcher) EnforceExprFunc
• type GlobalRuleGroupReconciler
  • func (r *GlobalRuleGroupReconciler) Reconcile(ctx context.Context, req reconcile.Request) (reconcile.Result, error)
  • func (r *GlobalRuleGroupReconciler) SetupWithManager(mgr ctrl.Manager) error
• type RuleGroupReconciler
  • func (r *RuleGroupReconciler) Reconcile(ctx context.Context, req reconcile.Request) (reconcile.Result, error)
  • func (r *RuleGroupReconciler) SetupWithManager(mgr ctrl.Manager) error
• type RuleLevel
• type RuleType

Constants

const (
	RuleLevelNamesapce RuleLevel = "namespace"
	RuleLevelCluster   RuleLevel = "cluster"
	RuleLevelGlobal    RuleLevel = "global"

	RuleTypeTemplate RuleType = "template" // for template rule configured by exprBuilder to build expression
	RuleTypeCustom   RuleType = "custom"   // for custom rule configured by direct expression

	// for rule.labels
	RuleLabelKeyRuleLevel         = "rule_level"
	RuleLabelKeyRuleGroup         = "rule_group"
	RuleLabelKeyRuleType          = "rule_type"
	RuleLabelKeyCluster           = "cluster"
	RuleLabelKeyNamespace         = "namespace"
	RuleLabelKeySeverity          = "severity"
	RuleLabelKeyAlertType         = "alerttype"
	RuleLabelValueAlertTypeMetric = "metric"

	// label keys in RuleGroup/ClusterRuleGroup/GlobalRuleGroup.metadata.labels
	SourceGroupResourceLabelKeyEnable        = "alerting.kubesphere.io/enable"
	SourceGroupResourceLabelValueEnableTrue  = "true"
	SourceGroupResourceLabelValueEnableFalse = "false"

	// for PrometheusRule.metadata.labels
	PrometheusRuleResourceLabelKeyOwnerNamespace = "alerting.kubesphere.io/owner_namespace"
	PrometheusRuleResourceLabelKeyOwnerCluster   = "alerting.kubesphere.io/owner_cluster"
	PrometheusRuleResourceLabelKeyRuleLevel      = "alerting.kubesphere.io/rule_level"
	PrometheusRuleResourceLabelKeyBuiltin        = "alerting.kubesphere.io/builtin"
	PrometheusRuleResourceLabelValueBuiltinTrue  = "true"
	PrometheusRuleResourceLabelValueBuiltinFalse = "false"

	// name prefix for PrometheusRule
	PrometheusRulePrefix               = "alertrules-"
	PrometheusRulePrefixNamespaceLevel = PrometheusRulePrefix + "ns-"
	PrometheusRulePrefixClusterLevel   = PrometheusRulePrefix + "cl-"
	PrometheusRulePrefixGlobalLevel    = PrometheusRulePrefix + "gl-"

	PrometheusRuleNamespace = constants.KubeSphereMonitoringNamespace
)

Functions

func ParseGlobalRuleEnforceMatchers

func ParseGlobalRuleEnforceMatchers(rule *alertingv2beta1.GlobalRule) []*promlabels.Matcher

Types

type ClusterRuleGroupReconciler

type ClusterRuleGroupReconciler struct {
	client.Client

	Log logr.Logger
}

func (*ClusterRuleGroupReconciler) Reconcile

func (r *ClusterRuleGroupReconciler) Reconcile(ctx context.Context, req reconcile.Request) (reconcile.Result, error)

func (*ClusterRuleGroupReconciler) SetupWithManager

func (r *ClusterRuleGroupReconciler) SetupWithManager(mgr ctrl.Manager) error

type EnforceExprFunc

type EnforceExprFunc func(expr string) (string, error)

func CreateEnforceExprFunc

func CreateEnforceExprFunc(enforceRuleMatchers []*promlabels.Matcher) EnforceExprFunc

type GlobalRuleGroupReconciler

type GlobalRuleGroupReconciler struct {
	client.Client

	Log logr.Logger
}

func (*GlobalRuleGroupReconciler) Reconcile

func (r *GlobalRuleGroupReconciler) Reconcile(ctx context.Context, req reconcile.Request) (reconcile.Result, error)

func (*GlobalRuleGroupReconciler) SetupWithManager

func (r *GlobalRuleGroupReconciler) SetupWithManager(mgr ctrl.Manager) error

type RuleGroupReconciler

type RuleGroupReconciler struct {
	client.Client

	Log logr.Logger
}

func (*RuleGroupReconciler) Reconcile

func (r *RuleGroupReconciler) Reconcile(ctx context.Context, req reconcile.Request) (reconcile.Result, error)

func (*RuleGroupReconciler) SetupWithManager

func (r *RuleGroupReconciler) SetupWithManager(mgr ctrl.Manager) error

type RuleLevel

type RuleLevel string

type RuleType

type RuleType string