services

Documentation

Overview

Package services provides service-checks to the notifiarr client application. This package spins up go routines to check http endpoints, running processes, tcp ports, etc. The configuration comes directly from the config file.

Index

• Constants
• Variables
• func RemoveSecrets(appURL, message string) string
• type CheckResult
• type CheckState
  • func (c CheckState) String() string
  • func (c CheckState) Value() uint
• type CheckType
• type Config
  • func (c *Config) APIHandler(req *http.Request) (int, any)
  • func (c *Config) GetResults() []*CheckResult
  • func (c *Config) RunCheck(source website.EventType, name string) error
  • func (c *Config) RunChecks(source website.EventType)
  • func (c *Config) Running() bool
  • func (c *Config) SendResults(results *Results)
  • func (c *Config) Setup(services []*Service) error
  • func (c *Config) Start(ctx context.Context)
  • func (c *Config) Stop()
  • func (c *Config) SvcCount() int
• type Output
  • func (o *Output) MarshalJSON() ([]byte, error)
  • func (o *Output) String() string
  • func (o *Output) UnmarshalJSON(input []byte) error
• type ProcInfo
  • func GetAllProcesses(ctx context.Context) ([]*ProcInfo, error)
• type Results
• type Service
  • func (s *Service) CheckOnly(ctx context.Context) *CheckResult
  • func (s *Service) Due() bool
  • func (s *Service) Validate() error

Constants

const (
	DefaultSendInterval  = 10 * time.Minute
	MinimumSendInterval  = DefaultSendInterval / 2
	DefaultCheckInterval = MinimumSendInterval
	MinimumCheckInterval = 10 * time.Second
	MinimumTimeout       = time.Second
	DefaultTimeout       = 10 * MinimumTimeout
	MaximumParallel      = 10
	DefaultBuffer        = 1000
)

Services Defaults.

const PlexServerName = "Plex Server"

This name is hard coded as the service name for Plex.

Variables

var (
	ErrPingExpect    = fmt.Errorf("ping/icmp expect must contain three integers separated by two colons. ex: 3:2:500")
	ErrNoPingVal     = fmt.Errorf("ping or icmp 'check' must not be empty")
	ErrPingCountZero = fmt.Errorf("none of the ping expect values may be set to 0")
)

Custom errors.

var (
	ErrProcExpect = fmt.Errorf("invalid process expect type")
	ErrNoProcVal  = fmt.Errorf("process 'check' must not be empty")
	ErrCountZero  = fmt.Errorf("process 'count' may not be used with 'running'")
	ErrBSDRestart = fmt.Errorf("process 'restart' check does not work on FreeBSD") // one day.
)

Custom errors.

var (
	ErrNoName      = fmt.Errorf("service check is missing a unique name")
	ErrNoCheck     = fmt.Errorf("service check is missing a check value")
	ErrInvalidType = fmt.Errorf("service check type must be one of %s, %s, %s, %s, %s",
		CheckTCP, CheckHTTP, CheckPROC, CheckPING, CheckICMP)
	ErrBadTCP = fmt.Errorf("tcp checks must have an ip:port or host:port combo; the :port is required")
)

Errors returned by this Services package.

var ErrSvcsStopped = fmt.Errorf("service check routine stopped")

Functions

func RemoveSecrets

func RemoveSecrets(appURL, message string) string

RemoveSecrets removes secret token values in a message parsed from a url.

Types

type CheckResult

type CheckResult struct {
	Name        string         `json:"name"`     // "Radarr"
	State       CheckState     `json:"state"`    // 0 = OK, 1 = Warn, 2 = Crit, 3 = Unknown
	Output      *Output        `json:"output"`   // metadata message must never be nil.
	Type        CheckType      `json:"type"`     // http, tcp, ping
	Time        time.Time      `json:"time"`     // when it was checked, rounded to Microseconds
	Since       time.Time      `json:"since"`    // how long it has been in this state, rounded to Microseconds
	Interval    float64        `json:"interval"` // interval in seconds
	Metadata    map[string]any `json:"metadata"` // arbitrary info about the service or result.
	Check       string         `json:"-"`
	Expect      string         `json:"-"`
	IntervalDur time.Duration  `json:"-"`
}

CheckResult represents the status of a service.

type CheckState

type CheckState uint

CheckState represents the current state of a service check.

const (
	StateOK CheckState = iota
	StateWarning
	StateCritical
	StateUnknown
)

Supported check states.

func (CheckState) String

func (c CheckState) String() string

String turns a check status into a human string.

func (CheckState) Value

func (c CheckState) Value() uint

type CheckType

type CheckType string

CheckType locks us into a few specific types of checks.

const (
	CheckHTTP CheckType = "http"
	CheckTCP  CheckType = "tcp"
	CheckPING CheckType = "ping"
	CheckICMP CheckType = "icmp"
	CheckPROC CheckType = "process"
)

These are our supported Check Types.

type Config

type Config struct {
	Interval   cnfg.Duration     `toml:"interval" xml:"interval" json:"interval"`
	Parallel   uint              `toml:"parallel" xml:"parallel" json:"parallel"`
	Disabled   bool              `toml:"disabled" xml:"disabled" json:"disabled"`
	LogFile    string            `toml:"log_file" xml:"log_file" json:"logFile"`
	Apps       *apps.Apps        `toml:"-" json:"-"`
	Website    *website.Server   `toml:"-" json:"-"`
	Plugins    *snapshot.Plugins `toml:"-" json:"-"` // pass this in so we can service-check mysql
	mnd.Logger `json:"-"`        // log file writer
	// contains filtered or unexported fields
}

Config for this Services plugin comes from a config file.

func (*Config) APIHandler

func (c *Config) APIHandler(req *http.Request) (int, any)

APIHandler is passed into the webserver so services can be accessed by the API.

func (*Config) GetResults

func (c *Config) GetResults() []*CheckResult

GetResults creates a copy of all the results and returns them.

func (*Config) RunCheck

func (c *Config) RunCheck(source website.EventType, name string) error

RunCheck runs a single check from an external package.

func (*Config) RunChecks

func (c *Config) RunChecks(source website.EventType)

RunChecks runs checks from an external package.

func (*Config) Running

func (c *Config) Running() bool

func (*Config) SendResults

func (c *Config) SendResults(results *Results)

SendResults sends a set of Results to Notifiarr.

func (*Config) Setup

func (c *Config) Setup(services []*Service) error

func (*Config) Start

func (c *Config) Start(ctx context.Context)

Start begins the service check routines. Runs Parallel checkers and the check reporter.

func (*Config) Stop

func (c *Config) Stop()

Stop sends current states to the website and ends all service checker routines.

func (*Config) SvcCount

func (c *Config) SvcCount() int

SvcCount returns the count of services being monitored.

type Output

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

func (*Output) MarshalJSON

func (o *Output) MarshalJSON() ([]byte, error)

func (*Output) String

func (o *Output) String() string

func (*Output) UnmarshalJSON

func (o *Output) UnmarshalJSON(input []byte) error

type ProcInfo

type ProcInfo struct {
	CmdLine string
	Created time.Time
	PID     int32
}

ProcInfo is derived from a pid.

func GetAllProcesses

func GetAllProcesses(ctx context.Context) ([]*ProcInfo, error)

GetAllProcesses returns all running process on the host.

type Results

type Results struct {
	Type     string            `json:"eventType"`
	What     website.EventType `json:"what"`
	Interval float64           `json:"interval"`
	Svcs     []*CheckResult    `json:"services"`
}

Results is sent to website.

type Service

type Service struct {
	Name     string         `toml:"name" xml:"name" json:"name"`             // Radarr
	Type     CheckType      `toml:"type" xml:"type" json:"type"`             // http
	Value    string         `toml:"check" xml:"check" json:"value"`          // http://some.url
	Expect   string         `toml:"expect" xml:"expect" json:"expect"`       // 200
	Timeout  cnfg.Duration  `toml:"timeout" xml:"timeout" json:"timeout"`    // 10s
	Interval cnfg.Duration  `toml:"interval" xml:"interval" json:"interval"` // 1m
	Tags     map[string]any `toml:"tags" xml:"tags" json:"tags"`             // copied to Metadata.
	// contains filtered or unexported fields
}

Service is a thing we check and report results for.

func (*Service) CheckOnly

func (s *Service) CheckOnly(ctx context.Context) *CheckResult

CheckOnly runs a service check and returns the result immediately. It is not otherwise stored anywhere.

func (*Service) Due

func (s *Service) Due() bool

func (*Service) Validate

func (s *Service) Validate() error