probes

Documentation

Index

• type Config
• type Option
  • func WithCheckInterval(d time.Duration) Option
  • func WithCheckTimeout(d time.Duration) Option
  • func WithLogger(logger *zap.Logger) Option
  • func WithProbe(t ProbeType, probe Probe) Option
• type Probe
• type ProbeType
• type Prober
  • func New(opts ...Option) (*Prober, error)
  • func (p *Prober) Liveness() bool
  • func (p *Prober) Readiness() bool
  • func (p *Prober) Run(ctx context.Context) error
  • func (p *Prober) SetStartup(startup bool)
  • func (p *Prober) Startup() bool
  • func (obj *Prober) Validate() error

Types

type Config

type Config struct {
	CheckInterval time.Duration `yaml:"check_interval" validate:"min=1s"`
	CheckTimeout  time.Duration `yaml:"check_timeout" validate:"min=1s"`
}

type Option

type Option = c.Option[*Prober]

func WithCheckInterval

func WithCheckInterval(d time.Duration) Option

func WithCheckTimeout

func WithCheckTimeout(d time.Duration) Option

func WithLogger

func WithLogger(logger *zap.Logger) Option

func WithProbe

func WithProbe(t ProbeType, probe Probe) Option

type Probe

type Probe = func(context.Context) error

type ProbeType

type ProbeType string

const (
	ProbeTypeStartup   ProbeType = "startup"
	ProbeTypeReadiness ProbeType = "readiness"
	ProbeTypeLiveness  ProbeType = "liveness"
)

type Prober

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

func New

func New(opts ...Option) (*Prober, error)

func (*Prober) Liveness

func (p *Prober) Liveness() bool

func (*Prober) Readiness

func (p *Prober) Readiness() bool

func (*Prober) Run

func (p *Prober) Run(ctx context.Context) error

func (*Prober) SetStartup

func (p *Prober) SetStartup(startup bool)

func (*Prober) Startup

func (p *Prober) Startup() bool

func (*Prober) Validate

func (obj *Prober) Validate() error