diff --git a/internal/collector/collector.go b/internal/collector/collector.go index 9b1fbb4..726b386 100644 --- a/internal/collector/collector.go +++ b/internal/collector/collector.go @@ -26,6 +26,7 @@ type Collector struct { ExitCodeMetrics map[string]*promhelper.TypedDesc // map of task name to its exit code metric } +// New returns a new Collector. func New(maxFailures int) *Collector { return &Collector{ MaxFailures: maxFailures, @@ -35,6 +36,7 @@ func New(maxFailures int) *Collector { } } +// AddTask adds a Task to the Collector along with its corresponding exit code TypedDesc. func (c *Collector) AddTask(shouldAdd bool, task Task, exitCode *promhelper.TypedDesc) { if shouldAdd { c.Tasks[task.Name()] = task diff --git a/internal/collector/dispersion/dispersion.go b/internal/collector/dispersion/dispersion.go index f104809..fe10607 100644 --- a/internal/collector/dispersion/dispersion.go +++ b/internal/collector/dispersion/dispersion.go @@ -29,6 +29,7 @@ import ( "github.com/sapcc/swift-health-exporter/internal/util" ) +// GetTaskExitCodeTypedDesc returns a TypedDesc for use with dispersion report tasks. func GetTaskExitCodeTypedDesc(r prometheus.Registerer) *promhelper.TypedDesc { taskExitCodeGaugeVec := prometheus.NewGaugeVec( prometheus.GaugeOpts{ diff --git a/internal/collector/recon/recon.go b/internal/collector/recon/recon.go index 7ddbe79..1062840 100644 --- a/internal/collector/recon/recon.go +++ b/internal/collector/recon/recon.go @@ -25,12 +25,14 @@ import ( // This value is overwritten in unit tests. var isTest = false +// TaskOpts holds common parameters that are used by all recon tasks. type TaskOpts struct { PathToExecutable string HostTimeout int CtxTimeout time.Duration } +// GetTaskExitCodeTypedDesc returns a TypedDesc for use with recon tasks. func GetTaskExitCodeTypedDesc(r prometheus.Registerer) *promhelper.TypedDesc { taskExitCodeGaugeVec := prometheus.NewGaugeVec( prometheus.GaugeOpts{