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 HealthServer
  • func NewHealthServer() *HealthServer
  • func (s *HealthServer) Check(ctx context.Context, in *healthpb.HealthCheckRequest) (*healthpb.HealthCheckResponse, error)
  • func (s *HealthServer) SetServingStatus(service string, status healthpb.HealthCheckResponse_ServingStatus)

Types

type HealthServer

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

func NewHealthServer

func NewHealthServer() *HealthServer

func (*HealthServer) Check

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

func (*HealthServer) SetServingStatus

func (s *HealthServer) 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.