probes

Documentation

Index

• type Option
  • func WithAppProvider(app *app.App) Option
  • func WithEnabled(enabled bool) Option
  • func WithLiveEndpoint(endpoint string) Option
  • func WithPort(port int) Option
  • func WithReadEndpoint(endpoint string) Option
• type Options
  • func (o *Options) MergeIn(opts ...Option)
• type ProbeFunc
• type Probes
  • func (p *Probes) AddLivenessProbes(fn ProbeFunc)
  • func (p *Probes) AddReadinessProbes(fn ProbeFunc)
  • func (p *Probes) Close() error
  • func (p *Probes) Init() error
  • func (p *Probes) Run() error

Types

type Option

type Option func(*Options)

func WithAppProvider

func WithAppProvider(app *app.App) Option

func WithEnabled

func WithEnabled(enabled bool) Option

func WithLiveEndpoint

func WithLiveEndpoint(endpoint string) Option

func WithPort

func WithPort(port int) Option

func WithReadEndpoint

func WithReadEndpoint(endpoint string) Option

type Options

type Options struct {
	Port              int
	Enabled           bool
	LivenessEndpoint  string
	ReadinessEndpoint string
	AppProvider       *app.App
}

func (*Options) MergeIn

func (o *Options) MergeIn(opts ...Option)

type ProbeFunc

type ProbeFunc func() error

type Probes

type Probes struct {
	providers.AbstractRunProvider

	Opts *Options
	// contains filtered or unexported fields
}

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) Init

func (p *Probes) Init() error

func (*Probes) Run

func (p *Probes) Run() error