maintenance

Documentation

Index

• type Config
  • func GetDefaultConfig() *Config
  • func (c Config) IsEnabled() bool
  • func (c Config) IsUnderMaintenance() bool
  • func (c *Config) ValidateAndSetDefaults() error

Types

type Config

type Config struct {
	Enabled  *bool         `yaml:"enabled"`  // Whether the maintenance period is enabled. Enabled by default if nil.
	Start    string        `yaml:"start"`    // Time at which the maintenance period starts (e.g. 23:00)
	Duration time.Duration `yaml:"duration"` // Duration of the maintenance period (e.g. 4h)

	// Every is a list of days of the week during which maintenance period applies.
	// See longDayNames for list of valid values.
	// Every day if empty.
	Every []string `yaml:"every"`
	// contains filtered or unexported fields
}

Config allows for the configuration of a maintenance period. During this maintenance period, no alerts will be sent.

Uses UTC.

func GetDefaultConfig

func GetDefaultConfig() *Config

func (Config) IsEnabled

func (c Config) IsEnabled() bool

IsEnabled returns whether maintenance is enabled or not

func (Config) IsUnderMaintenance

func (c Config) IsUnderMaintenance() bool

IsUnderMaintenance checks whether the services that Gatus monitors are within the configured maintenance window

func (*Config) ValidateAndSetDefaults

func (c *Config) ValidateAndSetDefaults() error

ValidateAndSetDefaults validates the maintenance configuration and sets the default values if necessary.

Must be called once in the application's lifecycle before IsUnderMaintenance is called, since it also sets durationToStartFromMidnight.