promql

package
v2.0.0-rc.0+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 5, 2017 License: Apache-2.0 Imports: 29 Imported by: 1,477

Documentation

Index

Constants

View Source 
const (
	ValueTypeNone   = "none"
	ValueTypeVector = "vector"
	ValueTypeScalar = "scalar"
	ValueTypeMatrix = "matrix"
	ValueTypeString = "string"
)

The valid value types.

View Source 
const LowestPrec = 0 // Non-operators.

LowestPrec is a constant for operator precedence in expressions.

Variables

View Source 
var DefaultEngineOptions = &EngineOptions{
	MaxConcurrentQueries: 20,
	Timeout:              2 * time.Minute,
	Logger:               log.NewNopLogger(),
}

DefaultEngineOptions are the default engine options.

View Source 
var LookbackDelta = 5 * time.Minute

LookbackDelta determines the time since the last sample after which a time series is considered stale.

Functions

func Inspect added in v1.0.0 

func Inspect(node Node, f func(Node) bool)

Inspect traverses an AST in depth-first order: It starts by calling f(node); node must not be nil. If f returns true, Inspect invokes f for all the non-nil children of node, recursively.

func ParseMetric added in v1.0.0 

func ParseMetric(input string) (m labels.Labels, err error)

ParseMetric parses the input into a metric

func ParseMetricSelector added in v1.0.0 

func ParseMetricSelector(input string) (m []*labels.Matcher, err error)

ParseMetricSelector parses the provided textual metric selector into a list of label matchers.

func Tree added in v1.0.0 

func Tree(node Node) string

Tree returns a string of the tree structure of the given node.

func Walk added in v1.0.0 

func Walk(v Visitor, node Node)

Walk traverses an AST in depth-first order: It starts by calling v.Visit(node); node must not be nil. If the visitor w returned by v.Visit(node) is not nil, Walk is invoked recursively with visitor w for each of the non-nil children of node, followed by a call of w.Visit(nil).

Types

type AggregateExpr added in v1.0.0 

type AggregateExpr struct {
	Op       itemType // The used aggregation operation.
	Expr     Expr     // The Vector expression over which is aggregated.
	Param    Expr     // Parameter used by some aggregators.
	Grouping []string // The labels by which to group the Vector.
	Without  bool     // Whether to drop the given labels rather than keep them.
}

AggregateExpr represents an aggregation operation on a Vector.

func (*AggregateExpr) String added in v1.0.0 

func (node *AggregateExpr) String() string

func (*AggregateExpr) Type added in v1.0.0 

func (e *AggregateExpr) Type() ValueType

type AlertStmt added in v1.0.0 

type AlertStmt struct {
	Name        string
	Expr        Expr
	Duration    time.Duration
	Labels      labels.Labels
	Annotations labels.Labels
}

AlertStmt represents an added alert rule.

func (*AlertStmt) String added in v1.0.0 

func (node *AlertStmt) String() string

type BinaryExpr added in v1.0.0 

type BinaryExpr struct {
	Op       itemType // The operation of the expression.
	LHS, RHS Expr     // The operands on the respective sides of the operator.

	// The matching behavior for the operation if both operands are Vectors.
	// If they are not this field is nil.
	VectorMatching *VectorMatching

	// If a comparison operator, return 0/1 rather than filtering.
	ReturnBool bool
}

BinaryExpr represents a binary expression between two child expressions.

func (*BinaryExpr) String added in v1.0.0 

func (node *BinaryExpr) String() string

func (*BinaryExpr) Type added in v1.0.0 

func (e *BinaryExpr) Type() ValueType

type Call added in v1.0.0 

type Call struct {
	Func *Function   // The function that was called.
	Args Expressions // Arguments used in the call.
}

Call represents a function call.

func (*Call) String added in v1.0.0 

func (node *Call) String() string

func (*Call) Type added in v1.0.0 

func (e *Call) Type() ValueType

type Engine 

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

Engine handles the lifetime of queries from beginning to end. It is connected to a querier.

func NewEngine 

func NewEngine(queryable Queryable, o *EngineOptions) *Engine

