planner

Documentation

Index

• type Config
  • func (cfg *Config) RegisterFlagsWithPrefix(prefix string, f *flag.FlagSet)
  • func (cfg *Config) Validate() error
• type Limits
• type Metrics
  • func NewMetrics(r prometheus.Registerer, getConnectedBuilders func() float64) *Metrics
• type Planner
  • func New(cfg Config, limits Limits, schemaCfg config.SchemaConfig, ...) (*Planner, error)
  • func (p *Planner) BuilderLoop(builder protos.PlannerForBuilder_BuilderLoopServer) error
  • func (p *Planner) NotifyBuilderShutdown(_ context.Context, req *protos.NotifyBuilderShutdownRequest) (*protos.NotifyBuilderShutdownResponse, error)
• type QueueLimits
  • func NewQueueLimits(limits Limits) *QueueLimits
  • func (c *QueueLimits) MaxConsumers(tenantID string, allConsumers int) int
• type QueueTask
  • func NewQueueTask(ctx context.Context, queueTime time.Time, task *protos.ProtoTask, ...) *QueueTask
• type RetentionConfig
  • func (cfg *RetentionConfig) RegisterFlagsWithPrefix(prefix string, f *flag.FlagSet)
  • func (cfg *RetentionConfig) Validate() error
• type RetentionLimits
• type RetentionManager
  • func NewRetentionManager(cfg RetentionConfig, limits RetentionLimits, bloomStore bloomshipper.StoreBase, ...) *RetentionManager
  • func (r *RetentionManager) Apply(ctx context.Context) error
• type TaskMeta

Types

type Config

type Config struct {
	PlanningInterval time.Duration   `yaml:"planning_interval"`
	MinTableOffset   int             `yaml:"min_table_offset"`
	MaxTableOffset   int             `yaml:"max_table_offset"`
	RetentionConfig  RetentionConfig `yaml:"retention"`
	Queue            queue.Config    `yaml:"queue"`
}

Config configures the bloom-planner component.

func (*Config) RegisterFlagsWithPrefix

func (cfg *Config) RegisterFlagsWithPrefix(prefix string, f *flag.FlagSet)

RegisterFlagsWithPrefix registers flags for the bloom-planner configuration.

func (*Config) Validate

func (cfg *Config) Validate() error

type Limits

type Limits interface {
	RetentionLimits
	strategies.Limits
	BloomCreationEnabled(tenantID string) bool
	BloomBuildMaxBuilders(tenantID string) int
	BuilderResponseTimeout(tenantID string) time.Duration
	BloomTaskMaxRetries(tenantID string) int
}

type Metrics

type Metrics struct {
	// contains filtered or unexported fields
}

func NewMetrics

func NewMetrics(
	r prometheus.Registerer,
	getConnectedBuilders func() float64,
) *Metrics

type Planner

type Planner struct {
	services.Service
	// contains filtered or unexported fields
}

func New

func New(
	cfg Config,
	limits Limits,
	schemaCfg config.SchemaConfig,
	storeCfg storage.Config,
	storageMetrics storage.ClientMetrics,
	bloomStore bloomshipper.StoreBase,
	logger log.Logger,
	r prometheus.Registerer,
	rm *ring.RingManager,
) (*Planner, error)

func (*Planner) BuilderLoop

func (p *Planner) BuilderLoop(builder protos.PlannerForBuilder_BuilderLoopServer) error

func (*Planner) NotifyBuilderShutdown

func (p *Planner) NotifyBuilderShutdown(
	_ context.Context,
	req *protos.NotifyBuilderShutdownRequest,
) (*protos.NotifyBuilderShutdownResponse, error)

type QueueLimits

type QueueLimits struct {
	// contains filtered or unexported fields
}

func NewQueueLimits

func NewQueueLimits(limits Limits) *QueueLimits

func (*QueueLimits) MaxConsumers

func (c *QueueLimits) MaxConsumers(tenantID string, allConsumers int) int

MaxConsumers is used to compute how many of the available builders are allowed to handle tasks for a given tenant. 0 is returned when neither limits are applied. 0 means all builders can be used.

type QueueTask

type QueueTask struct {
	*protos.ProtoTask
	*TaskMeta
}

func NewQueueTask

func NewQueueTask(
	ctx context.Context,
	queueTime time.Time,
	task *protos.ProtoTask,
	resultsChannel chan *protos.TaskResult,
) *QueueTask

type RetentionConfig

type RetentionConfig struct {
	Enabled         bool `yaml:"enabled"`
	MaxLookbackDays int  `yaml:"max_lookback_days" doc:"hidden"`
}

func (*RetentionConfig) RegisterFlagsWithPrefix

func (cfg *RetentionConfig) RegisterFlagsWithPrefix(prefix string, f *flag.FlagSet)

func (*RetentionConfig) Validate

func (cfg *RetentionConfig) Validate() error

type RetentionLimits

type RetentionLimits interface {
	RetentionPeriod(userID string) time.Duration
	StreamRetention(userID string) []validation.StreamRetention
	AllByUserID() map[string]*validation.Limits
	DefaultLimits() *validation.Limits
}

type RetentionManager

type RetentionManager struct {
	// contains filtered or unexported fields
}

func NewRetentionManager

func NewRetentionManager(
	cfg RetentionConfig,
	limits RetentionLimits,
	bloomStore bloomshipper.StoreBase,
	metrics *Metrics,
	logger log.Logger,
) *RetentionManager

func (*RetentionManager) Apply

func (r *RetentionManager) Apply(ctx context.Context) error

type TaskMeta

type TaskMeta struct {
	// contains filtered or unexported fields
}