query

Documentation

Index

• type Config
  • func BuildQueryConfig(queryAddrs []string) ([]Config, error)
  • func DefaultConfig() Config
  • func LoadConfigs(confYAML []byte) ([]Config, error)
  • func (c *Config) UnmarshalYAML(unmarshal func(interface{}) error) error
• type QueryableCreator
  • func NewQueryableCreator(logger log.Logger, reg prometheus.Registerer, proxy storepb.StoreServer, ...) QueryableCreator
• type RuleSpec
• type StoreSet
  • func NewStoreSet(logger log.Logger, reg *prometheus.Registry, storeSpecs func() []StoreSpec, ...) *StoreSet
  • func (s *StoreSet) Close()
  • func (s *StoreSet) Get() []store.Client
  • func (s *StoreSet) GetRulesClients() []rulespb.RulesClient
  • func (s *StoreSet) GetStoreStatus() []StoreStatus
  • func (s *StoreSet) Update(ctx context.Context)
• type StoreSpec
  • func NewGRPCStoreSpec(addr string, strictstatic bool) StoreSpec
• type StoreStatus

Types

type Config

type Config struct {
	HTTPClientConfig http_util.ClientConfig    `yaml:"http_config"`
	EndpointsConfig  http_util.EndpointsConfig `yaml:",inline"`
}

func BuildQueryConfig

func BuildQueryConfig(queryAddrs []string) ([]Config, error)

BuildQueryConfig returns a query client configuration from a static address.

func DefaultConfig

func DefaultConfig() Config

func LoadConfigs

func LoadConfigs(confYAML []byte) ([]Config, error)

LoadConfigs loads a list of Config from YAML data.

func (*Config) UnmarshalYAML

func (c *Config) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements the yaml.Unmarshaler interface.

type QueryableCreator

type QueryableCreator func(deduplicate bool, replicaLabels []string, maxResolutionMillis int64, partialResponse, skipChunks bool) storage.Queryable

QueryableCreator returns implementation of promql.Queryable that fetches data from the proxy store API endpoints. If deduplication is enabled, all data retrieved from it will be deduplicated along all replicaLabels by default. When the replicaLabels argument is not empty it overwrites the global replicaLabels flag. This allows specifying replicaLabels at query time. maxResolutionMillis controls downsampling resolution that is allowed (specified in milliseconds). partialResponse controls `partialResponseDisabled` option of StoreAPI and partial response behaviour of proxy.

func NewQueryableCreator

func NewQueryableCreator(logger log.Logger, reg prometheus.Registerer, proxy storepb.StoreServer, maxConcurrentSelects int, selectTimeout time.Duration) QueryableCreator

NewQueryableCreator creates QueryableCreator.

type RuleSpec

type RuleSpec interface {
	// Addr returns RulesAPI Address for the rules spec. It is used as its ID.
	Addr() string
}

type StoreSet

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

StoreSet maintains a set of active stores. It is backed up by Store Specifications that are dynamically fetched on every Update() call.

func NewStoreSet

func NewStoreSet(
	logger log.Logger,
	reg *prometheus.Registry,
	storeSpecs func() []StoreSpec,
	ruleSpecs func() []RuleSpec,
	dialOpts []grpc.DialOption,
	unhealthyStoreTimeout time.Duration,
) *StoreSet

NewStoreSet returns a new set of store APIs and potentially Rules APIs from given specs.

func (*StoreSet) Close

func (s *StoreSet) Close()

func (*StoreSet) Get

func (s *StoreSet) Get() []store.Client

Get returns a list of all active stores.

func (*StoreSet) GetRulesClients

func (s *StoreSet) GetRulesClients() []rulespb.RulesClient

GetRulesClients returns a list of all active rules clients.

func (*StoreSet) GetStoreStatus

func (s *StoreSet) GetStoreStatus() []StoreStatus

func (*StoreSet) Update

func (s *StoreSet) Update(ctx context.Context)

Update updates the store set. It fetches current list of store specs from function and updates the fresh metadata from all stores. Keeps around statically defined nodes that were defined with the strict mode.

type StoreSpec

type StoreSpec interface {
	// Addr returns StoreAPI Address for the store spec. It is used as ID for store.
	Addr() string
	// Metadata returns current labels, store type and min, max ranges for store.
	// It can change for every call for this method.
	// If metadata call fails we assume that store is no longer accessible and we should not use it.
	// NOTE: It is implementation responsibility to retry until context timeout, but a caller responsibility to manage
	// given store connection.
	Metadata(ctx context.Context, client storepb.StoreClient) (labelSets []storepb.LabelSet, mint int64, maxt int64, storeType component.StoreAPI, err error)

	// StrictStatic returns true if the StoreAPI has been statically defined and it is under a strict mode.
	StrictStatic() bool
}

func NewGRPCStoreSpec

func NewGRPCStoreSpec(addr string, strictstatic bool) StoreSpec

NewGRPCStoreSpec creates store pure gRPC spec. It uses Info gRPC call to get Metadata.

type StoreStatus

type StoreStatus struct {
	Name      string             `json:"name"`
	LastCheck time.Time          `json:"lastCheck"`
	LastError *stringError       `json:"lastError"`
	LabelSets []storepb.LabelSet `json:"labelSets"`
	StoreType component.StoreAPI `json:"-"`
	MinTime   int64              `json:"minTime"`
	MaxTime   int64              `json:"maxTime"`
}