config

Documentation

Index

• type AlarmSnoozeConfig
• type AllConfigs
• type BLSKeysMonitorConfig
• type CredentialsConfig
• type EmailPasswordConfig
• type GeneralConfigs
• type LogsConfig
• type MainConfig
• type OutputNotifiersConfig
• type PushoverCredentialsConfig
• type PushoverNotifierConfig
• type SlackCredentialsConfig
• type SlackNotifierConfig
• type SlackSecretConfig
• type SmtpNotifierConfig
• type SystemSelfCheckConfig
• type TelegramCredentialsConfig
• type TelegramNotifierConfig
• type TokenChatIDConfig
• type TokenUserKeyConfig

Types

type AlarmSnoozeConfig

type AlarmSnoozeConfig struct {
	Enabled                          bool
	NumNotificationsForEachFaultyKey uint32
	SnoozeTimeInSec                  uint64
}

AlarmSnoozeConfig defines the alarm snooze configuration

type AllConfigs

type AllConfigs struct {
	Config      MainConfig
	Credentials CredentialsConfig
}

AllConfigs hold all configuration values

type BLSKeysMonitorConfig

type BLSKeysMonitorConfig struct {
	AlarmDeltaRatingDrop     float64
	Name                     string
	ApiURL                   string
	ExplorerURL              string
	PollingIntervalInSeconds int
	ListFile                 string
}

BLSKeysMonitorConfig defines the configuration for the BLS keys monitor

type CredentialsConfig

type CredentialsConfig struct {
	Pushover PushoverCredentialsConfig
	Smtp     EmailPasswordConfig
	Telegram TelegramCredentialsConfig
	Slack    SlackCredentialsConfig
}

CredentialsConfig defines the credentials configuration file

type EmailPasswordConfig

type EmailPasswordConfig struct {
	Email    string
	Password string
}

EmailPasswordConfig defines an email-password credential

type GeneralConfigs

type GeneralConfigs struct {
	ApplicationName string
	SystemSelfCheck SystemSelfCheckConfig
	Logs            LogsConfig
	AlarmSnooze     AlarmSnoozeConfig
}

GeneralConfigs defines the general configurations for the app

type LogsConfig

type LogsConfig struct {
	LogFileLifeSpanInSec int
	LogFileLifeSpanInMB  int
}

LogsConfig defines the logs configuration

type MainConfig

type MainConfig struct {
	General           GeneralConfigs
	OutputNotifiers   OutputNotifiersConfig
	BLSKeysMonitoring []BLSKeysMonitorConfig
}

MainConfig defines the main configuration file

type OutputNotifiersConfig

type OutputNotifiersConfig struct {
	NumRetries            uint32
	SecondsBetweenRetries int
	Pushover              PushoverNotifierConfig
	Smtp                  SmtpNotifierConfig
	Telegram              TelegramNotifierConfig
	Slack                 SlackNotifierConfig
}

OutputNotifiersConfig specifies the implemented types of output notifiers

type PushoverCredentialsConfig

type PushoverCredentialsConfig struct {
	TokenUserKeyConfig
	Additional []TokenUserKeyConfig
}

PushoverCredentialsConfig defines the Pushover service credentials

type PushoverNotifierConfig

type PushoverNotifierConfig struct {
	Enabled bool
	URL     string
}

PushoverNotifierConfig specifies the options for the Pushover service

type SlackCredentialsConfig

type SlackCredentialsConfig struct {
	SlackSecretConfig
	Additional []SlackSecretConfig
}

SlackCredentialsConfig defines the Slack service credentials

type SlackNotifierConfig

type SlackNotifierConfig struct {
	Enabled bool
	URL     string
}

SlackNotifierConfig specifies the options for the Slack service

type SlackSecretConfig

type SlackSecretConfig struct {
	Secret string
}

SlackSecretConfig defines a slack secret credential

type SmtpNotifierConfig

type SmtpNotifierConfig struct {
	Enabled  bool
	To       string
	SmtpPort int
	SmtpHost string
}

SmtpNotifierConfig specifies the options for the SMTP email service

type SystemSelfCheckConfig

type SystemSelfCheckConfig struct {
	Enabled              bool
	DayOfWeek            string
	Hour                 int
	Minute               int
	PollingIntervalInSec int
}

SystemSelfCheckConfig defines the configuration for the self check system

type TelegramCredentialsConfig

type TelegramCredentialsConfig struct {
	TokenChatIDConfig
	Additional []TokenChatIDConfig
}

TelegramCredentialsConfig defines the Telegram service credentials

type TelegramNotifierConfig

type TelegramNotifierConfig struct {
	Enabled bool
	URL     string
}

TelegramNotifierConfig specifies the options for the Telegram service

type TokenChatIDConfig

type TokenChatIDConfig struct {
	Token  string
	ChatID string
}

TokenChatIDConfig defines a struct that contains one token and one chat ID

type TokenUserKeyConfig

type TokenUserKeyConfig struct {
	Token   string
	UserKey string
}

TokenUserKeyConfig defines a struct that contains one token and one user key