alarm

package

v0.0.0-...-2e804f1 Latest Latest Go to latest Published: May 5, 2023 License: BSD-2-Clause Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Alarm package handles alerting and notification for dnszilla. it's meant to be modular and follow a template guideline.

View Source

const (
	SeverityCritical = iota + 1
	SeverityHigh
	SeverityWarning
	SeverityInfo
)

This section is empty.

func NewStdoutAlarm(s state.State) *stdoutAlarm

func NewdummyAlarm(s state.State) *dummyAlarm

func SetupAlarms(s state.State, k *koanf.Koanf, alarmPubSub *PubSub)

type Alarm struct {
	RawEvent dnszilla.DNSResult
	Severity uint8
	Name     string
	Text     string
	Tags     map[string]string
}

a named fanout pubsub system for DNS result alarms

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

func NewPubSub(s state.State) *PubSub

New creates a new PubSub instance

func (p *PubSub) Pub(pub chan Alarm, name string)

Pub takes an input chan and name and publishes it

func (p *PubSub) PubCount() int

func (p *PubSub) Sub(names ...string) chan Alarm

Sub takes a list of publisher names and subscribes to them

func (p *PubSub) SubCount() int