config

Documentation

Index

• Variables
• type CheckConfig
  • func NewCheckConfig(ctx context.Context, confPath string) (*CheckConfig, error)
  • func (c *CheckConfig) Validate() error
• type InterruptedInterval
  • func (p InterruptedInterval) ToValue() int32
• type MetricCheckRule
• type Provider

Variables

var (
	ErrNoCheckRules     = fmt.Errorf("No check rules defined.")
	ErrNoSuchConfigFile = fmt.Errorf("No such config file.")
	ErrEmptyConfigFile  = fmt.Errorf("The specified config file is empty.")
)

Types

type CheckConfig

type CheckConfig struct {
	Rules []MetricCheckRule `yaml:"check"`
}

func NewCheckConfig

func NewCheckConfig(ctx context.Context, confPath string) (*CheckConfig, error)

NewCheckConfig returns the configuration content loaded from YAML.

func (*CheckConfig) Validate

func (c *CheckConfig) Validate() error

Validate returns the result of the validation.

type InterruptedInterval

type InterruptedInterval string

func (InterruptedInterval) ToValue

func (p InterruptedInterval) ToValue() int32

ToValue returns an int32 type value of the time interval from the string.

type MetricCheckRule

type MetricCheckRule struct {
	Name                string              `yaml:"name"`
	Service             string              `yaml:"service"`
	Roles               []string            `yaml:"roles"`
	InterruptedInterval InterruptedInterval `yaml:"interrupted_interval"`
	Providers           []Provider          `yaml:"providers"`
	InspectionMetrics   map[string][]string `yaml:"inspection_metrics"`
}

type Provider

type Provider string