rules

Jul 31, 2023

Changes in this version

type EngineOption

+ func EngineDontShareLockSession() EngineOption

Apr 26, 2022

Changes in this version

type EngineOption

+ func EngineWatchProcessDelay(base time.Duration, jitterPercent float64) EngineOption

Feb 24, 2022

Changes in this version

type EngineOption

+ func EngineLockCoolOff(timeout time.Duration) EngineOption

+ func EngineUseSharedLockSession() EngineOption

+ func EngineUseTryLock() EngineOption

Oct 27, 2021

Changes in this version

+ const WebhookURLEnv

+ type HTTPCallbackHandler struct

+ func NewHTTPCallbackHander() HTTPCallbackHandler

+ func (htcbh HTTPCallbackHandler) ClearCallbacks()

+ func (htcbh HTTPCallbackHandler) HandleRequest(w http.ResponseWriter, req *http.Request)

+ func (htcbh HTTPCallbackHandler) WaitForCallback(ctx context.Context, ruleID string, attributes map[string]string) error

Aug 5, 2021

Changes in this version

type DynamicRule

+ func NewCompareLiteralRule(pattern string, comparator func(*string) bool, renderTemplate string) (DynamicRule, error)

Jul 16, 2021

Changes in this version

type EngineOption

+ func KeyProcessorBuffer(size int) EngineOption

+ func KeyProcessorConcurrency(threads int) EngineOption

Nov 2, 2020

Changes in this version

+ type MockWatchWrapper struct

+ Mww *MockWatcherWrapper

+ func (mw *MockWatchWrapper) WrapWatcher(kvw clientv3.Watcher) clientv3.Watcher

+ type MockWatcherWrapper struct

+ KvWatcher clientv3.Watcher

+ Logger *zap.Logger

+ Responses []clientv3.WatchResponse

+ func (ww *MockWatcherWrapper) Close() error

+ func (ww *MockWatcherWrapper) RequestProgress(ctx context.Context) error

+ func (ww *MockWatcherWrapper) Watch(ctx context.Context, key string, opts ...clientv3.OpOption) clientv3.WatchChan

type V3Engine

+ SetWatcherWrapper func(WrapWatcher)

+ type WrapWatcher func(clientv3.Watcher) clientv3.Watcher

Jun 30, 2020

Changes in this version

+ type AdvancedMetricsCollector interface

+ ObserveWatchEvents func(prefix string, events, totalBytes int)

type MockMetricsCollector

+ ObserveWatchEventsEvents []int

+ ObserveWatchEventsPrefixes []string

+ ObserveWatchEventsTotalBytes []int

+ func (m *MockMetricsCollector) ObserveWatchEvents(prefix string, events, totalBytes int)

Jan 29, 2020

Changes in this version

type EngineOption

+ func EngineLockAcquisitionTimeout(lockAcquisitionTimeout int) EngineOption

Mar 20, 2019

Changes in this version

type EngineOption

+ func EngineMetricsCollector(m MetricsCollectorOpt) EngineOption

+ type MetricsCollector interface

+ IncLockMetric func(methodName string, pattern string, lockSucceeded bool)

+ IncSatisfiedThenNot func(methodName string, pattern string, phaseName string)

+ TimesEvaluated func(methodName string, ruleID string, count int)

+ WorkerQueueWaitTime func(methodName string, startTime time.Time)

+ type MetricsCollectorOpt func() MetricsCollector

+ type MockMetricsCollector struct

+ IncIncSatisfiedThenNotMethod []string

+ IncIncSatisfiedThenNotPhase []string

+ IncLockMetricLockSuccess []bool

+ IncLockMetricMethod []string

+ IncLockMetricPattern []string

+ IncSatisfiedThenNotPattern []string

+ TimesEvaluatedCount []int

+ TimesEvaluatedMethod []string

+ TimesEvaluatedRuleID []string

+ WorkerQueueWaitTimeMethod []string

+ WorkerQueueWaitTimeTimes []time.Time

+ func NewMockMetricsCollector() MockMetricsCollector

+ func (m *MockMetricsCollector) IncLockMetric(methodName string, pattern string, lockSucceeded bool)

+ func (m *MockMetricsCollector) IncSatisfiedThenNot(methodName string, pattern string, phaseName string)

+ func (m *MockMetricsCollector) SetLogger(lgr *zap.Logger)

+ func (m *MockMetricsCollector) TimesEvaluated(methodName string, ruleID string, count int)

+ func (m *MockMetricsCollector) WorkerQueueWaitTime(methodName string, startTime time.Time)

type RuleOption