NewEngine returns a new engine.

func (*Engine) NewInstantQuery 

func (ng *Engine) NewInstantQuery(qs string, ts time.Time) (Query, error)

NewInstantQuery returns an evaluation query for the given expression at the given time.

func (*Engine) NewRangeQuery 

func (ng *Engine) NewRangeQuery(qs string, start, end time.Time, interval time.Duration) (Query, error)

NewRangeQuery returns an evaluation query for the given time range and with the resolution set by the interval.

type EngineOptions added in v1.0.0 

type EngineOptions struct {
	MaxConcurrentQueries int
	Timeout              time.Duration
	Logger               log.Logger
}

EngineOptions contains configuration parameters for an Engine.

type ErrQueryCanceled 

type ErrQueryCanceled string

ErrQueryCanceled is returned if a query was canceled during processing.

func (ErrQueryCanceled) Error 

func (e ErrQueryCanceled) Error() string

type ErrQueryTimeout 

type ErrQueryTimeout string

ErrQueryTimeout is returned if a query timed out during processing.

func (ErrQueryTimeout) Error 

func (e ErrQueryTimeout) Error() string

type ErrStorage 

type ErrStorage error

ErrStorage is returned if an error was encountered in the storage layer during query handling.

type EvalStmt added in v1.0.0 

type EvalStmt struct {
	Expr Expr // Expression to be evaluated.

	// The time boundaries for the evaluation. If Start equals End an instant
	// is evaluated.
	Start, End time.Time
	// Time between two evaluated instants for the range [Start:End].
	Interval time.Duration
}

EvalStmt holds an expression and information on the range it should be evaluated on.

func (*EvalStmt) String added in v1.0.0 

func (node *EvalStmt) String() string

type Expr added in v1.0.0 

type Expr interface {
	Node

	// Type returns the type the expression evaluates to. It does not perform
	// in-depth checks as this is done at parsing-time.
	Type() ValueType
	// contains filtered or unexported methods
}

Expr is a generic interface for all expression types.

func ParseExpr added in v1.0.0 

func ParseExpr(input string) (Expr, error)

ParseExpr returns the expression parsed from the input.

type Expressions added in v1.0.0 

type Expressions []Expr

Expressions is a list of expression nodes that implements Node.

func (Expressions) String added in v1.0.0 

func (es Expressions) String() (s string)

type Function added in v1.0.0 

type Function struct {
	Name       string
	ArgTypes   []ValueType
	Variadic   int
	ReturnType ValueType
	Call       func(ev *evaluator, args Expressions) Value
}

Function represents a function of the expression language and is used by function nodes.

type Matrix 

type Matrix []Series

Matrix is a slice of Seriess that implements sort.Interface and has a String method.

func (Matrix) Len 

func (m Matrix) Len() int

func (Matrix) Less 

func (m Matrix) Less(i, j int) bool

func (Matrix) String 

func (m Matrix) String() string

func (Matrix) Swap 

func (m Matrix) Swap(i, j int)

func (Matrix) Type 

func (Matrix) Type() ValueType

type MatrixSelector added in v1.0.0 

type MatrixSelector struct {
	Name          string
	Range         time.Duration
	Offset        time.Duration
	LabelMatchers []*labels.Matcher
	// contains filtered or unexported fields
}

MatrixSelector represents a Matrix selection.

func (*MatrixSelector) String added in v1.0.0 

func (node *MatrixSelector) String() string

func (*MatrixSelector) Type added in v1.0.0 

func (e *MatrixSelector) Type() ValueType

type Node added in v1.0.0 

type Node interface {
	// String representation of the node that returns the given node when parsed
	// as part of a valid query.
	String() string
}

Node is a generic interface for all nodes in an AST.

Whenever numerous nodes are listed such as in a switch-case statement or a chain of function definitions (e.g. String(), expr(), etc.) convention is to list them as follows:

  • Statements
  • statement types (alphabetical)
  • ...
  • Expressions
  • expression types (alphabetical)
  • ...

type NumberLiteral added in v1.0.0 

