goplum

package module

Go to main page

Versions in this module

v0

v0.7.0

Jun 1, 2023

v0.6.0

Sep 13, 2021

Changes in this version

+ type Fact string

+ var CheckTime Fact = "github.com/csmith/goplum#check_time"

+ var ResponseTime Fact = "github.com/csmith/goplum#response_time"

+ type LongRunning interface

+ Timeout func() time.Duration

type Result

+ Facts map[Fact]interface{}

v0.5.0

Feb 26, 2021

v0.4.0

Oct 22, 2020

Changes in this version

+ type CheckListener func(*ScheduledCheck, Result)

type CheckTombStone

+ PluginState json.RawMessage

+ Suspended bool

+ type GrpcServer struct

+ func NewGrpcServer(plum *Plum) *GrpcServer

+ func (s *GrpcServer) GetCheck(_ context.Context, name *api.CheckName) (*api.Check, error)

+ func (s *GrpcServer) GetChecks(_ context.Context, _ *api.Empty) (*api.CheckList, error)

+ func (s *GrpcServer) Results(_ *api.Empty, rs api.GoPlum_ResultsServer) error

+ func (s *GrpcServer) ResumeCheck(_ context.Context, name *api.CheckName) (*api.Check, error)

+ func (s *GrpcServer) Start()

+ func (s *GrpcServer) Stop()

+ func (s *GrpcServer) SuspendCheck(_ context.Context, name *api.CheckName) (*api.Check, error)

type Plum

+ func (p *Plum) AddCheckListener(listener CheckListener)

+ func (p *Plum) RemoveCheckListener(listener CheckListener)

+ func (p *Plum) Suspend(checkName string) *ScheduledCheck

+ func (p *Plum) Unsuspend(checkName string) *ScheduledCheck

type Result

+ func IndeterminateResult(format string, a ...interface{}) Result

type ScheduledCheck

+ Suspended bool

+ type Stateful interface

+ Restore func(func(interface{}))

+ Save func() interface{}

+ type Validator interface

+ Validate func() error

v0.3.0

Sep 27, 2020

Changes in this version

+ func Run(plugins map[string]PluginLoader, configPath string)

type CheckSettings

+ Timeout time.Duration

type CheckState

+ func (c *CheckState) UnmarshalJSON(val []byte) error

+ type CheckTombStone struct

+ History ResultHistory

+ LastRun time.Time

+ Settled bool

+ State CheckState

type Plum

+ func (p *Plum) RestoreState() error

+ func (p *Plum) SaveState() error

+ type TombStone struct

+ Checks map[string]CheckTombStone

+ Time time.Time

+ func LoadTombStone() (*TombStone, error)

+ func NewTombStone(checks []*ScheduledCheck) *TombStone

+ func (ts *TombStone) Restore(checks []*ScheduledCheck) error

+ func (ts *TombStone) Save() error

v0.2.0

Sep 23, 2020

Changes in this version

type Alert

+ Validate func() error

type Check

+ Validate func() error

type CheckSettings

+ func (c CheckSettings) Copy() CheckSettings

type Plugin

+ Alert func(kind string) Alert

+ Check func(kind string) Check

+ type PluginLoader func() (Plugin, error)

type Plum

+ Alerts map[string]Alert

+ Checks []*ScheduledCheck

+ func NewPlum() *Plum

+ func (p *Plum) ReadConfig(path string) error

+ func (p *Plum) RegisterPlugin(name string, loader PluginLoader)

+ func (p *Plum) RegisterPlugins(plugins map[string]PluginLoader)

type ScheduledCheck

+ Name string

+ Scheduled bool

+ Type string

v0.1.0

Sep 17, 2020

Changes in this version

+ var DefaultSettings = CheckSettings

+ type Alert interface

+ Send func(details AlertDetails) error

+ type AlertDetails struct

+ Config interface{}

+ LastResult *Result

+ Name string

+ NewState CheckState

+ PreviousState CheckState

+ Text string

+ Type string

+ type AlertType interface

+ Create func(config json.RawMessage) (Alert, error)

+ Name func() string

+ type Check interface

+ Execute func() Result

+ type CheckSettings struct

+ Alerts []string

+ FailingThreshold int

+ GoodThreshold int

+ Interval Duration

+ type CheckState int

+ const StateFailing

+ const StateGood

+ const StateIndeterminate

+ func (c CheckState) MarshalJSON() ([]byte, error)

+ func (c CheckState) String() string

+ type CheckType interface

+ Create func(config json.RawMessage) (Check, error)

+ Name func() string

+ type Config struct

+ Alerts []ConfiguredAlert

+ Checks []ConfiguredCheck

+ Defaults CheckSettings

+ func LoadConfig(path string) (*Config, error)

+ type ConfiguredAlert struct

+ Name string

+ Params json.RawMessage

+ Type string

+ type ConfiguredCheck struct

+ Name string

+ Params json.RawMessage

+ Type string

+ type Duration time.Duration

+ func (d *Duration) UnmarshalJSON(b []byte) error

+ func (d Duration) MarshalJSON() ([]byte, error)

+ type Plugin interface

+ Alerts func() []AlertType

+ Checks func() []CheckType

+ Name func() string

+ type Plum struct

+ func (p *Plum) AddPlugins(plugins []Plugin)

+ func (p *Plum) AlertsMatching(names []string) []Alert

+ func (p *Plum) LoadConfig(configPath string)

+ func (p *Plum) RaiseAlerts(c *ScheduledCheck, previousState CheckState)

+ func (p *Plum) Run()

+ func (p *Plum) RunCheck(c *ScheduledCheck)

+ type Result struct

+ Detail string

+ State CheckState

+ Time time.Time

+ func FailingResult(format string, a ...interface{}) Result

+ func GoodResult() Result

+ type ResultHistory [10]*Result

+ func (h ResultHistory) State(thresholds map[CheckState]int) CheckState

+ type ScheduledCheck struct

+ Check Check

+ Config ConfiguredCheck

+ LastRun time.Time

+ Settled bool

+ State CheckState

+ func (c *ScheduledCheck) AddResult(result *Result) ResultHistory

+ func (c *ScheduledCheck) History() ResultHistory

+ func (c *ScheduledCheck) LastResult() *Result

+ func (c *ScheduledCheck) Remaining() time.Duration

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL