health

Documentation

Index

• type ReadyService
• type Service
  • func NewService(s ...ReadyService) *Service
  • func (s Service) Live(context.Context, *pb.CheckLive) (*pb.LiveCheck, error)
  • func (s Service) Ready(context.Context, *pb.CheckReady) (*pb.ReadyCheck, error)

Types

type ReadyService

type ReadyService interface {
	Ready() error
}

ReadyService is the interface services must implement to be part of a normal ready check when running in kubernetes

type Service

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

Service is the implementation of a health service

func NewService

func NewService(s ...ReadyService) *Service

NewService creates the service with the other services to ready check

func (Service) Live

func (s Service) Live(context.Context, *pb.CheckLive) (*pb.LiveCheck, error)

Live gets if the server is alive

func (Service) Ready

func (s Service) Ready(context.Context, *pb.CheckReady) (*pb.ReadyCheck, error)

Ready gets if the server is ready for traffic