siren

README

Siren

A pluggable framework for building time series data reactors.

Documentation

Index

• Constants
• func Activate(ctx context.Context, monitor Monitor)
• func ClearAll()
• func Deactivate(monitor Monitor)
• func RegisterBackend(name string, f Backend)
• type Action
• type Backend
• type Comparator
• type Condition
  • func (c Condition) Comparator() Comparator
• type Metric
• type Monitor
• type Notice
• type Stateful
• type Suppressable

Constants

const (
	STATE_CLEAR = iota
	STATE_ALARM
	STATE_FLAPPING
)

const (
	SHAPE_DURATION = iota
	SHAPE_COUNTER
	SHAPE_RATE
)

const (
	REL_ABOVE_OR_EQUAL = iota
	REL_ABOVE
	REL_BELOW
)

const (
	COMP_LESSER = iota
	COMP_LESSEREQUAL
	COMP_GREATER
	COMP_GREATEREQUAL
)

Functions

func Activate

func Activate(ctx context.Context, monitor Monitor)

func ClearAll

func ClearAll()

func Deactivate

func Deactivate(monitor Monitor)

func RegisterBackend

func RegisterBackend(name string, f Backend)

Types

type Action

type Action func(ctx context.Context, monitor Monitor)

type Backend

type Backend func(context context.Context, query string) ([]float64, error)

type Comparator

type Comparator func(p float64, threshold float64) bool

type Condition

type Condition struct {
	Threshold    float64
	Count        uint
	ClearCount   uint
	ComparatorID int
}

func (Condition) Comparator

func (c Condition) Comparator() Comparator

type Metric

type Metric struct {
	Shape   int
	Backend string
	Query   string
}

type Monitor

type Monitor struct {
	ID              string
	Metadata        map[string]interface{}
	Trigger         Metric
	Alarm           Condition
	AlarmActions    []Action `json:"-"`
	ClearActions    []Action `json:"-"`
	FlappingActions []Action `json:"-"`
	Suppressed      bool
	Period          time.Duration
}

type Notice

type Notice struct {
	MonitorID string
	Metadata  map[string]interface{}
	State     int
}

type Stateful

type Stateful interface {
	State() int
}

type Suppressable

type Suppressable interface {
	Suppress() error
}