promql

Documentation

Overview

Package promql provides a PromQL engine implementation.

Index

• func NewFilteredSelector(q storage.Querier, matchers, filters []*labels.Matcher, ...) promscanners.SeriesSelector
• func NewHistogramStatsSelector(seriesSelector promscanners.SeriesSelector) promscanners.SeriesSelector
• func NewSelector(q storage.Querier, matchers []*labels.Matcher, hints storage.SelectHints) promscanners.SeriesSelector
• func SeriesShard(series []promscanners.SignedSeries, index, numShards int) []promscanners.SignedSeries
• type Engine
  • func New(q Querier, opts promql.EngineOpts) (Engine, error)
• type EngineOpts
• type Querier

Functions

func NewFilteredSelector

func NewFilteredSelector(q storage.Querier, matchers, filters []*labels.Matcher, hints storage.SelectHints) promscanners.SeriesSelector

NewFilteredSelector creates new promscanners.SeriesSelector that applies filtering.

func NewHistogramStatsSelector

func NewHistogramStatsSelector(seriesSelector promscanners.SeriesSelector) promscanners.SeriesSelector

NewHistogramStatsSelector creates new promscanners.SeriesSelector that decodes native histograms.

func NewSelector

func NewSelector(q storage.Querier, matchers []*labels.Matcher, hints storage.SelectHints) promscanners.SeriesSelector

NewSelector creates new promscanners.SeriesSelector.

func SeriesShard

func SeriesShard(series []promscanners.SignedSeries, index, numShards int) []promscanners.SignedSeries

SeriesShard shards series using given index.

Types

type Engine

type Engine interface {
	NewInstantQuery(ctx context.Context, q storage.Queryable, opts promql.QueryOpts, qs string, ts time.Time) (promql.Query, error)
	NewRangeQuery(ctx context.Context, q storage.Queryable, opts promql.QueryOpts, qs string, start, end time.Time, interval time.Duration) (promql.Query, error)
}

Engine is a Prometheus engine interface.

func New

func New(q Querier, opts promql.EngineOpts) (Engine, error)

New creates new Engine.

type EngineOpts

type EngineOpts = promql.EngineOpts

EngineOpts defines PromQL engine options.

type Querier

type Querier interface {
	storage.Queryable
	storage.ExemplarQueryable
	MetricsScanners() (enginestorage.Scanners, error)
}

Querier is Prometheus storage interface.