health

type CheckFunc func(ctx context.Context) error

type Checker interface {
	// HealthCheck checks service health status
	HealthCheck(ctx context.Context) error
}

type Reporter interface {
	// LastStatus gets last health status
	LastStatus() Status

	// StatusReportChan returns health status report channel
	// There is only one channel for each reporter instance
	// The message in channel should be consumed immediately, otherwise the message will be dropped
	StatusReportChan() chan Status
}

type RunOption func(*runOptions)

type Runner interface {
	Reporter

	// AddCheck adds health check callback
	AddCheck(name string, cf CheckFunc)

	// Start starts health check runner and returns first result
	Start() Status

	// Stop stops health check runner
	Stop()
}

type Server = grpc_health_v1.HealthServer

type State int

type Status struct {
	State  State
	Error  error
	Source string // Source of error, usually is health check name
}