queryrangebase

package
v2.4.3 Latest Latest
Warning

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

 Go to latest Published: Feb 9, 2022 License: AGPL-3.0 Imports: 51 Imported by: 0

Documentation

Index

Constants

View Source 
const StatusSuccess = "success"

StatusSuccess Prometheus success result.

Variables

View Source 
var (
	ErrInvalidLengthQueryrange = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowQueryrange   = fmt.Errorf("proto: integer overflow")
)
View Source 
var (
	// PassthroughMiddleware is a noop middleware
	PassthroughMiddleware = MiddlewareFunc(func(next Handler) Handler {
		return next
	})
)
View Source 
var (

	// ResultsCacheGenNumberHeaderName holds name of the header we want to set in http response
	ResultsCacheGenNumberHeaderName = "Results-Cache-Gen-Number"
)
View Source 
var StepAlignMiddleware = MiddlewareFunc(func(next Handler) Handler {
	return stepAlign{
		next: next,
	}
})

StepAlignMiddleware aligns the start and end of request to the step to improved the cacheability of the query results.

Functions

func NewRoundTripper 

func NewRoundTripper(next http.RoundTripper, codec Codec, headers []string, middlewares ...Middleware) http.RoundTripper

NewRoundTripper merges a set of middlewares into an handler, then inject it into the `next` roundtripper using the codec to translate requests and responses.

func NewSeriesSet 

func NewSeriesSet(results []SampleStream) storage.SeriesSet

NewSeriesSet returns an in memory storage.SeriesSet from a []SampleStream As NewSeriesSet uses NewConcreteSeriesSet to implement SeriesSet, result will be sorted by label names.

Types

type Buffer 

type Buffer interface {
	Bytes() []byte
}

Buffer can be used to read a response body. This allows to avoid reading the body multiple times from the `http.Response.Body`.

type CacheGenNumberLoader 

type CacheGenNumberLoader interface {
	GetResultsCacheGenNumber(tenantIDs []string) string
}

type CacheSplitter 

type CacheSplitter interface {
	GenerateCacheKey(userID string, r Request) string
}

CacheSplitter generates cache keys. This is a useful interface for downstream consumers who wish to implement their own strategies.

type CachedResponse 

type CachedResponse struct {
	Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key"`
	// List of cached responses; non-overlapping and in order.
	Extents []Extent `protobuf:"bytes,2,rep,name=extents,proto3" json:"extents"`
}

func (*CachedResponse) Descriptor 

func (*CachedResponse) Descriptor() ([]byte, []int)

func (*CachedResponse) Equal 

func (this *CachedResponse) Equal(that interface{}) bool

func (*CachedResponse) GetExtents 

func (m *CachedResponse) GetExtents() []Extent

func (*CachedResponse) GetKey 

func (m *CachedResponse) GetKey() string

func (*CachedResponse) GoString 

func (this *CachedResponse) GoString() string

func (*CachedResponse) Marshal 

func (m *CachedResponse) Marshal() (dAtA []byte, err error)

func (*CachedResponse) MarshalTo 

func (m *CachedResponse) MarshalTo(dAtA []byte) (int, error)

func (*CachedResponse) MarshalToSizedBuffer 

func (m *CachedResponse) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*CachedResponse) ProtoMessage 

func (*CachedResponse) ProtoMessage()

func (*CachedResponse) Reset 

func (m *CachedResponse) Reset()

func (*CachedResponse) Size 

func (m *CachedResponse) Size() (n int)

func (*CachedResponse) String 

func (this *CachedResponse) String() string

func (*CachedResponse) Unmarshal 

func (m *CachedResponse) Unmarshal(dAtA []byte) error

func (*CachedResponse) XXX_DiscardUnknown 

func (m *CachedResponse) XXX_DiscardUnknown()

func (*CachedResponse) XXX_Marshal 

func (m *CachedResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*CachedResponse) XXX_Merge 

func (m *CachedResponse) XXX_Merge(src proto.Message)

func (*CachedResponse) XXX_Size 

func (m *CachedResponse) XXX_Size() int

func (*CachedResponse) XXX_Unmarshal 

func (m *CachedResponse) XXX_Unmarshal(b []byte) error

type CachingOptions 

type CachingOptions struct {
	Disabled bool `protobuf:"varint,1,opt,name=disabled,proto3" json:"disabled,omitempty"`
}

func (*CachingOptions) Descriptor 

func (*CachingOptions) Descriptor() ([]byte, []int)

func (*CachingOptions) Equal 

func (this *CachingOptions) Equal(that interface{}) bool

func (*CachingOptions) GetDisabled 

func (m *CachingOptions) GetDisabled() bool

func (*CachingOptions) GoString 

func (this *CachingOptions) GoString() string

func (*CachingOptions) Marshal 

func (m *CachingOptions) Marshal() (dAtA []byte, err error)

func (*CachingOptions) MarshalTo 

func (m *CachingOptions) MarshalTo(dAtA []byte) (int, error)

func (*CachingOptions) MarshalToSizedBuffer 

