Documentation
¶
Overview ¶
Package health contains routines that periodically reports health information of the agent
Index ¶
Constants ¶
View Source
const (
// AgentName is the name of the current agent.
AgentName = "amazon-ssm-agent"
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AgentState ¶
type AgentState int32
AgentState enumerates active and passive agentMode
const ( //Active would suggest the agent is going to start with full capacity since SSM can be reached Active AgentState = 1 //Passive would suggest that the agent is in Backoff and the health will be checked based on current capacity Passive AgentState = 0 )
func GetAgentState ¶
func GetAgentState(h *HealthCheck) (a AgentState, err error)
GetAgentState returns the state of the agent. It is the caller's responsibility to log the error
type HealthCheck ¶
type HealthCheck struct {
// contains filtered or unexported fields
}
HealthCheck encapsulates the logic on configuring, starting and stopping core modules
func NewHealthCheck ¶
func NewHealthCheck(context context.T) *HealthCheck
NewHealthCheck creates a new health check core module. Only one health core module must exist at a time
func (*HealthCheck) ModuleExecute ¶
func (h *HealthCheck) ModuleExecute(context context.T) (err error)
ModuleExecute starts the scheduling of the health check module
func (*HealthCheck) ModuleName ¶
func (h *HealthCheck) ModuleName() string
ModuleName returns the module name
func (*HealthCheck) ModuleRequestStop ¶
func (h *HealthCheck) ModuleRequestStop(stopType contracts.StopType) (err error)
ModuleRequestStop handles the termination of the health check module job
Source Files
Click to show internal directories.
Click to hide internal directories.