config

Documentation

Index

• Constants
• func OverrideConfigFromEnvVars(c *Config) error
• func OverrideConfigFromOptions(c *Config)
• type CheckConfig
• type Config
  • func BuildConfig() (*Config, error)
  • func LoadConfigFromFile(filePath string) (*Config, error)
• type LogConfig

Constants

const (

	// CommModePull Defines the string representing pull communication for check.
	CommModePull = "pull"
	// CommModePush Defines the string representing push communication for check.
	CommModePush = "push"
)

Functions

func OverrideConfigFromEnvVars

func OverrideConfigFromEnvVars(c *Config) error

OverrideConfigFromEnvVars overrides config object with values setted in env vars.

func OverrideConfigFromOptions

func OverrideConfigFromOptions(c *Config)

OverrideConfigFromOptions overrides config object with values setted in env vars.

Types

type CheckConfig

type CheckConfig struct {
	Target           string `toml:"Target"`
	AssetType        string `toml:"AssetType"`
	Opts             string `toml:"Options"`
	CheckID          string `toml:"CheckID"`
	CheckTypeName    string `toml:"CheckTypeName"`
	CheckTypeVersion string `toml:"CheckTypeVersion"`
}

CheckConfig stores config information needed by a check.

type Config

type Config struct {
	Check           CheckConfig       `toml:"Check"`
	Log             LogConfig         `toml:"Log"`
	CommMode        string            `toml:"CommMode"`
	Push            rest.PusherConfig `toml:"Push"`
	Port            *int              `toml:"Port"`
	ShutdownTimeout *int              `toml:"ShutdownTimeout"`

	AllowPrivateIPs *bool             `toml:"AllowPrivateIps"`
	RequiredVars    map[string]string `toml:"RequiredVars"`
	VcsRevision     string            `toml:"VcsRevision"`
}

Config holds all values regarding configuration.

func BuildConfig

func BuildConfig() (*Config, error)

BuildConfig builds a configuration struct by reading, if exists, the conf file and overriding the conf values from env vars.

func LoadConfigFromFile

func LoadConfigFromFile(filePath string) (*Config, error)

LoadConfigFromFile loads configuration file from a path.

type LogConfig

type LogConfig struct {
	LogFmt   string `json:"log_fmt" toml:"LogFmt"`
	LogLevel string `json:"log_level" toml:"LogLevel"`
}

LogConfig defines configuration params for logging.