scheduler

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

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

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

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

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

type Request struct {
	WorkloadLabel string  // for identifying workload
	FairnessLabel string  // for enforcing fairness
	Tokens        float64 // tokens (e.g. expected latency or complexity) for this request
	InvPriority   float64 // larger values represent higher priority
}

type Scheduler interface {
	// Schedule sends RequestContext to the underlying scheduler and returns a boolean value,
	// where true means accept and false means reject.
	Schedule(ctx context.Context, request *Request) (accept bool, remaining float64, current float64, reqID string)
	// Info returns the last access time and number of requests that are currently in the queue.
	Info() (time.Time, int)
	// Identifiers returns flowID and workloadID for the given request
	Identifiers(workloadLabel, fairnessLabel string, priority float64, generation uint64) (string, string)
}

type TokenBucketMetrics struct {
	FillRateGauge        prometheus.Gauge
	BucketCapacityGauge  prometheus.Gauge
	AvailableTokensGauge prometheus.Gauge
}

type TokenManager interface {
	// Take tokens if available, otherwise return false
	TakeIfAvailable(ctx context.Context, tokens float64) (allowed bool, waitTime time.Duration, remaining float64, current float64, requestID string)
	// Take tokens even if available tokens are less than asked - returns wait time if tokens are not available immediately. The other return value conveys whether the operation was successful or not.
	Take(ctx context.Context, tokens float64) (allowed bool, waitTime time.Duration, remaining float64, current float64, requestID string)
	// Return tokens, useful when requests choose to drop themselves on timeout or cancellation
	Return(ctx context.Context, tokens float64, requestID string)
	// Provides TokenManager the request that the scheduler processing -- some TokenManager implementations use this level of visibility for their algorithms. Return value decides whether the request has to be accepted right away in case TokenManger is not yet ready or configured to accept all traffic (short circuit).
	PreprocessRequest(ctx context.Context, request *Request) (accept bool)
}

type WFQMetrics struct {
	IncomingTokensCounter          prometheus.Counter
	AcceptedTokensCounter          prometheus.Counter
	RejectedTokensCounter          prometheus.Counter
	RequestInQueueDurationSummary  *prometheus.SummaryVec
	WorkloadPreemptedTokensSummary *prometheus.SummaryVec
	WorkloadDelayedTokensSummary   *prometheus.SummaryVec
	WorkloadOnTimeCounter          *prometheus.CounterVec
	FairnessPreemptedTokensSummary *prometheus.SummaryVec
	FairnessDelayedTokensSummary   *prometheus.SummaryVec
	FairnessOnTimeCounter          *prometheus.CounterVec
}

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

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

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