agent

Documentation

Index

• Constants
• func NewReportFromConfig(c config.CheckConfig) vulcanreport.Report
• type State

Constants

const (
	// StatusRunning represents the state for a check when running
	StatusRunning = "RUNNING"
	// StatusFinished represents the state after a check has finished
	StatusFinished = "FINISHED"
	// StatusAborted represents the state for a check when it has been aborted
	StatusAborted = "ABORTED"
	// StatusFailed represents the state for a check when has failed it's execution
	StatusFailed = "FAILED"
	// StatusInconclusive represents the state for a check when it could not be executed.
	// E.g.: Asset was unreachable.
	StatusInconclusive = "INCONCLUSIVE"
)

Functions

func NewReportFromConfig

func NewReportFromConfig(c config.CheckConfig) vulcanreport.Report

NewReportFromConfig creates a new report initializing the fields that should be extracted from the config.

Types

type State

type State struct {
	Status   string              `json:"status,omitempty"`
	Progress float32             `json:"progress,omitempty"`
	Report   vulcanreport.Report `json:"report,omitempty"`
}

State holds all the data that must be sent to the agent to communicate check status and report.