Interface DataSource

pkg/acquisition/types/types.go:19–45

DataSource is the common interface implemented by all acquisition modules. A DataSource can always be configured from YAML.

//
// A DataSource can always be configured from YAML.
type DataSource interface {
	// identity, lifecycle
	
	// GetMode returns the operating mode of the datasource (e.g. TAIL, CAT, SERVER).
	GetMode() string

	// GetName returns the module name (e.g. "file", "journalctl", "docker").
	GetName() string

	// GetUuid returns a unique identifier for this datasource instance.
	GetUuid() string

	Dump() any

	// CanRun reports whether the datasource can run on the current platform/environment
	// (e.g. journalctl not available on some systems like BSD).
	CanRun() error

	// configuration

	// UnmarshalConfig decodes and pre-validates the YAML datasource configuration.
	// Implementations should validate everything that can be checked without I/O.
	UnmarshalConfig(yamlConfig []byte) error

	// Configure completes datasource configuration and performs runtime checks.
	Configure(ctx context.Context, yamlConfig []byte, logger *log.Entry, metricsLevel metrics.AcquisitionMetricsLevel) error
}

// DataSourceFactory constructs a new unconfigured DataSource instance.
type DataSourceFactory func() DataSource