workloadscheduler

Documentation

Index

• Variables
• func Module() fx.Option
• func SanitizeSchedulerProto(proto *policylangv1.Scheduler) (*policylangv1.Scheduler, error)
• type Factory
  • func (wsFactory *Factory) GetLatencyObserver(labels map[string]string) prometheus.Observer
  • func (wsFactory *Factory) GetRequestCounter(labels map[string]string) prometheus.Counter
  • func (wsFactory *Factory) NewScheduler(clk clockwork.Clock, registry status.Registry, proto *policylangv1.Scheduler, ...) (*Scheduler, error)
  • func (wsFactory *Factory) NewSchedulerMetrics(metricLabels prometheus.Labels) (*SchedulerMetrics, error)
• type Scheduler
  • func (s *Scheduler) Decide(ctx context.Context, labels labels.Labels) iface.LimiterDecision
  • func (s *Scheduler) GetEstimatedTokens(workloadIndex string) (uint64, bool)
  • func (s *Scheduler) GetLatencyObserver(labels map[string]string) prometheus.Observer
  • func (s *Scheduler) GetRequestCounter(labels map[string]string) prometheus.Counter
  • func (s *Scheduler) Info() (time.Time, int)
  • func (s *Scheduler) Revert(ctx context.Context, labels labels.Labels, ...)
  • func (s *Scheduler) SetEstimatedTokens(tokensByWorkloadIndex map[string]uint64)
• type SchedulerMetrics
  • func (metrics *SchedulerMetrics) Delete() error

Variables

var MetricLabelKeys = []string{metrics.PolicyNameLabel, metrics.PolicyHashLabel, metrics.ComponentIDLabel}

MetricLabelKeys is an array of Label Keys for WFQ and Token Bucket Metrics.

Functions

func Module

func Module() fx.Option

Module provides the fx options for the workload scheduler.

func SanitizeSchedulerProto

func SanitizeSchedulerProto(proto *policylangv1.Scheduler) (*policylangv1.Scheduler, error)

SanitizeSchedulerProto sanitizes the scheduler proto.

Types

type Factory

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

Factory is a factory for creating load schedulers.

func (*Factory) GetLatencyObserver

func (wsFactory *Factory) GetLatencyObserver(labels map[string]string) prometheus.Observer

GetLatencyObserver returns a latency observer for a given workload.

func (*Factory) GetRequestCounter

func (wsFactory *Factory) GetRequestCounter(labels map[string]string) prometheus.Counter

GetRequestCounter returns a request counter for a given workload.

func (*Factory) NewScheduler

func (wsFactory *Factory) NewScheduler(
	clk clockwork.Clock,
	registry status.Registry,
	proto *policylangv1.Scheduler,
	component iface.Component,
	tokenManger scheduler.TokenManager,
	schedulerMetrics *SchedulerMetrics,
) (*Scheduler, error)

NewScheduler returns fx options for the load scheduler fx app.

func (*Factory) NewSchedulerMetrics

func (wsFactory *Factory) NewSchedulerMetrics(metricLabels prometheus.Labels) (*SchedulerMetrics, error)

NewSchedulerMetrics creates a new SchedulerMetrics instance.

type Scheduler

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

Scheduler implements load scheduler on the flowcontrol side.

func (*Scheduler) Decide

func (s *Scheduler) Decide(ctx context.Context, labels labels.Labels) iface.LimiterDecision

Decide processes a single flow by load scheduler in a blocking manner.

Context is used to ensure that requests are not scheduled for longer than its deadline allows.

func (*Scheduler) GetEstimatedTokens

func (s *Scheduler) GetEstimatedTokens(workloadIndex string) (uint64, bool)

GetEstimatedTokens returns estimated tokens for specific workload.

func (*Scheduler) GetLatencyObserver

func (s *Scheduler) GetLatencyObserver(labels map[string]string) prometheus.Observer

GetLatencyObserver returns histogram for specific workload.

func (*Scheduler) GetRequestCounter

func (s *Scheduler) GetRequestCounter(labels map[string]string) prometheus.Counter

GetRequestCounter returns request counter for specific workload.

func (*Scheduler) Info

func (s *Scheduler) Info() (time.Time, int)

Info returns information about the scheduler.

func (*Scheduler) Revert

func (s *Scheduler) Revert(ctx context.Context, labels labels.Labels, decision *flowcontrolv1.LimiterDecision)

Revert reverts the decision made by the limiter.

func (*Scheduler) SetEstimatedTokens

func (s *Scheduler) SetEstimatedTokens(tokensByWorkloadIndex map[string]uint64)

SetEstimatedTokens sets estimated tokens for specific workload.

type SchedulerMetrics

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

SchedulerMetrics is a struct that holds all metrics for Scheduler.

func (*SchedulerMetrics) Delete

func (metrics *SchedulerMetrics) Delete() error

Delete removes all metrics from metric vectors.