frontend

Documentation

Index

• Constants
• func InitFrontend(cfg CombinedFrontendConfig, limits v1.Limits, grpcListenPort int, ...) (http.RoundTripper, *v1.Frontend, *v2.Frontend, error)
• func NewDownstreamRoundTripper(downstreamURL string, transport http.RoundTripper) (http.RoundTripper, error)
• func NewRoundTripper(next http.RoundTripper, middlewares ...Middleware) http.RoundTripper
• type CombinedFrontendConfig
  • func (cfg *CombinedFrontendConfig) RegisterFlags(f *flag.FlagSet)
• type Config
  • func (cfg *Config) RegisterFlagsAndApplyDefaults(prefix string, f *flag.FlagSet)
• type CortexNoQuerierLimits
  • func (CortexNoQuerierLimits) MaxQueriersPerUser(user string) int
• type Middleware
  • func MergeMiddlewares(middleware ...Middleware) Middleware
• type MiddlewareFunc
  • func (q MiddlewareFunc) Wrap(h http.RoundTripper) http.RoundTripper
• type QueryFrontend
  • func New(cfg Config, next http.RoundTripper, o *overrides.Overrides, ...) (*QueryFrontend, error)
• type RoundTripperFunc
  • func (fn RoundTripperFunc) RoundTrip(req *http.Request) (*http.Response, error)
• type SearchConfig
• type SearchSharderConfig

Constants

const (
	// StatusClientClosedRequest is the status code for when a client request cancellation of an http request
	StatusClientClosedRequest = 499
	// nil response in ServeHTTP
	NilResponseError = "nil resp in ServeHTTP"
)

Functions

func InitFrontend

func InitFrontend(cfg CombinedFrontendConfig, limits v1.Limits, grpcListenPort int, log log.Logger, reg prometheus.Registerer) (http.RoundTripper, *v1.Frontend, *v2.Frontend, error)

InitFrontend initializes frontend (either V1 -- without scheduler, or V2 -- with scheduler) or no frontend at all if downstream Prometheus URL is used instead.

Returned RoundTripper can be wrapped in more round-tripper middlewares, and then eventually registered into HTTP server using the Handler from this package. Returned RoundTripper is always non-nil (if there are no errors), and it uses the returned frontend (if any).

func NewDownstreamRoundTripper

func NewDownstreamRoundTripper(downstreamURL string, transport http.RoundTripper) (http.RoundTripper, error)

func NewRoundTripper

func NewRoundTripper(next http.RoundTripper, middlewares ...Middleware) http.RoundTripper

NewRoundTripper takes an ordered set of middlewares and builds a http.RoundTripper around them

Types

type CombinedFrontendConfig

type CombinedFrontendConfig struct {
	Handler    transport.HandlerConfig `yaml:",inline"`
	FrontendV1 v1.Config               `yaml:",inline"`
	FrontendV2 v2.Config               `yaml:",inline"`

	DownstreamURL string `yaml:"downstream_url"`
}

This struct combines several configuration options together to preserve backwards compatibility.

func (*CombinedFrontendConfig) RegisterFlags

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

type Config

type Config struct {
	Config               CombinedFrontendConfig `yaml:",inline"`
	MaxRetries           int                    `yaml:"max_retries,omitempty"`
	QueryShards          int                    `yaml:"query_shards,omitempty"`
	TolerateFailedBlocks int                    `yaml:"tolerate_failed_blocks,omitempty"`
	Search               SearchConfig           `yaml:"search"`
}

func (*Config) RegisterFlagsAndApplyDefaults

func (cfg *Config) RegisterFlagsAndApplyDefaults(prefix string, f *flag.FlagSet)

type CortexNoQuerierLimits

type CortexNoQuerierLimits struct{}

func (CortexNoQuerierLimits) MaxQueriersPerUser

func (CortexNoQuerierLimits) MaxQueriersPerUser(user string) int

type Middleware

type Middleware interface {
	Wrap(http.RoundTripper) http.RoundTripper
}

Middleware is used to build pipelines of http.Roundtrippers

func MergeMiddlewares

func MergeMiddlewares(middleware ...Middleware) Middleware

MergeMiddlewares takes a set of ordered middlewares and merges them into a pipeline

type MiddlewareFunc

type MiddlewareFunc func(http.RoundTripper) http.RoundTripper

MiddlewareFunc is like http.HandlerFunc, but for Middleware.

func (MiddlewareFunc) Wrap

func (q MiddlewareFunc) Wrap(h http.RoundTripper) http.RoundTripper

Wrap implements Middleware.

type QueryFrontend

type QueryFrontend struct {
	TraceByID, Search http.Handler
	// contains filtered or unexported fields
}

func New

func New(cfg Config, next http.RoundTripper, o *overrides.Overrides, store storage.Store, logger log.Logger, registerer prometheus.Registerer) (*QueryFrontend, error)

New returns a new QueryFrontend

type RoundTripperFunc

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

RoundTripperFunc is like http.HandlerFunc, but for RoundTripper

chosen for pipeline building over queryrange.Handler b/c of how similar queryrange.Handler is to this existing interface.

func (RoundTripperFunc) RoundTrip

func (fn RoundTripperFunc) RoundTrip(req *http.Request) (*http.Response, error)

RoundTrip implememnts http.RoundTripper

type SearchConfig

type SearchConfig struct {
	Sharder SearchSharderConfig `yaml:",inline"`
}

type SearchSharderConfig

type SearchSharderConfig struct {
	ConcurrentRequests    int           `yaml:"concurrent_jobs,omitempty"`
	TargetBytesPerRequest int           `yaml:"target_bytes_per_job,omitempty"`
	DefaultLimit          uint32        `yaml:"default_result_limit"`
	MaxLimit              uint32        `yaml:"max_result_limit"`
	MaxDuration           time.Duration `yaml:"max_duration"`
	QueryBackendAfter     time.Duration `yaml:"query_backend_after,omitempty"`
	QueryIngestersUntil   time.Duration `yaml:"query_ingesters_until,omitempty"`
}