health

README

health

Simple health checks following the GRPC Health Checking Protocol

Documentation

Index

• type HealthCheck
• type Server
  • func NewServer() *Server
  • func (s *Server) AddHealthCheck(service string, check HealthCheck)
  • func (s *Server) Check(ctx context.Context, in *healthpb.HealthCheckRequest) (*healthpb.HealthCheckResponse, error)
  • func (s *Server) Watch(in *healthpb.HealthCheckRequest, stream healthpb.Health_WatchServer) error

Types

type HealthCheck

type HealthCheck interface {
	IsHealthy() bool
}

type Server

type Server struct {
	healthpb.UnimplementedHealthServer
	// contains filtered or unexported fields
}

Server implements grpc health checks

func NewServer

func NewServer() *Server

NewServer returns a new Server.

func (*Server) AddHealthCheck

func (s *Server) AddHealthCheck(service string, check HealthCheck)

func (*Server) Check

func (s *Server) Check(ctx context.Context, in *healthpb.HealthCheckRequest) (*healthpb.HealthCheckResponse, error)

func (*Server) Watch

func (s *Server) Watch(in *healthpb.HealthCheckRequest, stream healthpb.Health_WatchServer) error