health

Documentation

Index

• type Server
  • func NewHealthServer() *Server
  • func (s *Server) AuthFuncOverride(ctx context.Context, fullMethodName string) (context.Context, error)
  • func (s *Server) Check(ctx context.Context, in *v1.HealthCheckRequest) (*v1.HealthCheckResponse, error)
  • func (s *Server) SetServingStatus(service string, status v1.HealthCheckResponse_ServingStatus)
  • func (s *Server) Watch(*v1.HealthCheckRequest, v1.Health_WatchServer) error

Types

type Server

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

Server represents a Health Check server to check if a service is running or not on some host.

func NewHealthServer

func NewHealthServer() *Server

NewHealthServer creates a new health check server for grpc services.

func (*Server) AuthFuncOverride

func (s *Server) AuthFuncOverride(ctx context.Context, fullMethodName string) (context.Context, error)

func (*Server) Check

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

Check checks if the grpc server is healthy and running.

func (*Server) SetServingStatus

func (s *Server) SetServingStatus(service string, status v1.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(*v1.HealthCheckRequest, v1.Health_WatchServer) error