apphealth

Documentation

Index

• Constants
• type AppHealth
  • func New(config config.AppHealthConfig, probeFn ProbeFunction) *AppHealth
  • func (h *AppHealth) Close() error
  • func (h *AppHealth) Enqueue()
  • func (h *AppHealth) GetStatus() uint8
  • func (h *AppHealth) OnHealthChange(cb ChangeCallback)
  • func (h *AppHealth) ReportHealth(status uint8)
  • func (h *AppHealth) StartProbes(ctx context.Context) error
• type ChangeCallback
• type ProbeFunction

Constants

const (
	AppStatusUnhealthy uint8 = 0
	AppStatusHealthy   uint8 = 1
)

Types

type AppHealth

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

AppHealth manages the health checks for the app.

func New

func New(config config.AppHealthConfig, probeFn ProbeFunction) *AppHealth

New creates a new AppHealth object.

func (*AppHealth) Close

func (h *AppHealth) Close() error

func (*AppHealth) Enqueue

func (h *AppHealth) Enqueue()

Enqueue adds a new probe request to the queue

func (*AppHealth) GetStatus

func (h *AppHealth) GetStatus() uint8

GetStatus returns the status of the app's health

func (*AppHealth) OnHealthChange

func (h *AppHealth) OnHealthChange(cb ChangeCallback)

OnHealthChange sets the callback that is invoked when the health of the app changes (app becomes either healthy or unhealthy).

func (*AppHealth) ReportHealth

func (h *AppHealth) ReportHealth(status uint8)

ReportHealth is used by the runtime to report a health signal from the app.

func (*AppHealth) StartProbes

func (h *AppHealth) StartProbes(ctx context.Context) error

StartProbes starts polling the app on the interval.

type ChangeCallback

type ChangeCallback func(ctx context.Context, status uint8)

ChangeCallback is the signature of the callback that is invoked when the app's health status changes.

type ProbeFunction

type ProbeFunction func(context.Context) (bool, error)

ProbeFunction is the signature of the function that performs health probes. Health probe functions return errors only in case of internal errors. Network errors are considered probe failures, and should return nil as errors.