type NumberLiteral struct {
	Val float64
}

NumberLiteral represents a number.

func (*NumberLiteral) String added in v1.0.0 

func (node *NumberLiteral) String() string

func (*NumberLiteral) Type added in v1.0.0 

func (e *NumberLiteral) Type() ValueType

type ParenExpr added in v1.0.0 

type ParenExpr struct {
	Expr Expr
}

ParenExpr wraps an expression so it cannot be disassembled as a consequence of operator precedence.

func (*ParenExpr) String added in v1.0.0 

func (node *ParenExpr) String() string

func (*ParenExpr) Type added in v1.0.0 

func (e *ParenExpr) Type() ValueType

type ParseErr added in v1.0.0 

type ParseErr struct {
	Line, Pos int
	Err       error
}

ParseErr wraps a parsing error with line and position context. If the parsing input was a single line, line will be 0 and omitted from the error string.

func (*ParseErr) Error added in v1.0.0 

func (e *ParseErr) Error() string

type Point 

type Point struct {
	T int64
	V float64
}

Point represents a single data point for a given timestamp.

func (Point) MarshalJSON 

func (p Point) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler.

func (Point) String 

func (p Point) String() string

type Pos added in v1.0.0 

type Pos int

Pos is the position in a string.

type Query 

type Query interface {
	// Exec processes the query and
	Exec(ctx context.Context) *Result
	// Statement returns the parsed statement of the query.
	Statement() Statement
	// Stats returns statistics about the lifetime of the query.
	Stats() *stats.TimerGroup
	// Cancel signals that a running query execution should be aborted.
	Cancel()
}

A Query is derived from an a raw query string and can be run against an engine it is associated with.

type Queryable added in v1.3.0 

type Queryable interface {
	Querier(ctx context.Context, mint, maxt int64) (storage.Querier, error)
}

Queryable allows opening a storage querier.

type RecordStmt added in v1.0.0 

type RecordStmt struct {
	Name   string
	Expr   Expr
	Labels labels.Labels
}

RecordStmt represents an added recording rule.

func (*RecordStmt) String added in v1.0.0 

func (node *RecordStmt) String() string

type Result 

type Result struct {
	Err   error
	Value Value
}

Result holds the resulting value of an execution or an error if any occurred.

func (*Result) Matrix 

func (r *Result) Matrix() (Matrix, error)

Matrix returns a Matrix. An error is returned if the result was an error or the result value is not a Matrix.

func (*Result) Scalar 

func (r *Result) Scalar() (Scalar, error)

Scalar returns a Scalar value. An error is returned if the result was an error or the result value is not a Scalar.

func (*Result) String 

func (r *Result) String() string

func (*Result) Vector 

func (r *Result) Vector() (Vector, error)

Vector returns a Vector if the result value is one. An error is returned if the result was an error or the result value is not a Vector.

type Sample 

type Sample struct {
	Point

	Metric labels.Labels
}

Sample is a single sample belonging to a metric.

func (Sample) MarshalJSON 

func (s Sample) MarshalJSON() ([]byte, error)

func (Sample) String 

func (s Sample) String() string

type Scalar 

type Scalar struct {
	T int64
	V float64
}

Scalar is a data point that's explicitly not associated with a metric.

func (Scalar) MarshalJSON 

func (s Scalar) MarshalJSON() ([]byte, error)

func (Scalar) String 

func (s Scalar) String() string

func (Scalar) Type 

func (Scalar) Type() ValueType

type Series 

type Series struct {
	Metric labels.Labels `json:"metric"`
	Points []Point       `json:"values"`
}

Series is a stream of data points belonging to a metric.

func (Series) String 

func (s Series) String() string

type Statement added in v1.0.0 

type Statement interface {
	Node
	// contains filtered or unexported methods
}

Statement is a generic interface for all statements.

type Statements added in v1.0.0 

type Statements []Statement

Statements is a list of statement nodes that implements Node.

func ParseStmts added in v1.0.0 

func ParseStmts(input string) (Statements, error)

ParseStmts parses the input and returns the resulting statements or any occurring error.

