alerting

Documentation

Index

• Constants
• func AlertBeaconClientSyncComplete(cfg *config.RocketPoolConfig) error
• func AlertExecutionClientSyncComplete(cfg *config.RocketPoolConfig) error
• func AlertFeeRecipientChanged(cfg *config.RocketPoolConfig, newFeeRecipient common.Address, succeeded bool) error
• func AlertMinipoolBalanceDistributed(cfg *config.RocketPoolConfig, minipoolAddress common.Address, succeeded bool) error
• func AlertMinipoolBondReduced(cfg *config.RocketPoolConfig, minipoolAddress common.Address, succeeded bool) error
• func AlertMinipoolPromoted(cfg *config.RocketPoolConfig, minipoolAddress common.Address, succeeded bool) error
• func AlertMinipoolStaked(cfg *config.RocketPoolConfig, minipoolAddress common.Address, succeeded bool) error
• func FetchAlerts(cfg *config.RocketPoolConfig) ([]*models.GettableAlert, error)
• type ClientKind
• type Severity

Constants

const (
	DefaultEndsAtDurationForSeverityInfo     = time.Minute * 5
	DefaultEndsAtDurationForSeverityCritical = time.Minute * 60
)

Functions

func AlertBeaconClientSyncComplete

func AlertBeaconClientSyncComplete(cfg *config.RocketPoolConfig) error

func AlertExecutionClientSyncComplete

func AlertExecutionClientSyncComplete(cfg *config.RocketPoolConfig) error

func AlertFeeRecipientChanged

func AlertFeeRecipientChanged(cfg *config.RocketPoolConfig, newFeeRecipient common.Address, succeeded bool) error

Sends an alert when the node automatically changed a node's fee recipient or attempted to (success or failure). If alerting/metrics are disabled, this function does nothing.

func AlertMinipoolBalanceDistributed

func AlertMinipoolBalanceDistributed(cfg *config.RocketPoolConfig, minipoolAddress common.Address, succeeded bool) error

Sends an alert when the node automatically distributes a minipool's balance (success or failure). If alerting/metrics are disabled, this function does nothing.

func AlertMinipoolBondReduced

func AlertMinipoolBondReduced(cfg *config.RocketPoolConfig, minipoolAddress common.Address, succeeded bool) error

Sends an alert when the node automatically reduced a minipool's bond or attempted to (success or failure). If alerting/metrics are disabled, this function does nothing.

func AlertMinipoolPromoted

func AlertMinipoolPromoted(cfg *config.RocketPoolConfig, minipoolAddress common.Address, succeeded bool) error

Sends an alert when the node automatically prompted a minipool or attempted to (success or failure). If alerting/metrics are disabled, this function does nothing.

func AlertMinipoolStaked

func AlertMinipoolStaked(cfg *config.RocketPoolConfig, minipoolAddress common.Address, succeeded bool) error

Sends an alert when the node automatically staked a minipool or attempted to (success or failure). If alerting/metrics are disabled, this function does nothing.

func FetchAlerts

func FetchAlerts(cfg *config.RocketPoolConfig) ([]*models.GettableAlert, error)

fetches the current alerts directly the alertmanager container/application's API. If alerting/metrics are disabled, this function returns an empty array.

Types

type ClientKind

type ClientKind string

const (
	ClientKindExecution ClientKind = "Execution"
	ClientKindBeacon    ClientKind = "Beacon"
)

type Severity

type Severity string

const (
	SeverityInfo     Severity = "info"
	SeverityWarning  Severity = "warning"
	SeverityCritical Severity = "critical"
)