func (m *CachingOptions) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*CachingOptions) ProtoMessage 

func (*CachingOptions) ProtoMessage()

func (*CachingOptions) Reset 

func (m *CachingOptions) Reset()

func (*CachingOptions) Size 

func (m *CachingOptions) Size() (n int)

func (*CachingOptions) String 

func (this *CachingOptions) String() string

func (*CachingOptions) Unmarshal 

func (m *CachingOptions) Unmarshal(dAtA []byte) error

func (*CachingOptions) XXX_DiscardUnknown 

func (m *CachingOptions) XXX_DiscardUnknown()

func (*CachingOptions) XXX_Marshal 

func (m *CachingOptions) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*CachingOptions) XXX_Merge 

func (m *CachingOptions) XXX_Merge(src proto.Message)

func (*CachingOptions) XXX_Size 

func (m *CachingOptions) XXX_Size() int

func (*CachingOptions) XXX_Unmarshal 

func (m *CachingOptions) XXX_Unmarshal(b []byte) error

type Codec 

type Codec interface {
	Merger
	// DecodeRequest decodes a Request from an http request.
	DecodeRequest(_ context.Context, request *http.Request, forwardHeaders []string) (Request, error)
	// DecodeResponse decodes a Response from an http response.
	// The original request is also passed as a parameter this is useful for implementation that needs the request
	// to merge result or build the result correctly.
	DecodeResponse(context.Context, *http.Response, Request) (Response, error)
	// EncodeRequest encodes a Request into an http request.
	EncodeRequest(context.Context, Request) (*http.Request, error)
	// EncodeResponse encodes a Response into an http response.
	EncodeResponse(context.Context, Response) (*http.Response, error)
}

Codec is used to encode/decode query range requests and responses so they can be passed down to middlewares. 

var (

	// PrometheusCodec is a codec to encode and decode Prometheus query range requests and responses.
	PrometheusCodec Codec = &prometheusCodec{}
)

type Config 

type Config struct {
	// Deprecated: SplitQueriesByInterval will be removed in the next major release
	SplitQueriesByInterval time.Duration `yaml:"split_queries_by_interval"`

	AlignQueriesWithStep bool `yaml:"align_queries_with_step"`
	ResultsCacheConfig   `yaml:"results_cache"`
	CacheResults         bool `yaml:"cache_results"`
	MaxRetries           int  `yaml:"max_retries"`
	ShardedQueries       bool `yaml:"parallelise_shardable_queries"`
	// List of headers which query_range middleware chain would forward to downstream querier.
	ForwardHeaders flagext.StringSlice `yaml:"forward_headers_list"`
}

Config for query_range middleware chain.

func (*Config) RegisterFlags 

func (cfg *Config) RegisterFlags(f *flag.FlagSet)

RegisterFlags adds the flags required to config this to the given FlagSet.

func (*Config) Validate 

func (cfg *Config) Validate() error

Validate validates the config.

type Extent 

type Extent struct {
	Start    int64      `protobuf:"varint,1,opt,name=start,proto3" json:"start"`
	End      int64      `protobuf:"varint,2,opt,name=end,proto3" json:"end"`
	TraceId  string     `protobuf:"bytes,4,opt,name=trace_id,json=traceId,proto3" json:"-"`
	Response *types.Any `protobuf:"bytes,5,opt,name=response,proto3" json:"response"`
}

func (*Extent) Descriptor 

func (*Extent) Descriptor() ([]byte, []int)

func (*Extent) Equal 

func (this *Extent) Equal(that interface{}) bool

func (*Extent) GetEnd 

func (m *Extent) GetEnd() int64

func (*Extent) GetResponse 

func (m *Extent) GetResponse() *types.Any

func (*Extent) GetStart 

func (m *Extent) GetStart() int64

func (*Extent) GetTraceId 

func (m *Extent) GetTraceId() string

func (*Extent) GoString 

func (this *Extent) GoString() string

func (*Extent) Marshal 

func (m *Extent) Marshal() (dAtA []byte, err error)

func (*Extent) MarshalTo 

func (m *Extent) MarshalTo(dAtA []byte) (int, error)

func (*Extent) MarshalToSizedBuffer 

func (m *Extent) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Extent) ProtoMessage 

func (*Extent) ProtoMessage()

func (*Extent) Reset 

func (m *Extent) Reset()

func (*Extent) Size 

func (m *Extent) Size() (n int)

func (*Extent) String 

func (this *Extent) String() string

func (*Extent) Unmarshal 

func (m *Extent) Unmarshal(dAtA []byte) error

func (*Extent) XXX_DiscardUnknown 

func (m *Extent) XXX_DiscardUnknown()

func (*Extent) XXX_Marshal 

func (m *Extent) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Extent) XXX_Merge 

func (m *Extent) XXX_Merge(src proto.Message)

func (*Extent) XXX_Size 

func (m *Extent) XXX_Size() int

func (*Extent) XXX_Unmarshal 

func (m *Extent) XXX_Unmarshal(b []byte) error

