loki/pkg/dataobj/index/config.go

package index

import (
	"errors"
	"flag"
	"time"

	"github.com/grafana/loki/v3/pkg/dataobj/consumer/logsobj"
)

type Config struct {
	logsobj.BuilderBaseConfig `yaml:",inline"`
	EventsPerIndex            int           `yaml:"events_per_index" experimental:"true"`
	FlushInterval             time.Duration `yaml:"flush_interval" experimental:"true"`
	MaxIdleTime               time.Duration `yaml:"max_idle_time" experimental:"true"`
}

func (cfg *Config) RegisterFlags(f *flag.FlagSet) {
	cfg.RegisterFlagsWithPrefix("dataobj-index-builder.", f)
}

func (cfg *Config) RegisterFlagsWithPrefix(prefix string, f *flag.FlagSet) {
	// Set defaults for base builder configuration
	_ = cfg.TargetPageSize.Set("128KB")
	_ = cfg.TargetObjectSize.Set("64MB")
	_ = cfg.BufferSize.Set("2MB")
	_ = cfg.TargetSectionSize.Set("16MB")
	cfg.BuilderBaseConfig.RegisterFlagsWithPrefix(prefix, f)

	f.IntVar(&cfg.EventsPerIndex, prefix+"events-per-index", 32, "Experimental: The number of events to batch before building an index")
	f.DurationVar(&cfg.FlushInterval, prefix+"flush-interval", 1*time.Minute, "Experimental: How often to check for stale partitions to flush")
	f.DurationVar(&cfg.MaxIdleTime, prefix+"max-idle-time", 30*time.Minute, "Experimental: Maximum time to wait before flushing buffered events")
}

// Validate validates the BuilderConfig.
func (cfg *Config) Validate() error {
	var errs []error

	if err := cfg.BuilderBaseConfig.Validate(); err != nil {
		errs = append(errs, err)
	}

	return errors.Join(errs...)
}