health

Documentation

Overview

Package health provides some utility functions to health-check a server. The implementation is based on protobuf. Users need to write their own implementations if other IDLs are used.

Index

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

Types

type Server

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

Server implements `service Health`.

func NewServer

func NewServer() *Server

NewServer returns a new Server.

func (*Server) Check

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

Check implements `service Health`.

func (*Server) SetServingStatus

func (s *Server) SetServingStatus(service string, status healthpb.HealthCheckResponse_ServingStatus)

SetServingStatus is called when need to reset the serving status of a service or insert a new service entry into the statusMap.

func (*Server) Watch

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

Watch implements `service Health`.