acquisition

type DSNConfigurer interface {
	// Configure the datasource
	ConfigureByDSN(ctx context.Context, dsn string, labels map[string]string, logger *log.Entry, uniqueID string) error
}

type DataSource interface {
	// identity, lifecycle
	GetMode() string // Get the mode (TAIL, CAT or SERVER)
	GetName() string // Get the name of the module
	GetUuid() string // Get the unique identifier of the datasource
	Dump() any
	CanRun() error // Whether the datasource can run or not (eg, journalctl on BSD is a non-sense)

	// configuration
	UnmarshalConfig(yamlConfig []byte) error                                                                                 // Decode and pre-validate the YAML datasource - anything that can be checked before runtime
	Configure(ctx context.Context, yamlConfig []byte, logger *log.Entry, metricsLevel metrics.AcquisitionMetricsLevel) error // Complete the YAML datasource configuration and perform runtime checks.
}

type DataSourceUnavailableError struct {
	Name string
	Err  error
}

type Fetcher interface {
	// Start one shot acquisition(eg, cat a file)
	OneShotAcquisition(ctx context.Context, out chan pipeline.Event, acquisTomb *tomb.Tomb) error
}

type MetricsProvider interface {
	// Returns pointers to metrics that are managed by the module
	GetMetrics() []prometheus.Collector

	// Returns pointers to metrics that are managed by the module (aggregated mode, limits cardinality)
	GetAggregMetrics() []prometheus.Collector
}

type RestartableStreamer interface {
	Stream(ctx context.Context, out chan pipeline.Event) error
}

type Tailer interface {
	// Start live acquisition (eg, tail a file)
	StreamingAcquisition(ctx context.Context, out chan pipeline.Event, acquisTomb *tomb.Tomb) error
}