health

Documentation

Overview

Package health provides a service that exposes server's health and it must be imported to enable support for client-side health checks.

Index

• type Server
  • func NewServer() *Server
  • func (s *Server) Check(_ context.Context, in *healthpb.HealthCheckRequest) (*healthpb.HealthCheckResponse, error)
  • func (s *Server) Resume()
  • func (s *Server) SetServingStatus(service string, servingStatus healthpb.HealthCheckResponse_ServingStatus)
  • func (s *Server) Shutdown()
  • func (s *Server) Watch(in *healthpb.HealthCheckRequest, stream healthgrpc.Health_WatchServer) error

Types

type Server

type Server struct {
	healthgrpc.UnimplementedHealthServer
	// 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(_ context.Context, in *healthpb.HealthCheckRequest) (*healthpb.HealthCheckResponse, error)

Check implements `service Health`.

func (*Server) Resume

func (s *Server) Resume()

Resume sets all serving status to SERVING, and configures the server to accept all future status changes.

This changes serving status for all services. To set status for a particular services, call SetServingStatus().

func (*Server) SetServingStatus

func (s *Server) SetServingStatus(service string, servingStatus 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) Shutdown

func (s *Server) Shutdown()

Shutdown sets all serving status to NOT_SERVING, and configures the server to ignore all future status changes.

This changes serving status for all services. To set status for a particular services, call SetServingStatus().

func (*Server) Watch

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

Watch implements `service Health`.