operatorrules

Documentation

Index

• func AddToScheme(scheme *runtime.Scheme) error
• func BuildPrometheusRule(name, namespace string, labels map[string]string) (*promv1.PrometheusRule, error)
• func BuildRoleAndRoleBinding(namePrefix, namespace, promSAName, promSANamespace string, ...) (*rbacv1.Role, *rbacv1.RoleBinding)
• func CleanRegistry() error
• func ListAlerts() []promv1.Rule
• func RegisterAlerts(alerts ...[]promv1.Rule) error
• func RegisterRecordingRules(recordingRules ...[]RecordingRule) error
• type RecordingRule
  • func ListRecordingRules() []RecordingRule
  • func (c RecordingRule) GetOpts() operatormetrics.MetricOpts
  • func (c RecordingRule) GetType() operatormetrics.MetricType

Functions

func AddToScheme

func AddToScheme(scheme *runtime.Scheme) error

func BuildPrometheusRule

func BuildPrometheusRule(name, namespace string, labels map[string]string) (*promv1.PrometheusRule, error)

BuildPrometheusRule builds a PrometheusRule object from the registered recording rules and alerts.

func BuildRoleAndRoleBinding

func BuildRoleAndRoleBinding(namePrefix, namespace, promSAName, promSANamespace string, labels map[string]string) (*rbacv1.Role, *rbacv1.RoleBinding)

func CleanRegistry

func CleanRegistry() error

CleanRegistry removes all registered rules and alerts.

func ListAlerts

func ListAlerts() []promv1.Rule

ListAlerts returns the registered alerts.

func RegisterAlerts

func RegisterAlerts(alerts ...[]promv1.Rule) error

RegisterAlerts registers the given alerts.

func RegisterRecordingRules

func RegisterRecordingRules(recordingRules ...[]RecordingRule) error

RegisterRecordingRules registers the given recording rules.

Types

type RecordingRule

type RecordingRule struct {
	MetricsOpts operatormetrics.MetricOpts
	MetricType  operatormetrics.MetricType
	Expr        intstr.IntOrString
}

RecordingRule is a struct that represents a Prometheus recording rule.

func ListRecordingRules

func ListRecordingRules() []RecordingRule

ListRecordingRules returns the registered recording rules.

func (RecordingRule) GetOpts

func (c RecordingRule) GetOpts() operatormetrics.MetricOpts

GetOpts returns the metric options of the recording rule.

func (RecordingRule) GetType

func (c RecordingRule) GetType() operatormetrics.MetricType

GetType returns the metric type of the recording rule.