health

Documentation

Index

• type Checker
  • func New() *Checker
  • func (c *Checker) Check(context.Context, *grpcHealth.HealthCheckRequest) (*grpcHealth.HealthCheckResponse, error)
  • func (c *Checker) GetStatus() grpcHealth.HealthCheckResponse_ServingStatus
  • func (c *Checker) SetStatus(status grpcHealth.HealthCheckResponse_ServingStatus)

Types

type Checker

type Checker struct {
	grpcHealth.UnimplementedHealthServer
	// contains filtered or unexported fields
}

Checker is a simple GRPC Health checker implemtation

func New

func New() *Checker

New creates a new instance of the health checker

func (*Checker) Check

func (c *Checker) Check(context.Context, *grpcHealth.HealthCheckRequest) (*grpcHealth.HealthCheckResponse, error)

Check returns the status of the health checker as a GRPC response

func (*Checker) GetStatus

func (c *Checker) GetStatus() grpcHealth.HealthCheckResponse_ServingStatus

GetStatus gets the current status of the health checker

func (*Checker) SetStatus

func (c *Checker) SetStatus(status grpcHealth.HealthCheckResponse_ServingStatus)

SetStatus sets the reported status for the health checker