healthchecker

Documentation

Index

• type Config
  • func (c *Config) Validate() error
• type Monitor
  • func (rm *Monitor) Configure(conf *Config) error

Types

type Config

type Config struct {
	config.MonitorConfig `yaml:",inline" acceptsEndpoints:"true"`

	Host string `yaml:"host" validate:"required"`
	Port uint16 `yaml:"port" validate:"required"`
	Name string `yaml:"name"`

	// The HTTP path that contains a JSON document to verify
	Path string `yaml:"path" default:"/"`
	// If `jsonKey` and `jsonVal` are given, the given endpoint will be
	// interpreted as a JSON document and will be expected to contain the given
	// key and value for the service to be considered healthy.
	JSONKey string `yaml:"jsonKey"`
	// This can be either a string or numeric type
	JSONVal interface{} `yaml:"jsonVal"`
	// If true, the endpoint will be connected to on HTTPS instead of plain
	// HTTP.  It is invalid to specify this if `tcpCheck` is true.
	UseHTTPS bool `yaml:"useHTTPS"`
	// If true, and `useHTTPS` is true, the server's SSL/TLS cert will not be
	// verified.
	SkipSecurity bool `yaml:"skipSecurity"`
	// If true, the plugin will verify that it can connect to the given
	// host/port value. JSON checking is not supported.
	TCPCheck bool `yaml:"tcpCheck"`
}

Config is the monitor-specific config with the generic config embedded

func (*Config) Validate

func (c *Config) Validate() error

Validate the given config

type Monitor

type Monitor struct {
	collectd.MonitorCore
}

Monitor is the main type that represents the monitor

func (*Monitor) Configure

func (rm *Monitor) Configure(conf *Config) error

Configure configures and runs the plugin in collectd