type Extractor 

type Extractor interface {
	// Extract extracts a subset of a response from the `start` and `end` timestamps in milliseconds in the `from` response.
	Extract(start, end int64, from Response) Response
	ResponseWithoutHeaders(resp Response) Response
}

Extractor is used by the cache to extract a subset of a response from a cache entry.

type Handler 

type Handler interface {
	Do(context.Context, Request) (Response, error)
}

Handler is like http.Handle, but specifically for Prometheus query_range calls.

type HandlerFunc 

type HandlerFunc func(context.Context, Request) (Response, error)

HandlerFunc is like http.HandlerFunc, but for Handler.

func (HandlerFunc) Do 

func (q HandlerFunc) Do(ctx context.Context, req Request) (Response, error)

Do implements Handler.

type InstrumentMiddlewareMetrics 

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

InstrumentMiddlewareMetrics holds the metrics tracked by InstrumentMiddleware.

func NewInstrumentMiddlewareMetrics 

func NewInstrumentMiddlewareMetrics(registerer prometheus.Registerer) *InstrumentMiddlewareMetrics

NewInstrumentMiddlewareMetrics makes a new InstrumentMiddlewareMetrics.

type IntervalFn 

type IntervalFn func(r Request) time.Duration

type Limits 

type Limits interface {
	// MaxQueryLookback returns the max lookback period of queries.
	MaxQueryLookback(userID string) time.Duration

	// MaxQueryLength returns the limit of the length (in time) of a query.
	MaxQueryLength(string) time.Duration

	// MaxQueryParallelism returns the limit to the number of split queries the
	// frontend will process in parallel.
	MaxQueryParallelism(string) int

	// MaxCacheFreshness returns the period after which results are cacheable,
	// to prevent caching of very recent results.
	MaxCacheFreshness(string) time.Duration
}

Limits allows us to specify per-tenant runtime limits on the behavior of the query handling code.

type Merger 

type Merger interface {
	// MergeResponse merges responses from multiple requests into a single Response
	MergeResponse(...Response) (Response, error)
}

Merger is used by middlewares making multiple requests to merge back all responses into a single one.

type Middleware 

type Middleware interface {
	Wrap(Handler) Handler
}

Middleware is a higher order Handler.

func InstrumentMiddleware 

func InstrumentMiddleware(name string, metrics *InstrumentMiddlewareMetrics) Middleware

InstrumentMiddleware can be inserted into the middleware chain to expose timing information.

func MergeMiddlewares 

func MergeMiddlewares(middleware ...Middleware) Middleware

MergeMiddlewares produces a middleware that applies multiple middleware in turn; ie Merge(f,g,h).Wrap(handler) == f.Wrap(g.Wrap(h.Wrap(handler)))

func NewLimitsMiddleware 

func NewLimitsMiddleware(l Limits) Middleware

NewLimitsMiddleware creates a new Middleware that enforces query limits.

func NewQueryShardMiddleware 

func NewQueryShardMiddleware(
	logger log.Logger,
	engine *promql.Engine,
	confs ShardingConfigs,
	codec Codec,
	minShardingLookback time.Duration,
	metrics *InstrumentMiddlewareMetrics,
	registerer prometheus.Registerer,
) Middleware

NewQueryShardMiddleware creates a middleware which downstreams queries after AST mapping and query encoding.

func NewResultsCacheMiddleware 

func NewResultsCacheMiddleware(
	logger log.Logger,
	cfg ResultsCacheConfig,
	splitter CacheSplitter,
	limits Limits,
	merger Merger,
	extractor Extractor,
	cacheGenNumberLoader CacheGenNumberLoader,
	shouldCache ShouldCacheFn,
	reg prometheus.Registerer,
) (Middleware, cache.Cache, error)

NewResultsCacheMiddleware creates results cache middleware from config. The middleware cache result using a unique cache key for a given request (step,query,user) and interval. The cache assumes that each request length (end-start) is below or equal the interval. Each request starting from within the same interval will hit the same cache entry. If the cache doesn't have the entire duration of the request cached, it will query the uncached parts and append them to the cache entries. see `generateKey`.

func NewRetryMiddleware 

func NewRetryMiddleware(log log.Logger, maxRetries int, metrics *RetryMiddlewareMetrics) Middleware

NewRetryMiddleware returns a middleware that retries requests if they fail with 500 or a non-HTTP error.

func SplitByIntervalMiddleware 

func SplitByIntervalMiddleware(interval IntervalFn, limits Limits, merger Merger, registerer prometheus.Registerer) Middleware

SplitByIntervalMiddleware creates a new Middleware that splits requests by a given interval.

type MiddlewareFunc 

type MiddlewareFunc func(Handler) Handler

MiddlewareFunc is like http.HandlerFunc, but for Middleware.

func (MiddlewareFunc) Wrap 

func (q MiddlewareFunc) Wrap(h Handler) Handler

Wrap implements Middleware.

type MockShardedQueryable 

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

MockShardedQueryable is exported to be reused in the querysharding benchmarking