+ func RuleID(ruleID string) RuleOption

Feb 22, 2018

Changes in this version

+ func FormatRuleString(in string) string

+ func FormatWithAttributes(pattern string, m Attributes) string

+ func RuleSatisfied(rule DynamicRule, triggerKey string, triggerValue *string, ...) (bool, error)

+ func SetMethod(ctx context.Context, method string) context.Context

+ type Attributes interface

+ Format func(string) string

+ GetAttribute func(string) *string

+ func NewAttributes(values map[string]string) Attributes

+ type BaseEngine interface

+ IsStopped func() bool

+ Run func()

+ Shutdown func(ctx context.Context) error

+ Stop func()

+ type ContextProvider func() (context.Context, context.CancelFunc)

+ type DynamicRule interface

+ Expand func(map[string][]string) ([]DynamicRule, bool)

+ func NewAndRule(rules ...DynamicRule) DynamicRule

+ func NewEqualsLiteralRule(pattern string, value *string) (DynamicRule, error)

+ func NewEqualsRule(pattern []string) (DynamicRule, error)

+ func NewNotRule(nestedRule DynamicRule) DynamicRule

+ func NewOrRule(rules ...DynamicRule) DynamicRule

+ type Engine interface

+ AddPolling func(namespacePattern string, preconditions DynamicRule, ttl int, ...) error

+ AddRule func(rule DynamicRule, lockPattern string, callback RuleTaskCallback, ...)

+ SetKeysAPIWrapper func(WrapKeysAPI)

+ func NewEngine(config client.Config, logger zap.Logger, options ...EngineOption) Engine

+ type EngineOption interface

+ func EngineAutoCrawlGuides(autoCrawlGuides bool) EngineOption

+ func EngineConcurrency(workers int) EngineOption

+ func EngineContextProvider(cp ContextProvider) EngineOption

+ func EngineCrawlGuides(crawlGuides []string) EngineOption

+ func EngineCrawlMutex(mutex string, mutexTTL int) EngineOption

+ func EngineEnhancedRuleFilter(enhancedRuleFilter bool) EngineOption

+ func EngineLockTimeout(lockTimeout int) EngineOption

+ func EngineRuleWorkBuffer(buffer int) EngineOption

+ func EngineSyncDelay(delay int) EngineOption

+ func EngineSyncInterval(interval int) EngineOption

+ func EngineWatchTimeout(watchTimeout int) EngineOption

+ func GetEngineOptions(options EngineOptions) []EngineOption

+ func KeyConstraint(attribute string, prefix string, chars [][]rune) EngineOption

+ func KeyExpansion(keyExpansion map[string][]string) EngineOption

+ type EngineOptions struct

+ AutoCrawlGuides *bool

+ Concurrency *int

+ EnhancedRuleFilter *bool

+ type EtcdMetricsMetadata struct

+ Duration time.Duration

+ Error error

+ Method string

+ func GetMetricsMetadata(ctx context.Context) *EtcdMetricsMetadata

+ type LazyClient interface

+ LazyGet func(pattern string) (*string, error)

+ LazySet func(key, value string) error

+ List func(pattern string, options *client.GetOptions) ([]*client.Node, error)

+ func NewLazyClient(config *client.Config, attr Attributes, timeout time.Duration) LazyClient

+ type RuleOption interface

+ func RuleContextProvider(cp ContextProvider) RuleOption

+ func RuleLockTimeout(lockTimeout int) RuleOption

+ type RuleTask struct

+ Attr Attributes

+ Conf client.Config

+ Context context.Context

+ Logger zap.Logger

+ Metadata map[string]string

+ type RuleTaskCallback func(task *RuleTask)

+ type V3Engine interface

+ AddPolling func(namespacePattern string, preconditions DynamicRule, ttl int, ...) error

+ AddRule func(rule DynamicRule, lockPattern string, callback V3RuleTaskCallback, ...)

+ SetKVWrapper func(WrapKV)

+ func NewV3Engine(configV3 clientv3.Config, logger zap.Logger, options ...EngineOption) V3Engine

+ func NewV3EngineWithClient(cl *clientv3.Client, configV3 clientv3.Config, logger zap.Logger, ...) V3Engine

+ type V3RuleTask struct

+ Attr Attributes

+ Conf *clientv3.Config

+ Context context.Context

+ Logger zap.Logger

+ Metadata map[string]string

+ type V3RuleTaskCallback func(task *V3RuleTask)

+ type WrapKV func(clientv3.KV) clientv3.KV

+ type WrapKeysAPI func(client.KeysAPI) client.KeysAPI