alerts

package

v0.0.0-...-52973e1 Latest Latest Go to latest Published: Jun 6, 2019 License: MIT Imports: 7 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

Package alerts provides alerts based on history of events.

This section is empty.

This section is empty.

func AddEvent(events []*Event, message string)

AddEvent adds an event to store.

type Alerter struct {
	sync.Mutex

	History *History
	Events  []*Event
	// contains filtered or unexported fields
}

Alerter is based on number of recent requests.

func New(c clock.Clock, h *History, i time.Duration, t int, s *screens.Screen) *Alerter

New creates a new alerter.

func (a *Alerter) Check()

Check activates and clears the alert as needed

func (a *Alerter) IsActivated() bool

IsActivated ...

func (a *Alerter) Run()

Run starts the process of periodically processing the alert.

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

Event is message with a time stamp

type History struct {
	sync.Mutex
	// contains filtered or unexported fields
}

History stores a list of recent requests.

func NewHistory(c clock.Clock, d time.Duration) *History

NewHistory creates a new instance of History. A clock is passed in to facilate testing.

func (h *History) RecentRequestCount() int

RecentRequestCount returns number of requests since last watch interval.

func (h *History) Record(req *http.Request)

Record processes the HTTP request.

func (h *History) Tidy()

Tidy deletes requests that are old.