operatorrules

package

v0.0.27 Latest Latest Go to latest Published: May 21, 2025 License: Apache-2.0 Imports: 9 Imported by: 12

Documentation ¶

This section is empty.

This section is empty.

func AddToScheme(scheme *runtime.Scheme) error

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

Deprecated: BuildPrometheusRule is deprecated.

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

func CleanRegistry() error

Deprecated: CleanRegistry is deprecated.

func ListAlerts() []promv1.Rule

Deprecated: ListAlerts is deprecated.

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

Deprecated: RegisterAlerts is deprecated.

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

Deprecated: RegisterRecordingRules is deprecated.

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

RecordingRule is a struct that represents a Prometheus recording rule.

func ListRecordingRules() []RecordingRule

Deprecated: ListRecordingRules is deprecated.

func (c RecordingRule) GetOpts() operatormetrics.MetricOpts

GetOpts returns the metric options of the recording rule.

func (c RecordingRule) GetType() operatormetrics.MetricType

GetType returns the metric type of the recording rule.

type Registry struct {
	// contains filtered or unexported fields
}

func NewRegistry() *Registry

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

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

func (r *Registry) ListAlerts() []promv1.Rule

ListAlerts returns the registered alerts.

func (r *Registry) ListRecordingRules() []RecordingRule

ListRecordingRules returns the registered recording rules.

func (r *Registry) RegisterAlerts(alerts ...[]promv1.Rule) error

RegisterAlerts registers the given alerts.

func (r *Registry) RegisterRecordingRules(recordingRules ...[]RecordingRule) error

RegisterRecordingRules registers the given recording rules.