probefx

Documentation

Index

• Variables
• func AsCheckerProvider[T any](fn func(v T) (name string, cfn CheckerFunc)) any
• type CheckerFunc
• type Options
• type Params
  • func DecodeParams(fset *flag.FlagSet) *Params
• type Probe
  • func New(opts Options) Probe
• type Result
  • func NewResult() Result

Variables

var Module = fx.Module(
	"winterfx_core_probefx",
	fx.Provide(
		flagfx.AsDecoderFunc(DecodeParams),
		New,
	),
)

Functions

func AsCheckerProvider

func AsCheckerProvider[T any](fn func(v T) (name string, cfn CheckerFunc)) any

Types

type CheckerFunc

type CheckerFunc func(ctx context.Context) error

type Options

type Options struct {
	fx.In

	*Params

	Checkers []checker `group:"winterfx_core_probefx_checkers"`
}

type Params

type Params struct {
	Cascade int64
}

func DecodeParams

func DecodeParams(fset *flag.FlagSet) *Params

DecodeParams decode probe params

type Probe

type Probe interface {
	// CheckLiveness check liveness
	CheckLiveness() bool

	// CheckReadiness check readiness
	CheckReadiness(ctx context.Context) (s string, failed bool)
}

Probe is a check probe

func New

func New(opts Options) Probe

type Result

type Result interface {
	Collect(name string, err error)

	Result() (s string, failed bool)
}

func NewResult

func NewResult() Result