config

Documentation

Index

• type Auth
• type AuthConfig
• type Config
  • func LoadFromFile(fname string) (*Config, error)
• type Settings

Types

type Auth

type Auth struct {
	RemoteWrite       AuthConfig `yaml:"remote_write"`
	RulesAndAlertsAPI AuthConfig `yaml:"rules_and_alerts_api"`
	Query             AuthConfig `yaml:"query"`
}

type AuthConfig

type AuthConfig struct {
	SigV4Config   *sigv4.SigV4Config `yaml:"sigv4"`
	BasicAuthUser string             `yaml:"basic_auth_user"`
	BasicAuthPass string             `yaml:"basic_auth_pass"`
}

type Config

type Config struct {
	Settings  Settings `yaml:"settings"`
	Auth      Auth     `yaml:"auth"`
	TestCases []string `yaml:"test_cases"`
}

Config models the main configuration file.

func LoadFromFile

func LoadFromFile(fname string) (*Config, error)

LoadFromFile parses the given YAML file into a Config.

type Settings

type Settings struct {
	// RemoteWriteURL is URL to remote write samples.
	RemoteWriteURL string `yaml:"remote_write_url"`
	// QueryBaseURL is the URL to query the database via PromQL via GET <QueryBaseURL>/query and <QueryBaseURL>/query_range.
	QueryBaseURL string `yaml:"query_base_url"`
	// RulesAndAlertsAPIBaseURL is the URL to query the GET <RulesAndAlertsAPIBaseURL>/api/v1/rules and <RulesAndAlertsAPIBaseURL>/api/v1/alerts.
	RulesAndAlertsAPIBaseURL string `yaml:"rules_and_alerts_api_base_url"`
	// AlertReceptionServerPort is the port at which the alert receiving server will be run. Default: 8080.
	AlertReceptionServerPort string `yaml:"alert_reception_server_port"`

	DisableRulesAPICheck        bool `yaml:"disable_rules_api_check"`
	DisableAlertsAPICheck       bool `yaml:"disable_alerts_api_check"`
	DisableAlertsMetricsCheck   bool `yaml:"disable_alerts_metrics_check"`
	DisableAlertsReceptionCheck bool `yaml:"disable_alerts_reception_check"`

	AlertMessageParser string `yaml:"alert_message_parser"`
}