Documentation
¶
Overview ¶
Package control controls which resources a query may consume.
The Controller manages the resources available to each query and ensures an optimal use of those resources to execute queries in a timely manner. The controller also maintains the state of a query as it goes through the various stages of execution and is responsible for killing currently executing queries when requested by the user.
The Controller manages when a query is executed. This can be based on anything within the query's requested resources. For example, a basic implementation of the Controller may decide to execute anything with a high priority before anything with a low priority. The implementation of the Controller will vary and change over time and this package may provide multiple implementations for different controller algorithms.
During execution, the Controller manages the resources used by the query and provides observabiility into what resources are being used and by which queries. The Controller also imposes limitations so a query that uses more than its allocated resources or more resources than available on the system will be aborted.
Index ¶
- func StartSpanFromContext(ctx context.Context, operationName string, hist prometheus.Observer, ...) (*span, context.Context)
- type Config
- type Controller
- type PriorityQueue
- type Query
- func (q *Query) Cancel()
- func (q *Query) Concurrency() int
- func (q *Query) Done()
- func (q *Query) Err() error
- func (q *Query) ID() QueryID
- func (q *Query) Ready() <-chan map[string]flux.Result
- func (q *Query) Spec() *flux.Spec
- func (q *Query) State() State
- func (q *Query) Statistics() flux.Statistics
- type QueryID
- type State
- type Stringer
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func StartSpanFromContext ¶
func StartSpanFromContext(ctx context.Context, operationName string, hist prometheus.Observer, gauge prometheus.Gauge) (*span, context.Context)
Types ¶
type Config ¶
type Config struct {
ConcurrencyQuota int
MemoryBytesQuota int64
ExecutorDependencies execute.Dependencies
PPlannerOptions []plan.PhysicalOption
LPlannerOptions []plan.LogicalOption
Logger *zap.Logger
Verbose bool
// MetricLabelKeys is a list of labels to add to the metrics produced by the controller.
// The value for a given key will be read off the context.
// The context value must be a string or an implementation of the Stringer interface.
MetricLabelKeys []string
}
type Controller ¶
type Controller struct {
// contains filtered or unexported fields
}
Controller provides a central location to manage all incoming queries. The controller is responsible for queueing, planning, and executing queries.
func New ¶
func New(c Config) *Controller
func (*Controller) PrometheusCollectors ¶
func (c *Controller) PrometheusCollectors() []prometheus.Collector
PrometheusCollectors satisifies the prom.PrometheusCollector interface.
func (*Controller) Queries ¶
func (c *Controller) Queries() []*Query
Queries reports the active queries.
type PriorityQueue ¶
type PriorityQueue struct {
// contains filtered or unexported fields
}
func (*PriorityQueue) Peek ¶
func (p *PriorityQueue) Peek() *Query
func (*PriorityQueue) Pop ¶
func (p *PriorityQueue) Pop() *Query
func (*PriorityQueue) Push ¶
func (p *PriorityQueue) Push(q *Query)
type Query ¶
type Query struct {
// contains filtered or unexported fields
}
Query represents a single request.
func (*Query) Concurrency ¶
Concurrency reports the number of goroutines allowed to process the request.
func (*Query) Ready ¶
Ready returns a channel that will deliver the query results. Its possible that the channel is closed before any results arrive, in which case the query should be inspected for an error using Err().
func (*Query) Statistics ¶
func (q *Query) Statistics() flux.Statistics
Statistics reports the statisitcs for the query. The statisitcs are not complete until the query is finished.
Source Files