func NewMockShardedQueryable 

func NewMockShardedQueryable(
	nSamples int,
	labelSet []string,
	labelBuckets int,
	delayPerSeries time.Duration,
) *MockShardedQueryable

NewMockShardedQueryable creates a shard-aware in memory queryable.

func (*MockShardedQueryable) Close 

func (q *MockShardedQueryable) Close() error

Close releases the resources of the Querier.

func (*MockShardedQueryable) LabelNames 

func (q *MockShardedQueryable) LabelNames(matchers ...*labels.Matcher) ([]string, storage.Warnings, error)

LabelNames returns all the unique label names present in the block in sorted order.

func (*MockShardedQueryable) LabelValues 

func (q *MockShardedQueryable) LabelValues(name string, matchers ...*labels.Matcher) ([]string, storage.Warnings, error)

LabelValues impls storage.Querier

func (*MockShardedQueryable) Querier 

func (q *MockShardedQueryable) Querier(ctx context.Context, mint, maxt int64) (storage.Querier, error)

Querier impls storage.Queryable

func (*MockShardedQueryable) Select 

func (q *MockShardedQueryable) Select(_ bool, _ *storage.SelectHints, matchers ...*labels.Matcher) storage.SeriesSet

Select implements storage.Querier interface. The bool passed is ignored because the series is always sorted.

type NoopCollector 

type NoopCollector struct{}

NoopCollector is a noop collector that can be used as placeholder when no metric should tracked by the instrumentation.

func (*NoopCollector) After 

func (c *NoopCollector) After(ctx context.Context, method, statusCode string, start time.Time)

After implements instrument.Collector.

func (*NoopCollector) Before 

func (c *NoopCollector) Before(ctx context.Context, method string, start time.Time)

Before implements instrument.Collector.

func (*NoopCollector) Register 

func (c *NoopCollector) Register()

Register implements instrument.Collector.

type PrometheusData 

type PrometheusData struct {
	ResultType string         `protobuf:"bytes,1,opt,name=ResultType,proto3" json:"resultType"`
	Result     []SampleStream `protobuf:"bytes,2,rep,name=Result,proto3" json:"result"`
}

func (*PrometheusData) Descriptor 

func (*PrometheusData) Descriptor() ([]byte, []int)

func (*PrometheusData) Equal 

func (this *PrometheusData) Equal(that interface{}) bool

func (*PrometheusData) GetResult 

func (m *PrometheusData) GetResult() []SampleStream

func (*PrometheusData) GetResultType 

func (m *PrometheusData) GetResultType() string

func (*PrometheusData) GoString 

func (this *PrometheusData) GoString() string

func (*PrometheusData) Marshal 

func (m *PrometheusData) Marshal() (dAtA []byte, err error)

func (*PrometheusData) MarshalTo 

func (m *PrometheusData) MarshalTo(dAtA []byte) (int, error)

func (*PrometheusData) MarshalToSizedBuffer 

func (m *PrometheusData) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*PrometheusData) ProtoMessage 

func (*PrometheusData) ProtoMessage()

func (*PrometheusData) Reset 

func (m *PrometheusData) Reset()

func (*PrometheusData) Size 

func (m *PrometheusData) Size() (n int)

func (*PrometheusData) String 

func (this *PrometheusData) String() string

func (*PrometheusData) Unmarshal 

func (m *PrometheusData) Unmarshal(dAtA []byte) error

func (*PrometheusData) XXX_DiscardUnknown 

func (m *PrometheusData) XXX_DiscardUnknown()

func (*PrometheusData) XXX_Marshal 

func (m *PrometheusData) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*PrometheusData) XXX_Merge 

func (m *PrometheusData) XXX_Merge(src proto.Message)

func (*PrometheusData) XXX_Size 

func (m *PrometheusData) XXX_Size() int

func (*PrometheusData) XXX_Unmarshal 

func (m *PrometheusData) XXX_Unmarshal(b []byte) error

type PrometheusRequest 

