package config import ( "errors" "fmt" "log" "os" "time" "github.com/TwiN/gatus/v4/alerting" "github.com/TwiN/gatus/v4/alerting/alert" "github.com/TwiN/gatus/v4/alerting/provider" "github.com/TwiN/gatus/v4/config/maintenance" "github.com/TwiN/gatus/v4/config/remote" "github.com/TwiN/gatus/v4/config/ui" "github.com/TwiN/gatus/v4/config/web" "github.com/TwiN/gatus/v4/core" "github.com/TwiN/gatus/v4/security" "github.com/TwiN/gatus/v4/storage" "github.com/TwiN/gatus/v4/util" "gopkg.in/yaml.v2" ) const ( // DefaultConfigurationFilePath is the default path that will be used to search for the configuration file // if a custom path isn't configured through the GATUS_CONFIG_FILE environment variable DefaultConfigurationFilePath = "config/config.yaml" // DefaultFallbackConfigurationFilePath is the default fallback path that will be used to search for the // configuration file if DefaultConfigurationFilePath didn't work DefaultFallbackConfigurationFilePath = "config/config.yml" ) var ( // ErrNoEndpointInConfig is an error returned when a configuration file has no endpoints configured ErrNoEndpointInConfig = errors.New("configuration file should contain at least 1 endpoint") // ErrConfigFileNotFound is an error returned when the configuration file could not be found ErrConfigFileNotFound = errors.New("configuration file not found") // ErrInvalidSecurityConfig is an error returned when the security configuration is invalid ErrInvalidSecurityConfig = errors.New("invalid security configuration") ) // Config is the main configuration structure type Config struct { // Debug Whether to enable debug logs Debug bool `yaml:"debug,omitempty"` // Metrics Whether to expose metrics at /metrics Metrics bool `yaml:"metrics,omitempty"` // SkipInvalidConfigUpdate Whether to make the application ignore invalid configuration // if the configuration file is updated while the application is running SkipInvalidConfigUpdate bool `yaml:"skip-invalid-config-update,omitempty"` // DisableMonitoringLock Whether to disable the monitoring lock // The monitoring lock is what prevents multiple endpoints from being processed at the same time. // Disabling this may lead to inaccurate response times DisableMonitoringLock bool `yaml:"disable-monitoring-lock,omitempty"` // Security Configuration for securing access to Gatus Security *security.Config `yaml:"security,omitempty"` // Alerting Configuration for alerting Alerting *alerting.Config `yaml:"alerting,omitempty"` // Endpoints List of endpoints to monitor Endpoints []*core.Endpoint `yaml:"endpoints,omitempty"` // Services List of endpoints to monitor // // XXX: Remove this in v5.0.0 // XXX: This is not a typo -- not v4.0.0, but v5.0.0 -- I want to give enough time for people to migrate // // Deprecated in favor of Endpoints Services []*core.Endpoint `yaml:"services,omitempty"` // Storage is the configuration for how the data is stored Storage *storage.Config `yaml:"storage,omitempty"` // Web is the web configuration for the application Web *web.Config `yaml:"web,omitempty"` // UI is the configuration for the UI UI *ui.Config `yaml:"ui,omitempty"` // Maintenance is the configuration for creating a maintenance window in which no alerts are sent Maintenance *maintenance.Config `yaml:"maintenance,omitempty"` // Remote is the configuration for remote Gatus instances // WARNING: This is in ALPHA and may change or be completely removed in the future Remote *remote.Config `yaml:"remote,omitempty"` filePath string // path to the file from which config was loaded from lastFileModTime time.Time // last modification time } func (config *Config) GetEndpointByKey(key string) *core.Endpoint { for i := 0; i < len(config.Endpoints); i++ { ep := config.Endpoints[i] if util.ConvertGroupAndEndpointNameToKey(ep.Group, ep.Name) == key { return ep } } return nil } // HasLoadedConfigurationFileBeenModified returns whether the file that the // configuration has been loaded from has been modified since it was last read func (config Config) HasLoadedConfigurationFileBeenModified() bool { if fileInfo, err := os.Stat(config.filePath); err == nil { if !fileInfo.ModTime().IsZero() { return config.lastFileModTime.Unix() != fileInfo.ModTime().Unix() } } return false } // UpdateLastFileModTime refreshes Config.lastFileModTime func (config *Config) UpdateLastFileModTime() { if fileInfo, err := os.Stat(config.filePath); err == nil { if !fileInfo.ModTime().IsZero() { config.lastFileModTime = fileInfo.ModTime() } } else { log.Println("[config][UpdateLastFileModTime] Ran into error updating lastFileModTime:", err.Error()) } } // Load loads a custom configuration file // Note that the misconfiguration of some fields may lead to panics. This is on purpose. func Load(configFile string) (*Config, error) { log.Printf("[config][Load] Reading configuration from configFile=%s", configFile) cfg, err := readConfigurationFile(configFile) if err != nil { if os.IsNotExist(err) { return nil, ErrConfigFileNotFound } return nil, err } cfg.filePath = configFile cfg.UpdateLastFileModTime() return cfg, nil } // LoadDefaultConfiguration loads the default configuration file func LoadDefaultConfiguration() (*Config, error) { cfg, err := Load(DefaultConfigurationFilePath) if err != nil { if err == ErrConfigFileNotFound { return Load(DefaultFallbackConfigurationFilePath) } return nil, err } return cfg, nil } func readConfigurationFile(fileName string) (config *Config, err error) { var bytes []byte if bytes, err = os.ReadFile(fileName); err == nil { // file exists, so we'll parse it and return it return parseAndValidateConfigBytes(bytes) } return } // parseAndValidateConfigBytes parses a Gatus configuration file into a Config struct and validates its parameters func parseAndValidateConfigBytes(yamlBytes []byte) (config *Config, err error) { // Expand environment variables yamlBytes = []byte(os.ExpandEnv(string(yamlBytes))) // Parse configuration file if err = yaml.Unmarshal(yamlBytes, &config); err != nil { return } if config != nil && len(config.Services) > 0 { // XXX: Remove this in v5.0.0 log.Println("WARNING: Your configuration is using 'services:', which is deprecated in favor of 'endpoints:'.") log.Println("WARNING: See https://github.com/TwiN/gatus/issues/191 for more information") config.Endpoints = append(config.Endpoints, config.Services...) config.Services = nil } // Check if the configuration file at least has endpoints configured if config == nil || config.Endpoints == nil || len(config.Endpoints) == 0 { err = ErrNoEndpointInConfig } else { validateAlertingConfig(config.Alerting, config.Endpoints, config.Debug) if err := validateSecurityConfig(config); err != nil { return nil, err } if err := validateEndpointsConfig(config); err != nil { return nil, err } if err := validateWebConfig(config); err != nil { return nil, err } if err := validateUIConfig(config); err != nil { return nil, err } if err := validateMaintenanceConfig(config); err != nil { return nil, err } if err := validateStorageConfig(config); err != nil { return nil, err } if err := validateRemoteConfig(config); err != nil { return nil, err } } return } func validateRemoteConfig(config *Config) error { if config.Remote != nil { if err := config.Remote.ValidateAndSetDefaults(); err != nil { return err } } return nil } func validateStorageConfig(config *Config) error { if config.Storage == nil { config.Storage = &storage.Config{ Type: storage.TypeMemory, } } else { if err := config.Storage.ValidateAndSetDefaults(); err != nil { return err } } return nil } func validateMaintenanceConfig(config *Config) error { if config.Maintenance == nil { config.Maintenance = maintenance.GetDefaultConfig() } else { if err := config.Maintenance.ValidateAndSetDefaults(); err != nil { return err } } return nil } func validateUIConfig(config *Config) error { if config.UI == nil { config.UI = ui.GetDefaultConfig() } else { if err := config.UI.ValidateAndSetDefaults(); err != nil { return err } } return nil } func validateWebConfig(config *Config) error { if config.Web == nil { config.Web = web.GetDefaultConfig() } else { return config.Web.ValidateAndSetDefaults() } return nil } func validateEndpointsConfig(config *Config) error { for _, endpoint := range config.Endpoints { if config.Debug { log.Printf("[config][validateEndpointsConfig] Validating endpoint '%s'", endpoint.Name) } if err := endpoint.ValidateAndSetDefaults(); err != nil { return fmt.Errorf("invalid endpoint %s: %s", endpoint.DisplayName(), err) } } log.Printf("[config][validateEndpointsConfig] Validated %d endpoints", len(config.Endpoints)) return nil } func validateSecurityConfig(config *Config) error { if config.Security != nil { if config.Security.IsValid() { if config.Debug { log.Printf("[config][validateSecurityConfig] Basic security configuration has been validated") } } else { // If there was an attempt to configure security, then it must mean that some confidential or private // data are exposed. As a result, we'll force a panic because it's better to be safe than sorry. return ErrInvalidSecurityConfig } } return nil } // validateAlertingConfig validates the alerting configuration // Note that the alerting configuration has to be validated before the endpoint configuration, because the default alert // returned by provider.AlertProvider.GetDefaultAlert() must be parsed before core.Endpoint.ValidateAndSetDefaults() // sets the default alert values when none are set. func validateAlertingConfig(alertingConfig *alerting.Config, endpoints []*core.Endpoint, debug bool) { if alertingConfig == nil { log.Printf("[config][validateAlertingConfig] Alerting is not configured") return } alertTypes := []alert.Type{ alert.TypeCustom, alert.TypeDiscord, alert.TypeEmail, alert.TypeMatrix, alert.TypeMattermost, alert.TypeMessagebird, alert.TypeOpsgenie, alert.TypePagerDuty, alert.TypeSlack, alert.TypeTeams, alert.TypeTelegram, alert.TypeTwilio, } var validProviders, invalidProviders []alert.Type for _, alertType := range alertTypes { alertProvider := alertingConfig.GetAlertingProviderByAlertType(alertType) if alertProvider != nil { if alertProvider.IsValid() { // Parse alerts with the provider's default alert if alertProvider.GetDefaultAlert() != nil { for _, endpoint := range endpoints { for alertIndex, endpointAlert := range endpoint.Alerts { if alertType == endpointAlert.Type { if debug { log.Printf("[config][validateAlertingConfig] Parsing alert %d with provider's default alert for provider=%s in endpoint=%s", alertIndex, alertType, endpoint.Name) } provider.ParseWithDefaultAlert(alertProvider.GetDefaultAlert(), endpointAlert) } } } } validProviders = append(validProviders, alertType) } else { log.Printf("[config][validateAlertingConfig] Ignoring provider=%s because configuration is invalid", alertType) invalidProviders = append(invalidProviders, alertType) } } else { invalidProviders = append(invalidProviders, alertType) } } log.Printf("[config][validateAlertingConfig] configuredProviders=%s; ignoredProviders=%s", validProviders, invalidProviders) }