interface.go

package gatherers

import (
	"context"

	"github.com/openshift/insights-operator/pkg/record"
)

// Interface is an interface for gathering types
type Interface interface {
	// GetName returns the name of the gatherer
	GetName() string

	// GetGatheringFunctions returns all the gathering function implemented by current gatherer
	GetGatheringFunctions(context.Context) (map[string]GatheringClosure, error)
}

// CustomPeriodGatherer gatherers implementing this interface may not get to each archive
// and their period can be different from interval in the config(equal or higher, but never lower)
type CustomPeriodGatherer interface {
	Interface

	// ShouldBeProcessedNow returns true when it's time to process the gatherer
	// is responsible for tracking the time itself
	ShouldBeProcessedNow() bool
	// UpdateLastProcessingTime is called when the gatherer is about to be processed,
	// so that it can update its last processed time for example.
	UpdateLastProcessingTime()
}

type GathererUsingRemoteConfig interface {
	Interface

	// RemoteConfigStatus provides information about the availability and validity of the remote configuration
	// used as source of the data gathering
	RemoteConfigStatus() RemoteConfigStatus
}

// GatheringClosure is a struct containing a closure each gatherer returns
type GatheringClosure struct {
	Run func(context.Context) ([]record.Record, []error)
}

// RemoteConfigStatus is a struct providing information about the availability
// and validity of the remote configuration
type RemoteConfigStatus struct {
	Err             error
	AvailableReason string
	ValidReason     string
	ConfigData      []byte
	ConfigAvailable bool
	ConfigValid     bool
}