matcher

Documentation

Index

• Variables
• type EventFinger
  • func NewEventFinger(fingerExpr string) (*EventFinger, error)
  • func (m *EventFinger) Run(msg repository.Event) (string, error)
• type EventMatcher
  • func NewEventMatcher(rule repository.Rule) (*EventMatcher, error)
  • func (m *EventMatcher) Match(evt repository.Event) (matched bool, ignored bool, err error)
  • func (m *EventMatcher) Rule() repository.Rule
• type EventWrap
  • func NewEventWrap(message repository.Event) *EventWrap
  • func (msg *EventWrap) FullJSON() string
  • func (msg *EventWrap) IsPlain() bool
  • func (msg *EventWrap) IsRecoverable() bool
  • func (msg *EventWrap) IsRecovery() bool
  • func (msg *EventWrap) JsonGet(key string, defaultValue string) string
• type TriggerContext
  • func NewTriggerContext(cc container.Container, trigger repository.Trigger, ...) *TriggerContext
  • func (tc *TriggerContext) Events() []repository.Event
  • func (tc *TriggerContext) EventsCount() int64
  • func (tc *TriggerContext) EventsMatchRegexCount(regex string) int64
  • func (tc *TriggerContext) EventsWithMetaCount(key, value string) int64
  • func (tc *TriggerContext) EventsWithTagsCount(tags string) int64
  • func (tc *TriggerContext) LastTriggeredGroup(triggerStatus string) repository.EventGroup
  • func (tc *TriggerContext) Messages() []repository.Event
  • func (tc *TriggerContext) MessagesCount() int64
  • func (tc *TriggerContext) MessagesMatchRegexCount(regex string) int64
  • func (tc *TriggerContext) MessagesWithMetaCount(key, value string) int64
  • func (tc *TriggerContext) MessagesWithTagsCount(tags string) int64
  • func (tc *TriggerContext) TriggeredTimesInPeriod(periodInMinutes int, triggerStatus string) int64
• type TriggerMatcher
  • func NewTriggerMatcher(trigger repository.Trigger) (*TriggerMatcher, error)
  • func (m *TriggerMatcher) Match(triggerCtx *TriggerContext) (bool, error)
  • func (m *TriggerMatcher) Trigger() repository.Trigger

Variables

var InvalidReturnVal = errors.New("invalid return value: must be a bool value")

InvalidReturnVal is a error represents the expression return value is invalid

Types

type EventFinger

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

EventFinger Event 指纹

func NewEventFinger

func NewEventFinger(fingerExpr string) (*EventFinger, error)

NewEventFinger create a new EventFinger instance

func (*EventFinger) Run

func (m *EventFinger) Run(msg repository.Event) (string, error)

Run 根据指定的表达式创建 Event 的指纹

type EventMatcher

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

EventMatcher is a matcher for repository.Event

func NewEventMatcher

func NewEventMatcher(rule repository.Rule) (*EventMatcher, error)

NewEventMatcher create a new EventMatcher https://github.com/antonmedv/expr/blob/master/docs/Language-Definition.md

func (*EventMatcher) Match

func (m *EventMatcher) Match(evt repository.Event) (matched bool, ignored bool, err error)

Match check whether the msg is match with the rule

func (*EventMatcher) Rule

func (m *EventMatcher) Rule() repository.Rule

Rule return original rule object

type EventWrap

type EventWrap struct {
	repository.Event
	helper.Helpers
	// contains filtered or unexported fields
}

EventWrap is a wrapper to repository.Event We will add some helper function to message

func NewEventWrap

func NewEventWrap(message repository.Event) *EventWrap

func (*EventWrap) FullJSON

func (msg *EventWrap) FullJSON() string

FullJSON return whole event as json document

func (*EventWrap) IsPlain

func (msg *EventWrap) IsPlain() bool

IsPlain return whether the message is a plain message

func (*EventWrap) IsRecoverable

func (msg *EventWrap) IsRecoverable() bool

IsRecoverable return whether the message is recoverable

func (*EventWrap) IsRecovery

func (msg *EventWrap) IsRecovery() bool

IsRecovery return whether the message is a recovery message

func (*EventWrap) JsonGet

func (msg *EventWrap) JsonGet(key string, defaultValue string) string

JsonGet parse message.Content as a json string and return the string value for key

type TriggerContext

type TriggerContext struct {
	helper.Helpers
	Group   repository.EventGroup
	Trigger repository.Trigger

	EventCallback func() []repository.Event
	// contains filtered or unexported fields
}

func NewTriggerContext

func NewTriggerContext(cc container.Container, trigger repository.Trigger, group repository.EventGroup, eventCallback func() []repository.Event) *TriggerContext

NewTriggerContext create a new TriggerContext

func (*TriggerContext) Events

func (tc *TriggerContext) Events() []repository.Event

Events return all events in group

func (*TriggerContext) EventsCount

func (tc *TriggerContext) EventsCount() int64

EventsCount return the count in group

func (*TriggerContext) EventsMatchRegexCount

func (tc *TriggerContext) EventsMatchRegexCount(regex string) int64

EventsMatchRegexCount get the count for events matched regex

func (*TriggerContext) EventsWithMetaCount

func (tc *TriggerContext) EventsWithMetaCount(key, value string) int64

EventsWithMetaCount get the count for events has a meta[key] equals to value

func (*TriggerContext) EventsWithTagsCount

func (tc *TriggerContext) EventsWithTagsCount(tags string) int64

EventsWithTagsCount get the count for events which has tags

func (*TriggerContext) LastTriggeredGroup

func (tc *TriggerContext) LastTriggeredGroup(triggerStatus string) repository.EventGroup

LastTriggeredGroup get last triggeredGroup

func (*TriggerContext) Messages

func (tc *TriggerContext) Messages() []repository.Event

Messages return all events in group This method is depressed

func (*TriggerContext) MessagesCount

func (tc *TriggerContext) MessagesCount() int64

MessagesCount return the count in group This method is depressed

func (*TriggerContext) MessagesMatchRegexCount

func (tc *TriggerContext) MessagesMatchRegexCount(regex string) int64

MessagesMatchRegexCount get the count for events matched regex This method is depressed

func (*TriggerContext) MessagesWithMetaCount

func (tc *TriggerContext) MessagesWithMetaCount(key, value string) int64

MessagesWithMetaCount get the count for events has a meta[key] equals to value This method is depressed

func (*TriggerContext) MessagesWithTagsCount

func (tc *TriggerContext) MessagesWithTagsCount(tags string) int64

MessagesWithTagsCount get the count for events which has tags This method is depressed

func (*TriggerContext) TriggeredTimesInPeriod

func (tc *TriggerContext) TriggeredTimesInPeriod(periodInMinutes int, triggerStatus string) int64

TriggeredTimesInPeriod return triggered times in specified periods

type TriggerMatcher

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

TriggerMatcher is a matcher for trigger

func NewTriggerMatcher

func NewTriggerMatcher(trigger repository.Trigger) (*TriggerMatcher, error)

NewTriggerMatcher create a new TriggerMatcher https://github.com/antonmedv/expr/blob/master/docs/Language-Definition.md

func (*TriggerMatcher) Match

func (m *TriggerMatcher) Match(triggerCtx *TriggerContext) (bool, error)

Match check whether the msg is match with the rule

func (*TriggerMatcher) Trigger

func (m *TriggerMatcher) Trigger() repository.Trigger

Trigger return original trigger object