report

Documentation

Index

• type Report
• type Result
• type ResultSection
• type RunConfig
• type Section

Types

type Report

type Report interface {
	ID() string
	Run(config RunConfig) Result
}

Report contains an array of all sections and their reports

type Result

type Result struct {
	Version  string          `json:"version"`
	Sections []ResultSection `json:"sections"`
}

Result contains each sections check result

type ResultSection

type ResultSection struct {
	Title   string         `json:"title"`
	Results []check.Result `json:"results"`
}

ResultSection is the individual check and its result

type RunConfig

type RunConfig struct {
	ContainerID string
	Since       time.Duration
}

RunConfig contains the report run parameters

type Section

type Section struct {
	Title  string        `json:"title"`
	Checks []check.Check `json:"checks"`
}

Section is the category of check