golang

Documentation

Index

• type Parameter
  • func WithLocker(locker locker.Service) Parameter
  • func WithLogLevel(logLevel zerolog.Level) Parameter
  • func WithMonitor(monitor metrics.RulerMonitor) Parameter
  • func WithRules(rules rules.Service) Parameter
• type Service
  • func New(ctx context.Context, params ...Parameter) (*Service, error)
  • func (s *Service) RunRules(ctx context.Context, credentials *checker.Credentials, action string, ...) []rules.Result

Types

type Parameter

type Parameter interface {
	// contains filtered or unexported methods
}

Parameter is the interface for service parameters.

func WithLocker

func WithLocker(locker locker.Service) Parameter

WithLocker sets the locker for this module.

func WithLogLevel

func WithLogLevel(logLevel zerolog.Level) Parameter

WithLogLevel sets the log level for the module.

func WithMonitor

func WithMonitor(monitor metrics.RulerMonitor) Parameter

WithMonitor sets the monitor for this module.

func WithRules

func WithRules(rules rules.Service) Parameter

WithRules sets the rules for this module.

type Service

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

Service is the ruler service.

func New

func New(ctx context.Context, params ...Parameter) (*Service, error)

New creates a new Go ruler service.

func (*Service) RunRules

func (s *Service) RunRules(ctx context.Context,
	credentials *checker.Credentials,
	action string,
	rulesData []*ruler.RulesData,
) []rules.Result

RunRules runs a number of rules and returns a result.