health

Documentation

Index

• type Server
  • func NewChannelHealthServer(httpPort string) *Server
  • func (chs *Server) Alive() bool
  • func (chs *Server) ChannelReady() bool
  • func (chs *Server) ProducerReady() bool
  • func (chs *Server) Ready() bool
  • func (chs *Server) SetChannelReady(isReady bool)
  • func (chs *Server) SetProducerReady(isReady bool)
  • func (chs *Server) Shutdown()

Types

type Server

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

func NewChannelHealthServer

func NewChannelHealthServer(httpPort string) *Server

Creates A New Server With Specified Configuration

func (*Server) Alive

func (chs *Server) Alive() bool

Response Function For Liveness Requests (/healthz)

func (*Server) ChannelReady

func (chs *Server) ChannelReady() bool

Access Function For ChannelReady Flag

func (*Server) ProducerReady

func (chs *Server) ProducerReady() bool

Access Function For ProducerReady Flag

func (*Server) Ready

func (chs *Server) Ready() bool

Response Function For Readiness Requests (/healthy)

func (*Server) SetChannelReady

func (chs *Server) SetChannelReady(isReady bool)

Synchronized Function To Set Channel Ready Flag

func (*Server) SetProducerReady

func (chs *Server) SetProducerReady(isReady bool)

Synchronized Function To Set Producer Ready Flag

func (*Server) Shutdown

func (chs *Server) Shutdown()

Set All Liveness And Readiness Flags To False