health

package
Version: v1.42.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 2, 2021 License: Apache-2.0 Imports: 13 Imported by: 680

Documentation

Overview

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

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Server added in v1.0.2

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

Server implements `service Health`.

func NewServer added in v1.0.2

func NewServer() *Server

NewServer returns a new Server.

func (*Server) Check added in v1.0.2

Check implements `service Health`.

func (*Server) Resume added in v1.18.0

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 (*Server) SetServingStatus added in v1.0.2

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 (*Server) Shutdown added in v1.18.0

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 (*Server) Watch added in v1.15.0

Watch implements `service Health`.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL