Package: google.golang.org/grpc/health

package health Import Path google.golang.org/grpc/health (on go.dev) Dependency Relation imports 14 packages, and imported by 0 packages

Involved Source Files client.go logging.go producer.go d server.go Package health provides a service that exposes server's health and it must be imported to enable support for client-side health checks.

Package-Level Type Names (total 3, in which 1 is exported)

/* sort exporteds by: alphabet | popularity */

type Server (struct) Server implements `service Health`. Fields (total 5, in which 1 is exported) UnimplementedHealthServer healthgrpc.UnimplementedHealthServer /* 4 unexporteds ... *//* 4 unexporteds: */ mu sync.RWMutex shutdown bool If shutdown is true, it's expected all serving status is NOT_SERVING, and will stay in NOT_SERVING. statusMap map[string]healthpb.HealthCheckResponse_ServingStatus statusMap stores the serving status of the services this Server monitors. updates map[string]map[healthgrpc.Health_WatchServer]chan healthpb.HealthCheckResponse_ServingStatus Methods (total 8, in which 6 are exported) (*Server) Check(_ context.Context, in *healthpb.HealthCheckRequest) (*healthpb.HealthCheckResponse, error) Check implements `service Health`. (*Server) List(_ context.Context, _ *healthpb.HealthListRequest) (*healthpb.HealthListResponse, error) List implements `service Health`. (*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(). (*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. (*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(). (*Server) Watch(in *healthpb.HealthCheckRequest, stream healthgrpc.Health_WatchServer) error Watch implements `service Health`. /* 2 unexporteds ... *//* 2 unexporteds: */ (*Server) setServingStatusLocked(service string, servingStatus healthpb.HealthCheckResponse_ServingStatus) ( Server) testEmbeddedByValue() Implements (at least one exported) *Server : google.golang.org/grpc/health/grpc_health_v1.HealthServer As Outputs Of (at least one exported) func NewServer() *Server

/* 2 unexporteds ... *//* 2 unexporteds: */

type healthServiceProducer (struct) Fields (total 3, none are exported) /* 3 unexporteds ... *//* 3 unexporteds: */ cancel func() cc grpc.ClientConnInterface The following fields are initialized at build time and read-only after that and therefore do not need to be guarded by a mutex. mu sync.Mutex Methods (only one, which is unexported) /* one unexported ... *//* one unexported: */ (*healthServiceProducer) startHealthCheck(ctx context.Context, sc balancer.SubConn, serviceName string, listener func(balancer.SubConnState))

type producerBuilder (struct) Methods (only one, which is exported) (*producerBuilder) Build(cci any) (balancer.Producer, func()) Build constructs and returns a producer and its cleanup function. Implements (at least one exported) *producerBuilder : google.golang.org/grpc/balancer.ProducerBuilder As Types Of (only one, which is unexported) /* one unexported ... *//* one unexported: */ var producerBuilderSingleton *producerBuilder

Package-Level Functions (total 5, in which 1 is exported)

func NewServer() *Server NewServer returns a new Server.

/* 4 unexporteds ... *//* 4 unexporteds: */

func clientHealthCheck(ctx context.Context, newStream func(string) (any, error), setConnectivityState func(connectivity.State, error), service string) error This function implements the protocol defined at: https://github.com/grpc/grpc/blob/master/doc/health-checking.md

func init()

func registerClientSideHealthCheckListener(ctx context.Context, sc balancer.SubConn, serviceName string, listener func(balancer.SubConnState)) func() registerClientSideHealthCheckListener accepts a listener to provide server health state via the health service.

Package-Level Variables (total 4, none are exported) /* 4 unexporteds ... *//* 4 unexporteds: */

var backoffFunc func(ctx context.Context, retries int) bool

var backoffStrategy backoff.Exponential

var logger grpclog.DepthLoggerV2

var producerBuilderSingleton *producerBuilder

Package-Level Constants (total 2, neither is exported) /* 2 unexporteds ... *//* 2 unexporteds: */

const healthCheckMethod = "/grpc.health.v1.Health/Watch"

const maxAllowedServices = 100 maxAllowedServices defines the maximum number of resources a List operation can return. An error is returned if the number of services exceeds this limit.