package querier import ( "context" "flag" "fmt" "net/http" "regexp" "sort" "strconv" "time" "github.com/axiomhq/hyperloglog" "github.com/dustin/go-humanize" "github.com/go-kit/log" "github.com/opentracing/opentracing-go" "golang.org/x/exp/slices" logql_log "github.com/grafana/loki/v3/pkg/logql/log" "github.com/grafana/loki/v3/pkg/logqlmodel" "github.com/grafana/loki/v3/pkg/storage/stores/index" "github.com/grafana/loki/v3/pkg/storage/stores/index/seriesvolume" "github.com/grafana/loki/v3/pkg/storage/stores/shipper/indexshipper/indexgateway" "github.com/go-kit/log/level" "github.com/grafana/dskit/httpgrpc" "github.com/grafana/dskit/tenant" "github.com/pkg/errors" "github.com/prometheus/client_golang/prometheus" "github.com/prometheus/common/model" "github.com/prometheus/prometheus/model/labels" "golang.org/x/sync/errgroup" "google.golang.org/grpc/health/grpc_health_v1" "github.com/grafana/loki/v3/pkg/compactor/deletion" "github.com/grafana/loki/v3/pkg/iter" "github.com/grafana/loki/v3/pkg/loghttp" "github.com/grafana/loki/v3/pkg/logproto" "github.com/grafana/loki/v3/pkg/logql" "github.com/grafana/loki/v3/pkg/logql/syntax" querier_limits "github.com/grafana/loki/v3/pkg/querier/limits" "github.com/grafana/loki/v3/pkg/querier/plan" "github.com/grafana/loki/v3/pkg/storage" "github.com/grafana/loki/v3/pkg/storage/stores/index/stats" listutil "github.com/grafana/loki/v3/pkg/util" "github.com/grafana/loki/v3/pkg/util/spanlogger" util_validation "github.com/grafana/loki/v3/pkg/util/validation" ) const ( // How long the Tailer should wait - once there are no entries to read from ingesters - // before checking if a new entry is available (to avoid spinning the CPU in a continuous // check loop) tailerWaitEntryThrottle = time.Second / 2 ) var nowFunc = func() time.Time { return time.Now() } type interval struct { start, end time.Time } // Config for a querier. type Config struct { TailMaxDuration time.Duration `yaml:"tail_max_duration"` ExtraQueryDelay time.Duration `yaml:"extra_query_delay,omitempty"` QueryIngestersWithin time.Duration `yaml:"query_ingesters_within,omitempty"` IngesterQueryStoreMaxLookback time.Duration `yaml:"-"` Engine logql.EngineOpts `yaml:"engine,omitempty"` MaxConcurrent int `yaml:"max_concurrent"` QueryStoreOnly bool `yaml:"query_store_only"` QueryIngesterOnly bool `yaml:"query_ingester_only"` MultiTenantQueriesEnabled bool `yaml:"multi_tenant_queries_enabled"` PerRequestLimitsEnabled bool `yaml:"per_request_limits_enabled"` } // RegisterFlags register flags. func (cfg *Config) RegisterFlags(f *flag.FlagSet) { cfg.Engine.RegisterFlagsWithPrefix("querier", f) f.DurationVar(&cfg.TailMaxDuration, "querier.tail-max-duration", 1*time.Hour, "Maximum duration for which the live tailing requests are served.") f.DurationVar(&cfg.ExtraQueryDelay, "querier.extra-query-delay", 0, "Time to wait before sending more than the minimum successful query requests.") f.DurationVar(&cfg.QueryIngestersWithin, "querier.query-ingesters-within", 3*time.Hour, "Maximum lookback beyond which queries are not sent to ingester. 0 means all queries are sent to ingester.") f.IntVar(&cfg.MaxConcurrent, "querier.max-concurrent", 4, "The maximum number of queries that can be simultaneously processed by the querier.") f.BoolVar(&cfg.QueryStoreOnly, "querier.query-store-only", false, "Only query the store, and not attempt any ingesters. This is useful for running a standalone querier pool operating only against stored data.") f.BoolVar(&cfg.QueryIngesterOnly, "querier.query-ingester-only", false, "When true, queriers only query the ingesters, and not stored data. This is useful when the object store is unavailable.") f.BoolVar(&cfg.MultiTenantQueriesEnabled, "querier.multi-tenant-queries-enabled", false, "When true, allow queries to span multiple tenants.") f.BoolVar(&cfg.PerRequestLimitsEnabled, "querier.per-request-limits-enabled", false, "When true, querier limits sent via a header are enforced.") } // Validate validates the config. func (cfg *Config) Validate() error { if cfg.QueryStoreOnly && cfg.QueryIngesterOnly { return errors.New("querier.query_store_only and querier.query_ingester_only cannot both be true") } return nil } // Querier can select logs and samples and handle query requests. type Querier interface { logql.Querier Label(ctx context.Context, req *logproto.LabelRequest) (*logproto.LabelResponse, error) Series(ctx context.Context, req *logproto.SeriesRequest) (*logproto.SeriesResponse, error) Tail(ctx context.Context, req *logproto.TailRequest, categorizedLabels bool) (*Tailer, error) IndexStats(ctx context.Context, req *loghttp.RangeQuery) (*stats.Stats, error) IndexShards(ctx context.Context, req *loghttp.RangeQuery, targetBytesPerShard uint64) (*logproto.ShardsResponse, error) Volume(ctx context.Context, req *logproto.VolumeRequest) (*logproto.VolumeResponse, error) DetectedFields(ctx context.Context, req *logproto.DetectedFieldsRequest) (*logproto.DetectedFieldsResponse, error) DetectedLabels(ctx context.Context, req *logproto.DetectedLabelsRequest) (*logproto.DetectedLabelsResponse, error) } type Limits querier_limits.Limits // Store is the store interface we need on the querier. type Store interface { storage.SelectStore index.BaseReader index.StatsReader } // SingleTenantQuerier handles single tenant queries. type SingleTenantQuerier struct { cfg Config store Store limits Limits ingesterQuerier *IngesterQuerier deleteGetter deleteGetter metrics *Metrics logger log.Logger } type deleteGetter interface { GetAllDeleteRequestsForUser(ctx context.Context, userID string) ([]deletion.DeleteRequest, error) } // New makes a new Querier. func New(cfg Config, store Store, ingesterQuerier *IngesterQuerier, limits Limits, d deleteGetter, r prometheus.Registerer, logger log.Logger) (*SingleTenantQuerier, error) { return &SingleTenantQuerier{ cfg: cfg, store: store, ingesterQuerier: ingesterQuerier, limits: limits, deleteGetter: d, metrics: NewMetrics(r), logger: logger, }, nil } // Select Implements logql.Querier which select logs via matchers and regex filters. func (q *SingleTenantQuerier) SelectLogs(ctx context.Context, params logql.SelectLogParams) (iter.EntryIterator, error) { var err error params.Start, params.End, err = q.validateQueryRequest(ctx, params) if err != nil { return nil, err } params.QueryRequest.Deletes, err = q.deletesForUser(ctx, params.Start, params.End) if err != nil { level.Error(spanlogger.FromContext(ctx)).Log("msg", "failed loading deletes for user", "err", err) } ingesterQueryInterval, storeQueryInterval := q.buildQueryIntervals(params.Start, params.End) iters := []iter.EntryIterator{} if !q.cfg.QueryStoreOnly && ingesterQueryInterval != nil { // Make a copy of the request before modifying // because the initial request is used below to query stores queryRequestCopy := *params.QueryRequest newParams := logql.SelectLogParams{ QueryRequest: &queryRequestCopy, } newParams.Start = ingesterQueryInterval.start newParams.End = ingesterQueryInterval.end level.Debug(spanlogger.FromContext(ctx)).Log( "msg", "querying ingester", "params", newParams) ingesterIters, err := q.ingesterQuerier.SelectLogs(ctx, newParams) if err != nil { return nil, err } iters = append(iters, ingesterIters...) } if !q.cfg.QueryIngesterOnly && storeQueryInterval != nil { params.Start = storeQueryInterval.start params.End = storeQueryInterval.end level.Debug(spanlogger.FromContext(ctx)).Log( "msg", "querying store", "params", params) storeIter, err := q.store.SelectLogs(ctx, params) if err != nil { return nil, err } iters = append(iters, storeIter) } if len(iters) == 1 { return iters[0], nil } return iter.NewMergeEntryIterator(ctx, iters, params.Direction), nil } func (q *SingleTenantQuerier) SelectSamples(ctx context.Context, params logql.SelectSampleParams) (iter.SampleIterator, error) { var err error params.Start, params.End, err = q.validateQueryRequest(ctx, params) if err != nil { return nil, err } params.SampleQueryRequest.Deletes, err = q.deletesForUser(ctx, params.Start, params.End) if err != nil { level.Error(spanlogger.FromContext(ctx)).Log("msg", "failed loading deletes for user", "err", err) } ingesterQueryInterval, storeQueryInterval := q.buildQueryIntervals(params.Start, params.End) iters := []iter.SampleIterator{} if !q.cfg.QueryStoreOnly && ingesterQueryInterval != nil { // Make a copy of the request before modifying // because the initial request is used below to query stores queryRequestCopy := *params.SampleQueryRequest newParams := logql.SelectSampleParams{ SampleQueryRequest: &queryRequestCopy, } newParams.Start = ingesterQueryInterval.start newParams.End = ingesterQueryInterval.end ingesterIters, err := q.ingesterQuerier.SelectSample(ctx, newParams) if err != nil { return nil, err } iters = append(iters, ingesterIters...) } if !q.cfg.QueryIngesterOnly && storeQueryInterval != nil { params.Start = storeQueryInterval.start params.End = storeQueryInterval.end storeIter, err := q.store.SelectSamples(ctx, params) if err != nil { return nil, err } iters = append(iters, storeIter) } return iter.NewMergeSampleIterator(ctx, iters), nil } func (q *SingleTenantQuerier) deletesForUser(ctx context.Context, startT, endT time.Time) ([]*logproto.Delete, error) { userID, err := tenant.TenantID(ctx) if err != nil { return nil, err } d, err := q.deleteGetter.GetAllDeleteRequestsForUser(ctx, userID) if err != nil { return nil, err } start := startT.UnixNano() end := endT.UnixNano() var deletes []*logproto.Delete for _, del := range d { if del.StartTime.UnixNano() <= end && del.EndTime.UnixNano() >= start { deletes = append(deletes, &logproto.Delete{ Selector: del.Query, Start: del.StartTime.UnixNano(), End: del.EndTime.UnixNano(), }) } } return deletes, nil } func (q *SingleTenantQuerier) isWithinIngesterMaxLookbackPeriod(maxLookback time.Duration, queryEnd time.Time) bool { // if no lookback limits are configured, always consider this within the range of the lookback period if maxLookback <= 0 { return true } // find the first instance that we would want to query the ingester from... ingesterOldestStartTime := time.Now().Add(-maxLookback) // ...and if the query range ends before that, don't query the ingester return queryEnd.After(ingesterOldestStartTime) } func (q *SingleTenantQuerier) calculateIngesterMaxLookbackPeriod() time.Duration { mlb := time.Duration(-1) if q.cfg.IngesterQueryStoreMaxLookback != 0 { // IngesterQueryStoreMaxLookback takes the precedence over QueryIngestersWithin while also limiting the store query range. mlb = q.cfg.IngesterQueryStoreMaxLookback } else if q.cfg.QueryIngestersWithin != 0 { mlb = q.cfg.QueryIngestersWithin } return mlb } func (q *SingleTenantQuerier) buildQueryIntervals(queryStart, queryEnd time.Time) (*interval, *interval) { // limitQueryInterval is a flag for whether store queries should be limited to start time of ingester queries. limitQueryInterval := false // ingesterMLB having -1 means query ingester for whole duration. if q.cfg.IngesterQueryStoreMaxLookback != 0 { // IngesterQueryStoreMaxLookback takes the precedence over QueryIngestersWithin while also limiting the store query range. limitQueryInterval = true } ingesterMLB := q.calculateIngesterMaxLookbackPeriod() // query ingester for whole duration. if ingesterMLB == -1 { i := &interval{ start: queryStart, end: queryEnd, } if limitQueryInterval { // query only ingesters. return i, nil } // query both stores and ingesters without limiting the query interval. return i, i } ingesterQueryWithinRange := q.isWithinIngesterMaxLookbackPeriod(ingesterMLB, queryEnd) // see if there is an overlap between ingester query interval and actual query interval, if not just do the store query. if !ingesterQueryWithinRange { return nil, &interval{ start: queryStart, end: queryEnd, } } ingesterOldestStartTime := time.Now().Add(-ingesterMLB) // if there is an overlap and we are not limiting the query interval then do both store and ingester query for whole query interval. if !limitQueryInterval { i := &interval{ start: queryStart, end: queryEnd, } return i, i } // since we are limiting the query interval, check if the query touches just the ingesters, if yes then query just the ingesters. if ingesterOldestStartTime.Before(queryStart) { return &interval{ start: queryStart, end: queryEnd, }, nil } // limit the start of ingester query interval to ingesterOldestStartTime. ingesterQueryInterval := &interval{ start: ingesterOldestStartTime, end: queryEnd, } // limit the end of ingester query interval to ingesterOldestStartTime. storeQueryInterval := &interval{ start: queryStart, end: ingesterOldestStartTime, } // query touches only ingester query interval so do not do store query. if storeQueryInterval.start.After(storeQueryInterval.end) { storeQueryInterval = nil } return ingesterQueryInterval, storeQueryInterval } // Label does the heavy lifting for a Label query. func (q *SingleTenantQuerier) Label(ctx context.Context, req *logproto.LabelRequest) (*logproto.LabelResponse, error) { userID, err := tenant.TenantID(ctx) if err != nil { return nil, err } if *req.Start, *req.End, err = validateQueryTimeRangeLimits(ctx, userID, q.limits, *req.Start, *req.End); err != nil { return nil, err } var matchers []*labels.Matcher if req.Query != "" { matchers, err = syntax.ParseMatchers(req.Query, true) if err != nil { return nil, err } } // Enforce the query timeout while querying backends queryTimeout := q.limits.QueryTimeout(ctx, userID) ctx, cancel := context.WithDeadline(ctx, time.Now().Add(queryTimeout)) defer cancel() g, ctx := errgroup.WithContext(ctx) ingesterQueryInterval, storeQueryInterval := q.buildQueryIntervals(*req.Start, *req.End) var ingesterValues [][]string if !q.cfg.QueryStoreOnly && ingesterQueryInterval != nil { g.Go(func() error { var err error timeFramedReq := *req timeFramedReq.Start = &ingesterQueryInterval.start timeFramedReq.End = &ingesterQueryInterval.end ingesterValues, err = q.ingesterQuerier.Label(ctx, &timeFramedReq) return err }) } var storeValues []string if !q.cfg.QueryIngesterOnly && storeQueryInterval != nil { g.Go(func() error { var ( err error from = model.TimeFromUnixNano(storeQueryInterval.start.UnixNano()) through = model.TimeFromUnixNano(storeQueryInterval.end.UnixNano()) ) if req.Values { storeValues, err = q.store.LabelValuesForMetricName(ctx, userID, from, through, "logs", req.Name, matchers...) } else { storeValues, err = q.store.LabelNamesForMetricName(ctx, userID, from, through, "logs") } return err }) } if err := g.Wait(); err != nil { return nil, err } results := append(ingesterValues, storeValues) return &logproto.LabelResponse{ Values: listutil.MergeStringLists(results...), }, nil } // Check implements the grpc healthcheck func (*SingleTenantQuerier) Check(_ context.Context, _ *grpc_health_v1.HealthCheckRequest) (*grpc_health_v1.HealthCheckResponse, error) { return &grpc_health_v1.HealthCheckResponse{Status: grpc_health_v1.HealthCheckResponse_SERVING}, nil } // Tail keeps getting matching logs from all ingesters for given query func (q *SingleTenantQuerier) Tail(ctx context.Context, req *logproto.TailRequest, categorizedLabels bool) (*Tailer, error) { err := q.checkTailRequestLimit(ctx) if err != nil { return nil, err } if req.Plan == nil { parsed, err := syntax.ParseExpr(req.Query) if err != nil { return nil, err } req.Plan = &plan.QueryPlan{ AST: parsed, } } deletes, err := q.deletesForUser(ctx, req.Start, time.Now()) if err != nil { level.Error(spanlogger.FromContext(ctx)).Log("msg", "failed loading deletes for user", "err", err) } histReq := logql.SelectLogParams{ QueryRequest: &logproto.QueryRequest{ Selector: req.Query, Start: req.Start, End: time.Now(), Limit: req.Limit, Direction: logproto.BACKWARD, Deletes: deletes, Plan: req.Plan, }, } histReq.Start, histReq.End, err = q.validateQueryRequest(ctx, histReq) if err != nil { return nil, err } // Enforce the query timeout except when tailing, otherwise the tailing // will be terminated once the query timeout is reached tailCtx := ctx tenantID, err := tenant.TenantID(tailCtx) if err != nil { return nil, errors.Wrap(err, "failed to load tenant") } queryTimeout := q.limits.QueryTimeout(tailCtx, tenantID) queryCtx, cancelQuery := context.WithDeadline(ctx, time.Now().Add(queryTimeout)) defer cancelQuery() tailClients, err := q.ingesterQuerier.Tail(tailCtx, req) if err != nil { return nil, err } histIterators, err := q.SelectLogs(queryCtx, histReq) if err != nil { return nil, err } reversedIterator, err := iter.NewReversedIter(histIterators, req.Limit, true) if err != nil { return nil, err } return newTailer( time.Duration(req.DelayFor)*time.Second, tailClients, reversedIterator, func(connectedIngestersAddr []string) (map[string]logproto.Querier_TailClient, error) { return q.ingesterQuerier.TailDisconnectedIngesters(tailCtx, req, connectedIngestersAddr) }, q.cfg.TailMaxDuration, tailerWaitEntryThrottle, categorizedLabels, q.metrics, q.logger, ), nil } // Series fetches any matching series for a list of matcher sets func (q *SingleTenantQuerier) Series(ctx context.Context, req *logproto.SeriesRequest) (*logproto.SeriesResponse, error) { userID, err := tenant.TenantID(ctx) if err != nil { return nil, err } if req.Start, req.End, err = validateQueryTimeRangeLimits(ctx, userID, q.limits, req.Start, req.End); err != nil { return nil, err } // Enforce the query timeout while querying backends queryTimeout := q.limits.QueryTimeout(ctx, userID) ctx, cancel := context.WithDeadline(ctx, time.Now().Add(queryTimeout)) defer cancel() return q.awaitSeries(ctx, req) } func (q *SingleTenantQuerier) awaitSeries(ctx context.Context, req *logproto.SeriesRequest) (*logproto.SeriesResponse, error) { // buffer the channels to the # of calls they're expecting su series := make(chan [][]logproto.SeriesIdentifier, 2) errs := make(chan error, 2) ingesterQueryInterval, storeQueryInterval := q.buildQueryIntervals(req.Start, req.End) // fetch series from ingesters and store concurrently if !q.cfg.QueryStoreOnly && ingesterQueryInterval != nil { timeFramedReq := *req timeFramedReq.Start = ingesterQueryInterval.start timeFramedReq.End = ingesterQueryInterval.end go func() { // fetch series identifiers from ingesters resps, err := q.ingesterQuerier.Series(ctx, &timeFramedReq) if err != nil { errs <- err return } series <- resps }() } else { // If only queriying the store or the query range does not overlap with the ingester max lookback period (defined by `query_ingesters_within`) // then don't call out to the ingesters, and send an empty result back to the channel series <- [][]logproto.SeriesIdentifier{} } if !q.cfg.QueryIngesterOnly && storeQueryInterval != nil { go func() { storeValues, err := q.seriesForMatchers(ctx, storeQueryInterval.start, storeQueryInterval.end, req.GetGroups(), req.Shards) if err != nil { errs <- err return } series <- [][]logproto.SeriesIdentifier{storeValues} }() } else { // If we are not querying the store, send an empty result back to the channel series <- [][]logproto.SeriesIdentifier{} } var sets [][]logproto.SeriesIdentifier for i := 0; i < 2; i++ { select { case err := <-errs: return nil, err case s := <-series: sets = append(sets, s...) } } response := &logproto.SeriesResponse{ Series: make([]logproto.SeriesIdentifier, 0), } seen := make(map[uint64]struct{}) b := make([]byte, 0, 1024) for _, set := range sets { for _, s := range set { key := s.Hash(b) if _, exists := seen[key]; !exists { seen[key] = struct{}{} response.Series = append(response.Series, s) } } } return response, nil } // seriesForMatchers fetches series from the store for each matcher set // TODO: make efficient if/when the index supports labels so we don't have to read chunks func (q *SingleTenantQuerier) seriesForMatchers( ctx context.Context, from, through time.Time, groups []string, shards []string, ) ([]logproto.SeriesIdentifier, error) { var results []logproto.SeriesIdentifier // If no matchers were specified for the series query, // we send a query with an empty matcher which will match every series. if len(groups) == 0 { var err error results, err = q.seriesForMatcher(ctx, from, through, "", shards) if err != nil { return nil, err } } else { for _, group := range groups { ids, err := q.seriesForMatcher(ctx, from, through, group, shards) if err != nil { return nil, err } results = append(results, ids...) } } return results, nil } // seriesForMatcher fetches series from the store for a given matcher func (q *SingleTenantQuerier) seriesForMatcher(ctx context.Context, from, through time.Time, matcher string, shards []string) ([]logproto.SeriesIdentifier, error) { var parsed syntax.Expr var err error if matcher != "" { parsed, err = syntax.ParseExpr(matcher) if err != nil { return nil, err } } ids, err := q.store.SelectSeries(ctx, logql.SelectLogParams{ QueryRequest: &logproto.QueryRequest{ Selector: matcher, Limit: 1, Start: from, End: through, Direction: logproto.FORWARD, Shards: shards, Plan: &plan.QueryPlan{ AST: parsed, }, }, }) if err != nil { return nil, err } return ids, nil } func (q *SingleTenantQuerier) validateQueryRequest(ctx context.Context, req logql.QueryParams) (time.Time, time.Time, error) { userID, err := tenant.TenantID(ctx) if err != nil { return time.Time{}, time.Time{}, err } selector, err := req.LogSelector() if err != nil { return time.Time{}, time.Time{}, err } matchers := selector.Matchers() maxStreamMatchersPerQuery := q.limits.MaxStreamsMatchersPerQuery(ctx, userID) if len(matchers) > maxStreamMatchersPerQuery { return time.Time{}, time.Time{}, httpgrpc.Errorf(http.StatusBadRequest, "max streams matchers per query exceeded, matchers-count > limit (%d > %d)", len(matchers), maxStreamMatchersPerQuery) } return validateQueryTimeRangeLimits(ctx, userID, q.limits, req.GetStart(), req.GetEnd()) } type TimeRangeLimits querier_limits.TimeRangeLimits func validateQueryTimeRangeLimits(ctx context.Context, userID string, limits TimeRangeLimits, from, through time.Time) (time.Time, time.Time, error) { now := nowFunc() // Clamp the time range based on the max query lookback. maxQueryLookback := limits.MaxQueryLookback(ctx, userID) if maxQueryLookback > 0 && from.Before(now.Add(-maxQueryLookback)) { origStartTime := from from = now.Add(-maxQueryLookback) level.Debug(spanlogger.FromContext(ctx)).Log( "msg", "the start time of the query has been manipulated because of the 'max query lookback' setting", "original", origStartTime, "updated", from) } maxQueryLength := limits.MaxQueryLength(ctx, userID) if maxQueryLength > 0 && (through).Sub(from) > maxQueryLength { return time.Time{}, time.Time{}, httpgrpc.Errorf(http.StatusBadRequest, util_validation.ErrQueryTooLong, (through).Sub(from), model.Duration(maxQueryLength)) } if through.Before(from) { return time.Time{}, time.Time{}, httpgrpc.Errorf(http.StatusBadRequest, util_validation.ErrQueryTooOld, model.Duration(maxQueryLookback)) } return from, through, nil } func (q *SingleTenantQuerier) checkTailRequestLimit(ctx context.Context) error { userID, err := tenant.TenantID(ctx) if err != nil { return err } responses, err := q.ingesterQuerier.TailersCount(ctx) // We are only checking active ingesters, and any error returned stops checking other ingesters // so return that error here as well. if err != nil { return err } var maxCnt uint32 maxCnt = 0 for _, resp := range responses { if resp > maxCnt { maxCnt = resp } } l := uint32(q.limits.MaxConcurrentTailRequests(ctx, userID)) if maxCnt >= l { return httpgrpc.Errorf(http.StatusBadRequest, "max concurrent tail requests limit exceeded, count > limit (%d > %d)", maxCnt+1, l) } return nil } func (q *SingleTenantQuerier) IndexStats(ctx context.Context, req *loghttp.RangeQuery) (*stats.Stats, error) { userID, err := tenant.TenantID(ctx) if err != nil { return nil, err } start, end, err := validateQueryTimeRangeLimits(ctx, userID, q.limits, req.Start, req.End) if err != nil { return nil, err } matchers, err := syntax.ParseMatchers(req.Query, true) if err != nil { return nil, err } // Enforce the query timeout while querying backends queryTimeout := q.limits.QueryTimeout(ctx, userID) ctx, cancel := context.WithDeadline(ctx, time.Now().Add(queryTimeout)) defer cancel() return q.store.Stats( ctx, userID, model.TimeFromUnixNano(start.UnixNano()), model.TimeFromUnixNano(end.UnixNano()), matchers..., ) } func (q *SingleTenantQuerier) IndexShards( ctx context.Context, req *loghttp.RangeQuery, targetBytesPerShard uint64, ) (*logproto.ShardsResponse, error) { userID, err := tenant.TenantID(ctx) if err != nil { return nil, err } start, end, err := validateQueryTimeRangeLimits(ctx, userID, q.limits, req.Start, req.End) if err != nil { return nil, err } // Enforce the query timeout while querying backends queryTimeout := q.limits.QueryTimeout(ctx, userID) ctx, cancel := context.WithDeadline(ctx, time.Now().Add(queryTimeout)) defer cancel() p, err := indexgateway.ExtractShardRequestMatchersAndAST(req.Query) if err != nil { return nil, err } shards, err := q.store.GetShards( ctx, userID, model.TimeFromUnixNano(start.UnixNano()), model.TimeFromUnixNano(end.UnixNano()), targetBytesPerShard, p, ) if err != nil { return nil, err } return shards, nil } func (q *SingleTenantQuerier) Volume(ctx context.Context, req *logproto.VolumeRequest) (*logproto.VolumeResponse, error) { sp, ctx := opentracing.StartSpanFromContext(ctx, "Querier.Volume") defer sp.Finish() userID, err := tenant.TenantID(ctx) if err != nil { return nil, err } matchers, err := syntax.ParseMatchers(req.Matchers, true) if err != nil && req.Matchers != seriesvolume.MatchAny { return nil, err } // Enforce the query timeout while querying backends queryTimeout := q.limits.QueryTimeout(ctx, userID) ctx, cancel := context.WithDeadline(ctx, time.Now().Add(queryTimeout)) defer cancel() sp.LogKV( "user", userID, "from", req.From.Time(), "through", req.Through.Time(), "matchers", syntax.MatchersString(matchers), "limit", req.Limit, "targetLabels", req.TargetLabels, "aggregateBy", req.AggregateBy, ) ingesterQueryInterval, storeQueryInterval := q.buildQueryIntervals(req.From.Time(), req.Through.Time()) queryIngesters := !q.cfg.QueryStoreOnly && ingesterQueryInterval != nil queryStore := !q.cfg.QueryIngesterOnly && storeQueryInterval != nil numResponses := 0 if queryIngesters { numResponses++ } if queryStore { numResponses++ } responses := make([]*logproto.VolumeResponse, 0, numResponses) if queryIngesters { // Make a copy of the request before modifying // because the initial request is used below to query stores resp, err := q.ingesterQuerier.Volume( ctx, userID, model.TimeFromUnix(ingesterQueryInterval.start.Unix()), model.TimeFromUnix(ingesterQueryInterval.end.Unix()), req.Limit, req.TargetLabels, req.AggregateBy, matchers..., ) if err != nil { return nil, err } responses = append(responses, resp) } if queryStore { resp, err := q.store.Volume( ctx, userID, model.TimeFromUnix(storeQueryInterval.start.Unix()), model.TimeFromUnix(storeQueryInterval.end.Unix()), req.Limit, req.TargetLabels, req.AggregateBy, matchers..., ) if err != nil { return nil, err } responses = append(responses, resp) } return seriesvolume.Merge(responses, req.Limit), nil } func (q *SingleTenantQuerier) DetectedLabels(ctx context.Context, req *logproto.DetectedLabelsRequest) (*logproto.DetectedLabelsResponse, error) { var ingesterLabels *logproto.LabelToValuesResponse var detectedLabels []*logproto.DetectedLabel g, ctx := errgroup.WithContext(ctx) ingesterQueryInterval, _ := q.buildQueryIntervals(*req.Start, *req.End) if !q.cfg.QueryStoreOnly { g.Go(func() error { var err error splitReq := *req splitReq.Start = &ingesterQueryInterval.start splitReq.End = &ingesterQueryInterval.end ingesterLabels, err = q.ingesterQuerier.DetectedLabel(ctx, &splitReq) level.Info(q.logger).Log("msg", ingesterLabels) return err }) } if err := g.Wait(); err != nil { return nil, err } for label, values := range ingesterLabels.Labels { if q.isLabelRelevant(label, values) { detectedLabels = append(detectedLabels, &logproto.DetectedLabel{Label: label, Cardinality: uint64(len(values.Values))}) } } return &logproto.DetectedLabelsResponse{ DetectedLabels: detectedLabels, }, nil } func (q *SingleTenantQuerier) isLabelRelevant(label string, values *logproto.UniqueLabelValues) bool { staticLabels := []string{"pod", "namespace", "cluster", "instance"} cardinality := len(values.Values) // TODO(shantanu) make these values configurable if !slices.Contains(staticLabels, label) && (cardinality < 1 || cardinality > 50) || containsAllIDTypes(values.Values) { return false } return true } // containsAllIDTypes filters out all UUID, GUID and numeric types. Returns false if even one value is not of the type func containsAllIDTypes(values []string) bool { pattern := `^(?:(?:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})|(?:(?:\{)?[0-9a-fA-F]{8}(?:-?[0-9a-fA-F]{4}){3}-?[0-9a-fA-F]{12}(?:\})?)|(\d+(?:\.\d+)?))$` re := regexp.MustCompile(pattern) for _, v := range values { if !re.MatchString(v) { return false } } return true } func (q *SingleTenantQuerier) DetectedFields(ctx context.Context, req *logproto.DetectedFieldsRequest) (*logproto.DetectedFieldsResponse, error) { expr, err := syntax.ParseLogSelector(req.Query, true) if err != nil { return nil, err } params := logql.SelectLogParams{ QueryRequest: &logproto.QueryRequest{ Start: req.Start, End: req.End, Limit: req.LineLimit, Direction: logproto.BACKWARD, Selector: expr.String(), Plan: &plan.QueryPlan{ AST: expr, }, }, } iters, err := q.SelectLogs(ctx, params) if err != nil { return nil, err } //TODO(twhitney): converting from a step to a duration should be abstracted and reused, // doing this in a few places now. streams, err := streamsForFieldDetection(iters, req.LineLimit, time.Duration(req.Step*1e6)) if err != nil { return nil, err } detectedFields := parseDetectedFields(ctx, req.FieldLimit, streams) fields := make([]*logproto.DetectedField, len(detectedFields)) fieldCount := 0 for k, v := range detectedFields { fields[fieldCount] = &logproto.DetectedField{ Label: k, Type: v.fieldType, Cardinality: v.Estimate(), } fieldCount++ } return &logproto.DetectedFieldsResponse{ Fields: fields, }, nil } type parsedFields struct { sketch *hyperloglog.Sketch isTypeDetected bool fieldType logproto.DetectedFieldType } func newParsedFields() *parsedFields { return &parsedFields{ sketch: hyperloglog.New(), isTypeDetected: false, fieldType: logproto.DetectedFieldString, } } func (p *parsedFields) Insert(value string) { p.sketch.Insert([]byte(value)) } func (p *parsedFields) Estimate() uint64 { return p.sketch.Estimate() } func (p *parsedFields) DetermineType(value string) { p.fieldType = determineType(value) p.isTypeDetected = true } func determineType(value string) logproto.DetectedFieldType { if _, err := strconv.ParseInt(value, 10, 64); err == nil { return logproto.DetectedFieldInt } if _, err := strconv.ParseFloat(value, 64); err == nil { return logproto.DetectedFieldFloat } if _, err := strconv.ParseBool(value); err == nil { return logproto.DetectedFieldBoolean } if _, err := time.ParseDuration(value); err == nil { return logproto.DetectedFieldDuration } if _, err := humanize.ParseBytes(value); err == nil { return logproto.DetectedFieldBytes } return logproto.DetectedFieldString } func parseDetectedFields(ctx context.Context, limit uint32, streams logqlmodel.Streams) map[string]*parsedFields { detectedFields := make(map[string]*parsedFields, limit) fieldCount := uint32(0) for _, stream := range streams { level.Debug(spanlogger.FromContext(ctx)).Log( "detected_fields", "true", "msg", fmt.Sprintf("looking for detected fields in stream %d with %d lines", stream.Hash, len(stream.Entries))) for _, entry := range stream.Entries { detected := parseLine(entry.Line) for k, vals := range detected { if fieldCount >= limit { return detectedFields } if _, ok := detectedFields[k]; !ok { detectedFields[k] = newParsedFields() } for _, v := range vals { parsedFields := detectedFields[k] if !parsedFields.isTypeDetected { parsedFields.DetermineType(v) } parsedFields.Insert(v) } level.Debug(spanlogger.FromContext(ctx)).Log( "detected_fields", "true", "msg", fmt.Sprintf("detected field %s with %d values", k, len(vals))) fieldCount++ } } } return detectedFields } func parseLine(line string) map[string][]string { logFmtParser := logql_log.NewLogfmtParser(true, false) jsonParser := logql_log.NewJSONParser() lbls := logql_log.NewBaseLabelsBuilder().ForLabels(labels.EmptyLabels(), 0) _, logfmtSuccess := logFmtParser.Process(0, []byte(line), lbls) if !logfmtSuccess || lbls.HasErr() { lbls.Reset() _, jsonSuccess := jsonParser.Process(0, []byte(line), lbls) if !jsonSuccess || lbls.HasErr() { return map[string][]string{} } } parsedLabels := map[string]map[string]struct{}{} for _, lbl := range lbls.LabelsResult().Labels() { if values, ok := parsedLabels[lbl.Name]; ok { values[lbl.Value] = struct{}{} } else { parsedLabels[lbl.Name] = map[string]struct{}{lbl.Value: {}} } } result := make(map[string][]string, len(parsedLabels)) for lbl, values := range parsedLabels { vals := make([]string, 0, len(values)) for v := range values { vals = append(vals, v) } result[lbl] = vals } return result } // readStreams reads the streams from the iterator and returns them sorted. // If categorizeLabels is true, the stream labels contains just the stream labels and entries inside each stream have their // structuredMetadata and parsed fields populated with structured metadata labels plus the parsed labels respectively. // Otherwise, the stream labels are the whole series labels including the stream labels, structured metadata labels and parsed labels. func streamsForFieldDetection(i iter.EntryIterator, size uint32, interval time.Duration) (logqlmodel.Streams, error) { streams := map[string]*logproto.Stream{} respSize := uint32(0) // lastEntry should be a really old time so that the first comparison is always true, we use a negative // value here because many unit tests start at time.Unix(0,0) lastEntry := time.Unix(-100, 0) for respSize < size && i.Next() { streamLabels, entry := i.Labels(), i.Entry() // Always going backward shouldOutput := entry.Timestamp.Equal(lastEntry.Add(-interval)) || entry.Timestamp.Before(lastEntry.Add(-interval)) // If step == 0 output every line. // If lastEntry.Unix < 0 this is the first pass through the loop and we should output the line. // Then check to see if the entry is equal to, or past a forward step if interval == 0 || lastEntry.Unix() < 0 || shouldOutput { stream, ok := streams[streamLabels] if !ok { stream = &logproto.Stream{ Labels: streamLabels, } streams[streamLabels] = stream } stream.Entries = append(stream.Entries, entry) lastEntry = i.Entry().Timestamp respSize++ } } result := make(logqlmodel.Streams, 0, len(streams)) for _, stream := range streams { result = append(result, *stream) } sort.Sort(result) return result, i.Error() }