healthcheck

Documentation

Index

• type CheckConfig
• type Client
• type Config
  • func DefaultConfig(dest string) *Config
  • func (conf *Config) Validate() error
• type Server

Types

type CheckConfig

type CheckConfig struct {
	Timeout int `json:"timeout" yaml:"timeout" mapstructure:"timeout"`
	MaxTry  int `json:"max_try" yaml:"max_try" mapstructure:"max_try"`
}

type Client

type Client interface {
	Readiness() error
	Liveness() error
}

type Config

type Config struct {
	Dest      string      `json:"dest" yaml:"dest" mapstructure:"dest"`
	Readiness CheckConfig `json:"readiness" yaml:"readiness" mapstructure:"readiness"`
	Liveness  CheckConfig `json:"liveness" yaml:"liveness" mapstructure:"liveness"`
}

func DefaultConfig

func DefaultConfig(dest string) *Config

func (*Config) Validate

func (conf *Config) Validate() error

type Server

type Server interface {
	Connect(ctx context.Context) error
	Disconnect(ctx context.Context) error
	Readiness(check func() error) error
	Liveness(check func() error) error
}