heartbeat

Documentation

Index

• Constants
• func BuildID(mapping map[string]string) string
• type Adapter
  • func NewAdapter(dbClient mongo.DbClient) Adapter
• type Heartbeat
  • func (h *Heartbeat) ToHeartBeatItem() (Item, error)
• type Item
  • func NewItem(maxDuration time.Duration) Item
  • func (li *Item) AddMapping(field, matches string) error
  • func (li *Item) ID() string
• type SafeHeartbeatItems
  • func NewSafeHeartbeatItems() SafeHeartbeatItems
  • func (i *SafeHeartbeatItems) AddItem(hi Item)
  • func (i *SafeHeartbeatItems) Clear()
  • func (i *SafeHeartbeatItems) Len() int
  • func (i *SafeHeartbeatItems) Value() []Item

Constants

const (
	HeartbeatSourceDefault = ""
	HeartbeatSourceMongo   = "mongo"
)

Functions

func BuildID

func BuildID(mapping map[string]string) string

Types

type Adapter

type Adapter interface {
	Get() ([]Heartbeat, error)
}

func NewAdapter

func NewAdapter(dbClient mongo.DbClient) Adapter

type Heartbeat

type Heartbeat struct {
	Pattern          map[string]string `bson:"pattern"`
	ExpectedInterval string            `bson:"expected_interval"`
	Output           string            `bson:"output"`
}

func (*Heartbeat) ToHeartBeatItem

func (h *Heartbeat) ToHeartBeatItem() (Item, error)

type Item

type Item struct {
	Mappings    map[string]string `toml:"mappings"`
	MaxDuration time.Duration     `toml:"maxduration"`
	Source      string
	Output      string
}

Item contains the required informations for the HeartBeat engine to work.

func NewItem

func NewItem(maxDuration time.Duration) Item

NewItem creates a HeartBeatItem instance for you.

func (*Item) AddMapping

func (li *Item) AddMapping(field, matches string) error

AddMapping simplifies your life to declare a useful HeartBeatItem. You can safely ignore the error, it only says that the mapping you try to insert already exists.

func (*Item) ID

func (li *Item) ID() string

type SafeHeartbeatItems

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

func NewSafeHeartbeatItems

func NewSafeHeartbeatItems() SafeHeartbeatItems

func (*SafeHeartbeatItems) AddItem

func (i *SafeHeartbeatItems) AddItem(hi Item)

func (*SafeHeartbeatItems) Clear

func (i *SafeHeartbeatItems) Clear()

func (*SafeHeartbeatItems) Len

func (i *SafeHeartbeatItems) Len() int

func (*SafeHeartbeatItems) Value

func (i *SafeHeartbeatItems) Value() []Item