healthchecker

Documentation

Index

• type CheckFn
• type Checker
  • func New(l zerolog.Logger, checkFn CheckFn, cfg Config) *Checker
  • func (c *Checker) Start(_ context.Context) error
  • func (c *Checker) Stop(_ context.Context) error
• type Config

Types

type CheckFn

type CheckFn func(ctx context.Context, log *zerolog.Logger) bool

type Checker

type Checker struct {
	// contains filtered or unexported fields
}

func New

func New(l zerolog.Logger, checkFn CheckFn, cfg Config) *Checker

func (*Checker) Start

func (c *Checker) Start(_ context.Context) error

func (*Checker) Stop

func (c *Checker) Stop(_ context.Context) error

type Config

type Config struct {
	MaxBlockLag  time.Duration `env:"HEALTHCHECK_MAX_LAST_BLOCK_LAG" envDefault:"5m"`
	Interval     time.Duration `env:"HEALTHCHECK_INTERVAL" envDefault:"1m"`
	StartDelay   time.Duration `env:"HEALTHCHECK_START_DELAY"`
	Enabled      bool          `env:"HEALTHCHECK_ENABLED" envDefault:"false"`
	FatalOnCheck bool          `env:"HEALTHCHECK_FATAL_ON_CHECK" envDefault:"true"`
}