alert

Documentation

Overview

alert package implements how to kick the alert.

Index

• Variables
• type Alert
  • func New(target string) (Alert, error)
• type AlertReporter
  • func (r AlertReporter) Report(rec api.Record)
• type AlertSet
  • func NewSet(targets []string) (AlertSet, error)
  • func (as AlertSet) Trigger(ctx context.Context, i *api.Incident, r probe.Reporter)
• type PluginAlert
  • func NewPluginAlert(target string) (PluginAlert, error)
  • func (a PluginAlert) Trigger(ctx context.Context, incident *api.Incident, r probe.Reporter)
• type ProbeAlert
  • func (a ProbeAlert) Trigger(ctx context.Context, incident *api.Incident, r probe.Reporter)
• type ReplaceReporter
  • func (r ReplaceReporter) Report(rec api.Record)

Variables

var (
	ErrInvalidAlertURL = errors.New("invalid alert URL")
)

Types

type Alert

type Alert interface {
	Trigger(context.Context, *api.Incident, probe.Reporter)
}

func New

func New(target string) (Alert, error)

type AlertReporter

type AlertReporter struct {
	Upstream probe.Reporter
}

func (AlertReporter) Report

func (r AlertReporter) Report(rec api.Record)

type AlertSet

type AlertSet []Alert

AlertSet is a set of alerts. It also implements Alert alertinterface.

func NewSet

func NewSet(targets []string) (AlertSet, error)

func (AlertSet) Trigger

func (as AlertSet) Trigger(ctx context.Context, i *api.Incident, r probe.Reporter)

Trigger of AlertSet calls all Trigger methods of children parallelly. This method blocks until all alerts done.

type PluginAlert

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

func NewPluginAlert

func NewPluginAlert(target string) (PluginAlert, error)

func (PluginAlert) Trigger

func (a PluginAlert) Trigger(ctx context.Context, incident *api.Incident, r probe.Reporter)

type ProbeAlert

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

func (ProbeAlert) Trigger

func (a ProbeAlert) Trigger(ctx context.Context, incident *api.Incident, r probe.Reporter)

type ReplaceReporter

type ReplaceReporter struct {
	Target   *url.URL
	Upstream probe.Reporter
}

func (ReplaceReporter) Report

func (r ReplaceReporter) Report(rec api.Record)