func (Statements) String added in v1.0.0 

func (stmts Statements) String() (s string)

type String 

type String struct {
	V string
	T int64
}

String represents a string value.

func (String) MarshalJSON 

func (s String) MarshalJSON() ([]byte, error)

func (String) String 

func (s String) String() string

func (String) Type 

func (String) Type() ValueType

type StringLiteral added in v1.0.0 

type StringLiteral struct {
	Val string
}

StringLiteral represents a string.

func (*StringLiteral) String added in v1.0.0 

func (node *StringLiteral) String() string

func (*StringLiteral) Type added in v1.0.0 

func (e *StringLiteral) Type() ValueType

type Test 

type Test struct {
	testutil.T
	// contains filtered or unexported fields
}

Test is a sequence of read and write commands that are run against a test storage.

func NewTest 

func NewTest(t testutil.T, input string) (*Test, error)

NewTest returns an initialized empty Test.

func (*Test) Close 

func (t *Test) Close()

Close closes resources associated with the Test.

func (*Test) Context 

func (t *Test) Context() context.Context

Context returns the test's context.

func (*Test) QueryEngine 

func (t *Test) QueryEngine() *Engine

QueryEngine returns the test's query engine.

func (*Test) Run 

func (t *Test) Run() error

Run executes the command sequence of the test. Until the maximum error number is reached, evaluation errors do not terminate execution.

func (*Test) Storage 

func (t *Test) Storage() storage.Storage

Storage returns the test's storage.

type UnaryExpr added in v1.0.0 

type UnaryExpr struct {
	Op   itemType
	Expr Expr
}

UnaryExpr represents a unary operation on another expression. Currently unary operations are only supported for Scalars.

func (*UnaryExpr) String added in v1.0.0 

func (node *UnaryExpr) String() string

func (*UnaryExpr) Type added in v1.0.0 

func (e *UnaryExpr) Type() ValueType

type Value 

type Value interface {
	Type() ValueType
	String() string
}

Value is a generic interface for values resulting from a query evaluation.

type ValueType 

type ValueType string

ValueType describes a type of a value.

type Vector 

type Vector []Sample

Vector is basically only an alias for model.Samples, but the contract is that in a Vector, all Samples have the same timestamp.

func (Vector) String 

func (vec Vector) String() string

func (Vector) Type 

func (Vector) Type() ValueType

type VectorMatchCardinality added in v1.0.0 

type VectorMatchCardinality int

VectorMatchCardinality describes the cardinality relationship of two Vectors in a binary operation. 

const (
	CardOneToOne VectorMatchCardinality = iota
	CardManyToOne
	CardOneToMany
	CardManyToMany
)

func (VectorMatchCardinality) String added in v1.0.0 

func (vmc VectorMatchCardinality) String() string

type VectorMatching added in v1.0.0 

type VectorMatching struct {
	// The cardinality of the two Vectors.
	Card VectorMatchCardinality
	// MatchingLabels contains the labels which define equality of a pair of
	// elements from the Vectors.
	MatchingLabels []string
	// On includes the given label names from matching,
	// rather than excluding them.
	On bool
	// Include contains additional labels that should be included in
	// the result from the side with the lower cardinality.
	Include []string
}

VectorMatching describes how elements from two Vectors in a binary operation are supposed to be matched.

type VectorSelector added in v1.0.0 

type VectorSelector struct {
	Name          string
	Offset        time.Duration
	LabelMatchers []*labels.Matcher
	// contains filtered or unexported fields
}

VectorSelector represents a Vector selection.

func (*VectorSelector) String added in v1.0.0 

func (node *VectorSelector) String() string

func (*VectorSelector) Type added in v1.0.0 

func (e *VectorSelector) Type() ValueType

type Visitor added in v1.0.0 

type Visitor interface {
	Visit(node Node) (w Visitor)
}

Visitor allows visiting a Node and its child nodes. The Visit method is invoked for each node encountered by Walk. If the result visitor w is not nil, Walk visits each of the children of node with the visitor w, followed by a call of w.Visit(nil).

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.