alert

Documentation

Index

• Constants
• type GremlinAlert
  • func NewGremlinAlert(alert *types.Alert, g *graph.Graph, p *traversal.GremlinTraversalParser) (*GremlinAlert, error)
• type Message
• type Server
  • func NewServer(apiServer *api.Server, pool ws.StructSpeakerPool, graph *graph.Graph, ...) (*Server, error)
  • func (a *Server) OnEdgeAdded(e *graph.Edge)
  • func (a *Server) OnEdgeDeleted(e *graph.Edge)
  • func (a *Server) OnEdgeUpdated(e *graph.Edge)
  • func (a *Server) OnNodeAdded(n *graph.Node)
  • func (a *Server) OnNodeDeleted(n *graph.Node)
  • func (a *Server) OnNodeUpdated(n *graph.Node)
  • func (a *Server) Start()
  • func (a *Server) Stop()

Constants

const (
	// Namespace is the alerting WebSocket namespace
	Namespace = "Alert"
)

Types

type GremlinAlert

type GremlinAlert struct {
	*types.Alert
	// contains filtered or unexported fields
}

GremlinAlert represents an alert that will be triggered if its associated Gremlin expression returns a non empty result.

func NewGremlinAlert

func NewGremlinAlert(alert *types.Alert, g *graph.Graph, p *traversal.GremlinTraversalParser) (*GremlinAlert, error)

NewGremlinAlert returns a new gremlin based alert

type Message

type Message struct {
	UUID       string
	Timestamp  time.Time
	ReasonData interface{}
}

Message describes a websocket message that is sent by the alerting server when an alert was triggered

type Server

type Server struct {
	common.RWMutex
	common.MasterElection
	Graph        *graph.Graph
	Pool         ws.StructSpeakerPool
	AlertHandler api.Handler
	// contains filtered or unexported fields
}

Server describes an alerting alerts that evaluates registered alerts on graph events or periodically and trigger them if their condition evaluates to true

func NewServer

func NewServer(apiServer *api.Server, pool ws.StructSpeakerPool, graph *graph.Graph, parser *traversal.GremlinTraversalParser, etcdClient *etcd.Client) (*Server, error)

NewServer creates a new alerting server

func (*Server) OnEdgeAdded

func (a *Server) OnEdgeAdded(e *graph.Edge)

OnEdgeAdded event

func (*Server) OnEdgeDeleted

func (a *Server) OnEdgeDeleted(e *graph.Edge)

OnEdgeDeleted event

func (*Server) OnEdgeUpdated

func (a *Server) OnEdgeUpdated(e *graph.Edge)

OnEdgeUpdated event

func (*Server) OnNodeAdded

func (a *Server) OnNodeAdded(n *graph.Node)

OnNodeAdded event

func (*Server) OnNodeDeleted

func (a *Server) OnNodeDeleted(n *graph.Node)

OnNodeDeleted event

func (*Server) OnNodeUpdated

func (a *Server) OnNodeUpdated(n *graph.Node)

OnNodeUpdated event

func (*Server) Start

func (a *Server) Start()

Start the alerting server

func (*Server) Stop

func (a *Server) Stop()

Stop the alerting server