type PrometheusRequest struct {
	Path           string                     `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
	Start          int64                      `protobuf:"varint,2,opt,name=start,proto3" json:"start,omitempty"`
	End            int64                      `protobuf:"varint,3,opt,name=end,proto3" json:"end,omitempty"`
	Step           int64                      `protobuf:"varint,4,opt,name=step,proto3" json:"step,omitempty"`
	Timeout        time.Duration              `protobuf:"bytes,5,opt,name=timeout,proto3,stdduration" json:"timeout"`
	Query          string                     `protobuf:"bytes,6,opt,name=query,proto3" json:"query,omitempty"`
	CachingOptions CachingOptions             `protobuf:"bytes,7,opt,name=cachingOptions,proto3" json:"cachingOptions"`
	Headers        []*PrometheusRequestHeader `protobuf:"bytes,8,rep,name=Headers,proto3" json:"-"`
}

func (*PrometheusRequest) Descriptor 

func (*PrometheusRequest) Descriptor() ([]byte, []int)

func (*PrometheusRequest) Equal 

func (this *PrometheusRequest) Equal(that interface{}) bool

func (*PrometheusRequest) GetCachingOptions 

func (m *PrometheusRequest) GetCachingOptions() CachingOptions

func (*PrometheusRequest) GetEnd 

func (m *PrometheusRequest) GetEnd() int64

func (*PrometheusRequest) GetHeaders 

func (m *PrometheusRequest) GetHeaders() []*PrometheusRequestHeader

func (*PrometheusRequest) GetPath 

func (m *PrometheusRequest) GetPath() string

func (*PrometheusRequest) GetQuery 

func (m *PrometheusRequest) GetQuery() string

func (*PrometheusRequest) GetStart 

func (m *PrometheusRequest) GetStart() int64

func (*PrometheusRequest) GetStep 

func (m *PrometheusRequest) GetStep() int64

func (*PrometheusRequest) GetTimeout 

func (m *PrometheusRequest) GetTimeout() time.Duration

func (*PrometheusRequest) GoString 

func (this *PrometheusRequest) GoString() string

func (*PrometheusRequest) LogToSpan 

func (q *PrometheusRequest) LogToSpan(sp opentracing.Span)

LogToSpan logs the current `PrometheusRequest` parameters to the specified span.

func (*PrometheusRequest) Marshal 

func (m *PrometheusRequest) Marshal() (dAtA []byte, err error)

func (*PrometheusRequest) MarshalTo 

func (m *PrometheusRequest) MarshalTo(dAtA []byte) (int, error)

func (*PrometheusRequest) MarshalToSizedBuffer 

func (m *PrometheusRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*PrometheusRequest) ProtoMessage 

func (*PrometheusRequest) ProtoMessage()

func (*PrometheusRequest) Reset 

func (m *PrometheusRequest) Reset()

func (*PrometheusRequest) Size 

func (m *PrometheusRequest) Size() (n int)

func (*PrometheusRequest) String 

func (this *PrometheusRequest) String() string

func (*PrometheusRequest) Unmarshal 

func (m *PrometheusRequest) Unmarshal(dAtA []byte) error

func (*PrometheusRequest) WithQuery 

func (q *PrometheusRequest) WithQuery(query string) Request

WithQuery clones the current `PrometheusRequest` with a new query.

func (*PrometheusRequest) WithStartEnd 

func (q *PrometheusRequest) WithStartEnd(start, end int64) Request

WithStartEnd clones the current `PrometheusRequest` with a new `start` and `end` timestamp.

func (*PrometheusRequest) XXX_DiscardUnknown 

func (m *PrometheusRequest) XXX_DiscardUnknown()

func (*PrometheusRequest) XXX_Marshal 

func (m *PrometheusRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*PrometheusRequest) XXX_Merge 

func (m *PrometheusRequest) XXX_Merge(src proto.Message)

func (*PrometheusRequest) XXX_Size 

func (m *PrometheusRequest) XXX_Size() int

func (*PrometheusRequest) XXX_Unmarshal 

func (m *PrometheusRequest) XXX_Unmarshal(b []byte) error

type PrometheusRequestHeader 

type PrometheusRequestHeader struct {
	Name   string   `protobuf:"bytes,1,opt,name=Name,proto3" json:"-"`
	Values []string `protobuf:"bytes,2,rep,name=Values,proto3" json:"-"`
}

func (*PrometheusRequestHeader) Descriptor 

func (*PrometheusRequestHeader) Descriptor() ([]byte, []int)

func (*PrometheusRequestHeader) Equal 

func (this *PrometheusRequestHeader) Equal(that interface{}) bool

func (*PrometheusRequestHeader) GetName 

func (m *PrometheusRequestHeader) GetName() string

func (*PrometheusRequestHeader) GetValues 

func (m *PrometheusRequestHeader) GetValues() []string

func (*PrometheusRequestHeader) GoString 

func (this *PrometheusRequestHeader) GoString() string

func (*PrometheusRequestHeader) Marshal 

func (m *PrometheusRequestHeader) Marshal() (dAtA []byte, err error)

func (*PrometheusRequestHeader) MarshalTo 

func (m *PrometheusRequestHeader) MarshalTo(dAtA []byte) (int, error)

func (*PrometheusRequestHeader) MarshalToSizedBuffer 

func (m *PrometheusRequestHeader) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*PrometheusRequestHeader) ProtoMessage 

func (*PrometheusRequestHeader) ProtoMessage()

func (*PrometheusRequestHeader) Reset 

func (m *PrometheusRequestHeader) Reset()

func (*PrometheusRequestHeader) Size 

func (m *PrometheusRequestHeader) Size() (n int)

func (*PrometheusRequestHeader) String 

func (this *PrometheusRequestHeader) String() string

func (*PrometheusRequestHeader) Unmarshal 

func (m *PrometheusRequestHeader) Unmarshal(dAtA []byte) error

func (*PrometheusRequestHeader) XXX_DiscardUnknown 

func (m *PrometheusRequestHeader) XXX_DiscardUnknown()

func (*PrometheusRequestHeader) XXX_Marshal 

func (m *PrometheusRequestHeader) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*PrometheusRequestHeader) XXX_Merge 

func (m *PrometheusRequestHeader) XXX_Merge(src proto.Message)

func (*PrometheusRequestHeader) XXX_Size 

func (m *PrometheusRequestHeader) XXX_Size() int

func (*PrometheusRequestHeader) XXX_Unmarshal 

func (m *PrometheusRequestHeader) XXX_Unmarshal(b []byte) error

type PrometheusResponse 

type PrometheusResponse struct {
	Status    string                      `protobuf:"bytes,1,opt,name=Status,proto3" json:"status"`
	Data      PrometheusData              `protobuf:"bytes,2,opt,name=Data,proto3" json:"data,omitempty"`
	ErrorType string                      `protobuf:"bytes,3,opt,name=ErrorType,proto3" json:"errorType,omitempty"`
	Error     string                      `protobuf:"bytes,4,opt,name=Error,proto3" json:"error,omitempty"`
	Headers   []*PrometheusResponseHeader `protobuf:"bytes,5,rep,name=Headers,proto3" json:"-"`
}

func NewEmptyPrometheusResponse 

func NewEmptyPrometheusResponse() *PrometheusResponse

NewEmptyPrometheusResponse returns an empty successful Prometheus query range response.

func (*PrometheusResponse) Descriptor 

func (*PrometheusResponse) Descriptor() ([]byte, []int)

func (*PrometheusResponse) Equal 

func (this *PrometheusResponse) Equal(that interface{}) bool

func (*PrometheusResponse) GetData 

func (m *PrometheusResponse) GetData() PrometheusData

func (*PrometheusResponse) GetError 

func (m *PrometheusResponse) GetError() string

func (*PrometheusResponse) GetErrorType 

func (m *PrometheusResponse) GetErrorType() string

func (*PrometheusResponse) GetHeaders 

func (m *PrometheusResponse) GetHeaders() []*PrometheusResponseHeader

func (*PrometheusResponse) GetStatus 

func (m *PrometheusResponse) GetStatus() string

func (*PrometheusResponse) GoString 

func (this *PrometheusResponse) GoString() string

func (*PrometheusResponse) Marshal 

func (m *PrometheusResponse) Marshal() (dAtA []byte, err error)

func (*PrometheusResponse) MarshalTo 

func (m *PrometheusResponse) MarshalTo(dAtA []byte) (int, error)

func (*PrometheusResponse) MarshalToSizedBuffer 

func (m *PrometheusResponse) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*PrometheusResponse) ProtoMessage 

func (*PrometheusResponse) ProtoMessage()

func (*PrometheusResponse) Reset 

func (m *PrometheusResponse) Reset()

func (*PrometheusResponse) Size 

func (m *PrometheusResponse) Size() (n int)

func (*PrometheusResponse) String 

func (this *PrometheusResponse) String() string

func (*PrometheusResponse) Unmarshal 

func (m *PrometheusResponse) Unmarshal(dAtA []byte) error

func (*PrometheusResponse) XXX_DiscardUnknown 

func (m *PrometheusResponse) XXX_DiscardUnknown()

func (*PrometheusResponse) XXX_Marshal 

func (m *PrometheusResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*PrometheusResponse) XXX_Merge 

func (m *PrometheusResponse) XXX_Merge(src proto.Message)

func (*PrometheusResponse) XXX_Size 

func (m *PrometheusResponse) XXX_Size() int

func (*PrometheusResponse) XXX_Unmarshal 

func (m *PrometheusResponse) XXX_Unmarshal(b []byte) error

type PrometheusResponseExtractor 

type PrometheusResponseExtractor struct{}

PrometheusResponseExtractor helps extracting specific info from Query Response.

func (PrometheusResponseExtractor) Extract 

func (PrometheusResponseExtractor) Extract(start, end int64, from Response) Response

Extract extracts response for specific a range from a response.

func (PrometheusResponseExtractor) ResponseWithoutHeaders 

func (PrometheusResponseExtractor) ResponseWithoutHeaders(resp Response) Response

ResponseWithoutHeaders is useful in caching data without headers since we anyways do not need headers for sending back the response so this saves some space by reducing size of the objects.

type PrometheusResponseHeader 

type PrometheusResponseHeader struct {
	Name   string   `protobuf:"bytes,1,opt,name=Name,proto3" json:"-"`
	Values []string `protobuf:"bytes,2,rep,name=Values,proto3" json:"-"`
}

func (*PrometheusResponseHeader) Descriptor 

func (*PrometheusResponseHeader) Descriptor() ([]byte, []int)

func (*PrometheusResponseHeader) Equal 

func (this *PrometheusResponseHeader) Equal(that interface{}) bool

func (*PrometheusResponseHeader) GetName 

func (m *PrometheusResponseHeader) GetName() string

func (*PrometheusResponseHeader) GetValues 

func (m *PrometheusResponseHeader) GetValues() []string

func (*PrometheusResponseHeader) GoString 

func (this *PrometheusResponseHeader) GoString() string

func (*PrometheusResponseHeader) Marshal 

func (m *PrometheusResponseHeader) Marshal() (dAtA []byte, err error)

func (*PrometheusResponseHeader) MarshalTo 

func (m *PrometheusResponseHeader) MarshalTo(dAtA []byte) (int, error)

func (*PrometheusResponseHeader) MarshalToSizedBuffer 

func (m *PrometheusResponseHeader) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*PrometheusResponseHeader) ProtoMessage 

func (*PrometheusResponseHeader) ProtoMessage()

func (*PrometheusResponseHeader) Reset 

func (m *PrometheusResponseHeader) Reset()

func (*PrometheusResponseHeader) Size 

func (m *PrometheusResponseHeader) Size() (n int)

func (*PrometheusResponseHeader) String 

func (this *PrometheusResponseHeader) String() string

func (*PrometheusResponseHeader) Unmarshal 

func (m *PrometheusResponseHeader) Unmarshal(dAtA []byte) error

func (*PrometheusResponseHeader) XXX_DiscardUnknown 

func (m *PrometheusResponseHeader) XXX_DiscardUnknown()

func (*PrometheusResponseHeader) XXX_Marshal 

func (m *PrometheusResponseHeader) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*PrometheusResponseHeader) XXX_Merge 

func (m *PrometheusResponseHeader) XXX_Merge(src proto.Message)

func (*PrometheusResponseHeader) XXX_Size 

func (m *PrometheusResponseHeader) XXX_Size() int

func (*PrometheusResponseHeader) XXX_Unmarshal 

func (m *PrometheusResponseHeader) XXX_Unmarshal(b []byte) error

type Request 

type Request interface {
	// GetStart returns the start timestamp of the request in milliseconds.
	GetStart() int64
	// GetEnd returns the end timestamp of the request in milliseconds.
	GetEnd() int64
	// GetStep returns the step of the request in milliseconds.
	GetStep() int64
	// GetQuery returns the query of the request.
	GetQuery() string
	// GetCachingOptions returns the caching options.
	GetCachingOptions() CachingOptions
	// WithStartEnd clone the current request with different start and end timestamp.
	WithStartEnd(startTime, endTime int64) Request
	// WithQuery clone the current request with a different query.
	WithQuery(string) Request
	proto.Message
	// LogToSpan writes information about this request to an OpenTracing span
	LogToSpan(opentracing.Span)
}

Request represents a query range request that can be process by middlewares.

type RequestResponse 

type RequestResponse struct {
	Request  Request
	Response Response
}

RequestResponse contains a request response and the respective request that was used.

func DoRequests 

func DoRequests(ctx context.Context, downstream Handler, reqs []Request, limits Limits) ([]RequestResponse, error)

DoRequests executes a list of requests in parallel. The limits parameters is used to limit parallelism per single request.

type Response 

type Response interface {
	proto.Message
	// GetHeaders returns the HTTP headers in the response.
	GetHeaders() []*PrometheusResponseHeader
}

Response represents a query range response.

type ResultsCacheConfig 

type ResultsCacheConfig struct {
	CacheConfig cache.Config `yaml:"cache"`
	Compression string       `yaml:"compression"`
}

ResultsCacheConfig is the config for the results cache.

func (*ResultsCacheConfig) RegisterFlags 

func (cfg *ResultsCacheConfig) RegisterFlags(f *flag.FlagSet)

RegisterFlags registers flags.

func (*ResultsCacheConfig) Validate 

func (cfg *ResultsCacheConfig) Validate() error

type RetryMiddlewareMetrics 

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

func NewRetryMiddlewareMetrics 

func NewRetryMiddlewareMetrics(registerer prometheus.Registerer) *RetryMiddlewareMetrics

type RoundTripFunc 

type RoundTripFunc func(*http.Request) (*http.Response, error)

RoundTripFunc is to http.RoundTripper what http.HandlerFunc is to http.Handler.

func (RoundTripFunc) RoundTrip 

func (f RoundTripFunc) RoundTrip(r *http.Request) (*http.Response, error)

RoundTrip implements http.RoundTripper.

type SampleStream 

type SampleStream struct {
	Labels  []github_com_frelon_loki_pkg_logproto.LabelAdapter `protobuf:"bytes,1,rep,name=labels,proto3,customtype=github.com/frelon/loki/v2/pkg/logproto.LabelAdapter" json:"metric"`
	Samples []logproto.LegacySample                            `protobuf:"bytes,2,rep,name=samples,proto3" json:"values"`
}

func FromResult 

func FromResult(res *promql.Result) ([]SampleStream, error)

FromResult transforms a promql query result into a samplestream

func ResponseToSamples 

func ResponseToSamples(resp Response) ([]SampleStream, error)

ResponseToSamples is needed to map back from api response to the underlying series data

func (*SampleStream) Descriptor 

func (*SampleStream) Descriptor() ([]byte, []int)

func (*SampleStream) Equal 

func (this *SampleStream) Equal(that interface{}) bool

func (*SampleStream) GetSamples 

func (m *SampleStream) GetSamples() []logproto.LegacySample

func (*SampleStream) GoString 

func (this *SampleStream) GoString() string

func (*SampleStream) Marshal 

func (m *SampleStream) Marshal() (dAtA []byte, err error)

func (*SampleStream) MarshalJSON 

func (s *SampleStream) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler.

func (*SampleStream) MarshalTo 

func (m *SampleStream) MarshalTo(dAtA []byte) (int, error)

func (*SampleStream) MarshalToSizedBuffer 

func (m *SampleStream) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*SampleStream) ProtoMessage 

func (*SampleStream) ProtoMessage()

func (*SampleStream) Reset 

func (m *SampleStream) Reset()

func (*SampleStream) Size 

func (m *SampleStream) Size() (n int)

func (*SampleStream) String 

func (this *SampleStream) String() string

func (*SampleStream) Unmarshal 

func (m *SampleStream) Unmarshal(dAtA []byte) error

func (*SampleStream) UnmarshalJSON 

func (s *SampleStream) UnmarshalJSON(data []byte) error

UnmarshalJSON implements json.Unmarshaler.

func (*SampleStream) XXX_DiscardUnknown 

func (m *SampleStream) XXX_DiscardUnknown()

func (*SampleStream) XXX_Marshal 

func (m *SampleStream) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*SampleStream) XXX_Merge 

func (m *SampleStream) XXX_Merge(src proto.Message)

func (*SampleStream) XXX_Size 

func (m *SampleStream) XXX_Size() int

func (*SampleStream) XXX_Unmarshal 

func (m *SampleStream) XXX_Unmarshal(b []byte) error

type ShardLabelSeries 

type ShardLabelSeries struct {
	storage.Series
	// contains filtered or unexported fields
}

ShardLabelSeries allows extending a Series with new labels. This is helpful for adding cortex shard labels

func (*ShardLabelSeries) Labels 

func (s *ShardLabelSeries) Labels() labels.Labels

Labels impls storage.Series

type ShardedQuerier 

type ShardedQuerier struct {
	Ctx                context.Context
	Req                Request
	Handler            Handler
	ResponseHeaders    map[string][]string
	ResponseHeadersMtx sync.Mutex
}

ShardedQuerier is a an implementor of the Querier interface.

func (*ShardedQuerier) Close 

func (q *ShardedQuerier) Close() error

Close releases the resources of the Querier.

func (*ShardedQuerier) LabelNames 

func (q *ShardedQuerier) LabelNames(matchers ...*labels.Matcher) ([]string, storage.Warnings, error)

LabelNames returns all the unique label names present in the block in sorted order.

func (*ShardedQuerier) LabelValues 

func (q *ShardedQuerier) LabelValues(name string, matchers ...*labels.Matcher) ([]string, storage.Warnings, error)

LabelValues returns all potential values for a label name.

func (*ShardedQuerier) Select 

func (q *ShardedQuerier) Select(_ bool, _ *storage.SelectHints, matchers ...*labels.Matcher) storage.SeriesSet

Select returns a set of series that matches the given label matchers. The bool passed is ignored because the series is always sorted.

type ShardedQueryable 

type ShardedQueryable struct {
	Req     Request
	Handler Handler
	// contains filtered or unexported fields
}

ShardedQueryable is an implementor of the Queryable interface.

func (*ShardedQueryable) Querier 

func (q *ShardedQueryable) Querier(ctx context.Context, mint, maxt int64) (storage.Querier, error)

Querier implements Queryable

type ShardingConfigs 

type ShardingConfigs []chunk.PeriodConfig

ShardingConfigs is a slice of chunk shard configs

func (ShardingConfigs) GetConf 

func (confs ShardingConfigs) GetConf(r Request) (chunk.PeriodConfig, error)

GetConf will extract a shardable config corresponding to a request and the shardingconfigs

func (ShardingConfigs) ValidRange 

func (confs ShardingConfigs) ValidRange(start, end int64) (chunk.PeriodConfig, error)

ValidRange extracts a non-overlapping sharding configuration from a list of configs and a time range.

type ShouldCacheFn 

type ShouldCacheFn func(r Request) bool

ShouldCacheFn checks whether the current request should go to cache or not. If not, just send the request to next handler.

type Tripperware 

type Tripperware func(http.RoundTripper) http.RoundTripper

Tripperware is a signature for all http client-side middleware.

func NewTripperware 

func NewTripperware(
	cfg Config,
	log log.Logger,
	limits Limits,
	codec Codec,
	cacheExtractor Extractor,
	schema chunk.SchemaConfig,
	engineOpts promql.EngineOpts,
	minShardingLookback time.Duration,
	registerer prometheus.Registerer,
	cacheGenNumberLoader CacheGenNumberLoader,
) (Tripperware, cache.Cache, error)

NewTripperware returns a Tripperware configured with middlewares to limit, align, split, retry and cache requests.

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.