health

Documentation

Overview

Package health contains routines that periodically reports health information of the agent

Index

• type HealthCheck
  • func NewHealthCheck(context context.T) *HealthCheck
  • func (h *HealthCheck) Execute(context context.T) (err error)
  • func (h *HealthCheck) Name() string
  • func (h *HealthCheck) RequestStop(stopType contracts.StopType) (err error)

Types

type HealthCheck

type HealthCheck struct {
	contracts.ICorePlugin
	// contains filtered or unexported fields
}

HealthCheck encapsulates the logic on configuring, starting and stopping core plugins

func NewHealthCheck

func NewHealthCheck(context context.T) *HealthCheck

NewHealthCheck creates a new health check core plugin.

func (*HealthCheck) Execute

func (h *HealthCheck) Execute(context context.T) (err error)

Execute starts the scheduling of the health check plugin

func (*HealthCheck) Name

func (h *HealthCheck) Name() string

Name returns the Plugin Name

func (*HealthCheck) RequestStop

func (h *HealthCheck) RequestStop(stopType contracts.StopType) (err error)

RequestStop handles the termination of the health check plugin job