probes

Documentation

Index

• func Module() fx.Option
• type Config
  • func NewConfig(s *setting.Setting) (*Config, error)
• type ProbeFunc
• type Probes
  • func New(config *Config, appProvider *app.App) *Probes
  • func (p *Probes) AddLivenessProbes(fn ProbeFunc)
  • func (p *Probes) AddReadinessProbes(fn ProbeFunc)
  • func (p *Probes) Close() error
  • func (p *Probes) Run() error

Functions

func Module

func Module() fx.Option

Types

type Config

type Config struct {
	Enabled           bool
	Port              int
	LivenessEndpoint  string
	ReadinessEndpoint string
}

func NewConfig

func NewConfig(s *setting.Setting) (*Config, error)

type ProbeFunc

type ProbeFunc func() error

type Probes

type Probes struct {
	module.DefaultRunProvider
	Config *Config
	// contains filtered or unexported fields
}

func New

func New(config *Config, appProvider *app.App) *Probes

func (*Probes) AddLivenessProbes

func (p *Probes) AddLivenessProbes(fn ProbeFunc)

func (*Probes) AddReadinessProbes

func (p *Probes) AddReadinessProbes(fn ProbeFunc)

func (*Probes) Close

func (p *Probes) Close() error

func (*Probes) Run

func (p *Probes) Run() error