rules

Documentation

Index

• func CloneRuleGroup(g rulefmt.RuleGroup) rulefmt.RuleGroup
• func CloneRuleGroupList(list []rulefmt.RuleGroup) []rulefmt.RuleGroup
• func NewUpdateNotifier(finder RuleFinder) *updateNotifier
• type FilesystemRuleFinder
  • func NewFilesystemRuleFinder(config *v1beta1.FilesystemRulesSpec, opts ...FilesystemRuleFinderOption) *FilesystemRuleFinder
  • func (f *FilesystemRuleFinder) FindGroups(context.Context) ([]rulefmt.RuleGroup, error)
• type FilesystemRuleFinderOption
  • func WithFS(fs fs.FS) FilesystemRuleFinderOption
• type PrometheusRuleFinder
  • func NewPrometheusRuleFinder(k8sClient client.Client, opts ...PrometheusRuleFinderOption) *PrometheusRuleFinder
  • func (f *PrometheusRuleFinder) FindGroups(ctx context.Context) ([]rulefmt.RuleGroup, error)
• type PrometheusRuleFinderOption
  • func WithLogger(lg *zap.SugaredLogger) PrometheusRuleFinderOption
  • func WithNamespaces(namespaces ...string) PrometheusRuleFinderOption
• type PrometheusRuleFinderOptions
• type RuleFinder
• type UpdateNotifier
  • func NewPeriodicUpdateNotifier(ctx context.Context, finder RuleFinder, interval time.Duration) UpdateNotifier

Functions

func CloneRuleGroup

func CloneRuleGroup(g rulefmt.RuleGroup) rulefmt.RuleGroup

func CloneRuleGroupList

func CloneRuleGroupList(list []rulefmt.RuleGroup) []rulefmt.RuleGroup

func NewUpdateNotifier

func NewUpdateNotifier(finder RuleFinder) *updateNotifier

Types

type FilesystemRuleFinder

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

func NewFilesystemRuleFinder

func NewFilesystemRuleFinder(config *v1beta1.FilesystemRulesSpec, opts ...FilesystemRuleFinderOption) *FilesystemRuleFinder

func (*FilesystemRuleFinder) FindGroups

func (f *FilesystemRuleFinder) FindGroups(context.Context) ([]rulefmt.RuleGroup, error)

type FilesystemRuleFinderOption

type FilesystemRuleFinderOption func(*staticRuleFinderOptions)

func WithFS

func WithFS(fs fs.FS) FilesystemRuleFinderOption

type PrometheusRuleFinder

type PrometheusRuleFinder struct {
	PrometheusRuleFinderOptions
	// contains filtered or unexported fields
}

PrometheusRuleFinder can find rules defined in PrometheusRule CRDs.

func NewPrometheusRuleFinder

func NewPrometheusRuleFinder(k8sClient client.Client, opts ...PrometheusRuleFinderOption) *PrometheusRuleFinder

func (*PrometheusRuleFinder) FindGroups

func (f *PrometheusRuleFinder) FindGroups(ctx context.Context) ([]rulefmt.RuleGroup, error)

type PrometheusRuleFinderOption

type PrometheusRuleFinderOption func(*PrometheusRuleFinderOptions)

func WithLogger

func WithLogger(lg *zap.SugaredLogger) PrometheusRuleFinderOption

func WithNamespaces

func WithNamespaces(namespaces ...string) PrometheusRuleFinderOption

type PrometheusRuleFinderOptions

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

type RuleFinder

type RuleFinder interface {
	FindGroups(ctx context.Context) ([]rulefmt.RuleGroup, error)
}

type UpdateNotifier

type UpdateNotifier interface {
	// Returns a channel that will receive a list of rule groups whenever
	// any rules are added, removed, or updated. The channel has a small buffer
	// and will initially contain the latest rule group list.
	//
	// If the context is canceled, the channel will be closed. Additionally, if
	// the channel's buffer is full, any updates will be dropped.
	NotifyC(ctx context.Context) <-chan []rulefmt.RuleGroup
}

func NewPeriodicUpdateNotifier

func NewPeriodicUpdateNotifier(ctx context.Context, finder RuleFinder, interval time.Duration) UpdateNotifier