grpchealth

Documentation

Overview

Package grpchealth package provides server implementing Check rpc that meets https://github.com/grpc/grpc/blob/master/doc/health-checking.md

Index

• type HealthCheckingService
  • func New(log Logger) HealthCheckingService
  • func (s *HealthCheckingService) Check(ctx context.Context, in *grpc_health_v1.HealthCheckRequest) (*grpc_health_v1.HealthCheckResponse, error)
  • func (s *HealthCheckingService) Dead()
  • func (s *HealthCheckingService) Live()
  • func (s *HealthCheckingService) NotReady()
  • func (s *HealthCheckingService) Ready()
  • func (s *HealthCheckingService) Watch(in *grpc_health_v1.HealthCheckRequest, w grpc_health_v1.Health_WatchServer) error
• type Logger

Types

type HealthCheckingService

type HealthCheckingService struct {
	grpc_health_v1.UnimplementedHealthServer
	sync.RWMutex
	// contains filtered or unexported fields
}

func New

func New(log Logger) HealthCheckingService

func (*HealthCheckingService) Check

func (s *HealthCheckingService) Check(ctx context.Context, in *grpc_health_v1.HealthCheckRequest) (
	*grpc_health_v1.HealthCheckResponse, error)

Check implements `service Health`.

func (*HealthCheckingService) Dead

func (s *HealthCheckingService) Dead()

Dead - changes status of service to dead

func (*HealthCheckingService) Live

func (s *HealthCheckingService) Live()

Live - changes status of service to alive

func (*HealthCheckingService) NotReady

func (s *HealthCheckingService) NotReady()

NotReady - changes status of service to not ready

func (*HealthCheckingService) Ready

func (s *HealthCheckingService) Ready()

Ready - changes status of service to ready

func (*HealthCheckingService) Watch

func (s *HealthCheckingService) Watch(in *grpc_health_v1.HealthCheckRequest, w grpc_health_v1.Health_WatchServer) error

type Logger

type Logger = logger.Logger