logql

type Engine ¶ added in v0.4.0

type Engine interface {
	NewRangeQuery(qs string, start, end time.Time, step time.Duration, direction logproto.Direction, limit uint32) Query
	NewInstantQuery(qs string, ts time.Time, direction logproto.Direction, limit uint32) Query
}

Engine interface used to construct queries

func NewEngine(opts EngineOpts, q Querier) Engine

type EngineOpts ¶ added in v0.4.0

type EngineOpts struct {
	// Timeout for queries execution
	Timeout time.Duration `yaml:"timeout"`
	// MaxLookBackPeriod is the maximum amount of time to look back for log lines.
	// only used for instant log queries.
	MaxLookBackPeriod time.Duration `yaml:"max_look_back_period"`
}

EngineOpts is the list of options to use with the LogQL query engine.

type Evaluator ¶ added in v1.4.0

type Evaluator interface {
	// Evaluator returns a StepEvaluator for a given SampleExpr
	Evaluator(context.Context, SampleExpr, Params) (StepEvaluator, error)
	// Iterator returns the iter.EntryIterator for a given LogSelectorExpr
	Iterator(context.Context, LogSelectorExpr, Params) (iter.EntryIterator, error)
}

Evaluator is an interface for iterating over data at different nodes in the AST

type Expr ¶

type Expr interface {
	fmt.Stringer
	// contains filtered or unexported methods
}

Expr is the root expression which can be a SampleExpr or LogSelectorExpr

func ParseExpr(input string) (expr Expr, err error)

type LineFilter ¶ added in v1.4.0

type LineFilter interface {
	Filter(line []byte) bool
}

LineFilter is a interface to filter log lines.

type LineFilterFunc ¶ added in v1.4.0

type LineFilterFunc func(line []byte) bool

LineFilterFunc is a syntax sugar for creating line filter from a function

func (f LineFilterFunc) Filter(line []byte) bool

type LiteralParams ¶ added in v1.4.0

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

LiteralParams impls Params

func (p LiteralParams) Direction() logproto.Direction

func (p LiteralParams) End() time.Time

func (p LiteralParams) Limit() uint32

func (p LiteralParams) Query() string

func (p LiteralParams) Start() time.Time

func (p LiteralParams) Step() time.Duration

type LogSelectorExpr ¶ added in v0.4.0

type LogSelectorExpr interface {
	Filter() (LineFilter, error)
	Matchers() []*labels.Matcher
	Expr
}

LogSelectorExpr is a LogQL expression filtering and returning logs.

func NewFilterExpr(left LogSelectorExpr, ty labels.MatchType, match string) LogSelectorExpr

func ParseLogSelector(input string) (LogSelectorExpr, error)

type Params ¶ added in v1.4.0

type Params interface {
	Query() string
	Start() time.Time
	End() time.Time
	Step() time.Duration
	Limit() uint32
	Direction() logproto.Direction
}

Params details the parameters associated with a loki request

type ParseError ¶

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

ParseError is what is returned when we failed to parse.

func (p ParseError) Error() string

type Querier ¶

type Querier interface {
	Select(context.Context, SelectParams) (iter.EntryIterator, error)
}

Querier allows a LogQL expression to fetch an EntryIterator for a set of matchers and filters

type QuerierFunc ¶

type QuerierFunc func(context.Context, SelectParams) (iter.EntryIterator, error)

QuerierFunc implements Querier.

func (q QuerierFunc) Select(ctx context.Context, p SelectParams) (iter.EntryIterator, error)

type Query ¶ added in v0.4.0

type Query interface {
	// Exec processes the query.
	Exec(ctx context.Context) (Result, error)
}

Query is a LogQL query to be executed.

type QueryRangeType ¶ added in v1.4.0

type QueryRangeType string

var (
	InstantType QueryRangeType = "instant"
	RangeType   QueryRangeType = "range"
)

func GetRangeType(q Params) QueryRangeType

type RangeVectorAggregator ¶ added in v0.4.0

type RangeVectorAggregator func(int64, []promql.Point) float64

RangeVectorAggregator aggregates samples for a given range of samples. It receives the current milliseconds timestamp and the list of point within the range.

type RangeVectorIterator ¶ added in v0.4.0

type RangeVectorIterator interface {
	Next() bool
	At(aggregator RangeVectorAggregator) (int64, promql.Vector)
	Close() error
}

RangeVectorIterator iterates through a range of samples. To fetch the current vector use `At` with a `RangeVectorAggregator`.

type Result ¶ added in v1.4.0

type Result struct {
	Data       promql.Value
	Statistics stats.Result
}

Result is the result of a query execution.

type SampleExpr ¶ added in v0.4.0

type SampleExpr interface {
	// Selector is the LogQL selector to apply when retrieving logs.
	Selector() LogSelectorExpr
	Expr
}

SampleExpr is a LogQL expression filtering logs and returning metric samples.

type SelectParams ¶ added in v0.4.0

type SelectParams struct {
	*logproto.QueryRequest
}

SelectParams specifies parameters passed to data selections.

func (s SelectParams) LogSelector() (LogSelectorExpr, error)

type StepEvaluator ¶ added in v0.4.0

type StepEvaluator interface {
	// while Next returns a promql.Value, the only acceptable types are Scalar and Vector.
	Next() (bool, int64, promql.Vector)
	// Close all resources used.
	Close() error
}

StepEvaluator evaluate a single step of a query.

type Streams ¶ added in v0.4.0

type Streams []*logproto.Stream

Streams is promql.Value

func (Streams) String() string

func (Streams) Type() promql.ValueType