health

package

v1.63.2 Latest Latest Go to latest Published: Apr 8, 2024 License: Apache-2.0 Imports: 13 Imported by: 1,698

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

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

This section is empty.

This section is empty.

This section is empty.

type Server struct {
	healthgrpc.UnimplementedHealthServer
	// contains filtered or unexported fields
}

Server implements `service Health`.

func NewServer() *Server

NewServer returns a new Server.

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

Check implements `service Health`.

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 (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 (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 (s *Server) Watch(in *healthpb.HealthCheckRequest, stream healthgrpc.Health_WatchServer) error

Watch implements `service Health`.

Path	Synopsis
grpc_health_v1