local

Documentation

Index

• Constants
• type Client
  • func NewLocalRulesClient(cfg Config, loader promRules.GroupLoader) (*Client, error)
  • func (l *Client) DeleteNamespace(ctx context.Context, userID, namespace string) error
  • func (l *Client) DeleteRuleGroup(ctx context.Context, userID, namespace string, group string) error
  • func (l *Client) GetRuleGroup(ctx context.Context, userID, namespace, group string) (*rulespb.RuleGroupDesc, error)
  • func (l *Client) ListAllRuleGroups(ctx context.Context) (map[string]rulespb.RuleGroupList, error)
  • func (l *Client) ListAllUsers(ctx context.Context) ([]string, error)
  • func (l *Client) ListRuleGroupsForUserAndNamespace(ctx context.Context, userID string, namespace string) (rulespb.RuleGroupList, error)
  • func (l *Client) LoadRuleGroups(_ context.Context, load map[string]rulespb.RuleGroupList) (map[string]rulespb.RuleGroupList, error)
  • func (l *Client) SetRuleGroup(ctx context.Context, userID, namespace string, group *rulespb.RuleGroupDesc) error
• type Config
  • func (cfg *Config) RegisterFlagsWithPrefix(prefix string, f *flag.FlagSet)

Constants

const (
	Name = "local"
)

Types

type Client

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

Client expects to load already existing rules located at:

cfg.Directory / userID / namespace

func NewLocalRulesClient

func NewLocalRulesClient(cfg Config, loader promRules.GroupLoader) (*Client, error)

func (*Client) DeleteNamespace

func (l *Client) DeleteNamespace(ctx context.Context, userID, namespace string) error

DeleteNamespace implements RulerStore

func (*Client) DeleteRuleGroup

func (l *Client) DeleteRuleGroup(ctx context.Context, userID, namespace string, group string) error

DeleteRuleGroup implements RuleStore

func (*Client) GetRuleGroup

func (l *Client) GetRuleGroup(ctx context.Context, userID, namespace, group string) (*rulespb.RuleGroupDesc, error)

GetRuleGroup implements RuleStore

func (*Client) ListAllRuleGroups

func (l *Client) ListAllRuleGroups(ctx context.Context) (map[string]rulespb.RuleGroupList, error)

ListAllRuleGroups implements rules.RuleStore. This method also loads the rules.

func (*Client) ListAllUsers

func (l *Client) ListAllUsers(ctx context.Context) ([]string, error)

func (*Client) ListRuleGroupsForUserAndNamespace

func (l *Client) ListRuleGroupsForUserAndNamespace(ctx context.Context, userID string, namespace string) (rulespb.RuleGroupList, error)

ListRuleGroupsForUserAndNamespace implements rules.RuleStore. This method also loads the rules.

func (*Client) LoadRuleGroups

func (l *Client) LoadRuleGroups(_ context.Context, load map[string]rulespb.RuleGroupList) (map[string]rulespb.RuleGroupList, error)

func (*Client) SetRuleGroup

func (l *Client) SetRuleGroup(ctx context.Context, userID, namespace string, group *rulespb.RuleGroupDesc) error

SetRuleGroup implements RuleStore

type Config

type Config struct {
	Directory string `yaml:"directory"`
}

func (*Config) RegisterFlagsWithPrefix

func (cfg *Config) RegisterFlagsWithPrefix(prefix string, f *flag.FlagSet)

RegisterFlags registers flags.