health

type CheckFunc func(context.Context) error

type CheckRequest = grpc_health_v1.HealthCheckRequest

type CheckResponse = grpc_health_v1.HealthCheckResponse

type Checker interface {
	// CheckHealth establish health check to the target service.
	// Return error if target service cannot be reached
	// or not working properly.
	CheckHealth(ctx context.Context) error
}

type Config struct {
	Interval time.Duration `envconfig:"HEALTH_CHECK_INTERVAL" default:"60s"`
	Timeout  time.Duration `envconfig:"HEALTH_CHECK_TIMEOUT" default:"1s"`
}

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

type Server interface {
	// Implements grpc_health_v1.HealthServer for general health check and
	// load balancing according to gRPC protocol.
	grpc_health_v1.HealthServer
	// Implements http.Handler Check API via HTTP.
	http.Handler
	// Register register the Server with grpc.Server
	Register(srv *grpc.Server)
	// Init initialize status, perform necessary setup and start a
	// first health check immediately to update overall status and all
	// dependent services's status.
	Init(status Status) error
	// Close close the underlying resources.
	// It sets all serving status to NOT_SERVING, and configures the server to
	// ignore all future status changes.
	Close() error
}

type ServerOption func(srv *MServer)

type Status = grpc_health_v1.HealthCheckResponse_ServingStatus

type StatusSetter interface {
	// SetStatus is called when need to reset the serving status of a service
	// or insert a new service entry into the statusMap.
	// Use empty string for setting overall status.
	SetStatus(name string, status Status)
}

type WatchServer = grpc_health_v1.Health_WatchServer