Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add query user and query source to "executing query" log lines (backport k222) #14323

Merged
merged 1 commit into from
Sep 30, 2024
Merged

feat: add query user and query source to "executing query" log lines (backport k222) #14323

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions pkg/logql/engine.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,11 +241,21 @@ func (q *query) Exec(ctx context.Context) (logqlmodel.Result, error) {

if q.logExecQuery {
queryHash := util.HashedQuery(q.params.QueryString())

logValues := []interface{}{
"msg", "executing query",
"query", q.params.QueryString(),
"query_hash", queryHash,
}
tags := httpreq.ExtractQueryTagsFromContext(ctx)
tagValues := tagsToKeyValues(tags)
if GetRangeType(q.params) == InstantType {
level.Info(logutil.WithContext(ctx, q.logger)).Log("msg", "executing query", "type", "instant", "query", q.params.QueryString(), "query_hash", queryHash)
logValues = append(logValues, "type", "instant")
} else {
level.Info(logutil.WithContext(ctx, q.logger)).Log("msg", "executing query", "type", "range", "query", q.params.QueryString(), "length", q.params.End().Sub(q.params.Start()), "step", q.params.Step(), "query_hash", queryHash)
logValues = append(logValues, "type", "range", "length", q.params.End().Sub(q.params.Start()), "step", q.params.Step())
}
logValues = append(logValues, tagValues...)
level.Info(logutil.WithContext(ctx, q.logger)).Log(logValues...)
}

rangeType := GetRangeType(q.params)
Expand All @@ -265,6 +275,7 @@ func (q *query) Exec(ctx context.Context) (logqlmodel.Result, error) {
sp.LogKV(statResult.KVList()...)

status, _ := server.ClientHTTPStatusAndError(err)

if q.record {
RecordRangeAndInstantQueryMetrics(ctx, q.logger, q.params, strconv.Itoa(status), statResult, data)
}
Expand Down
26 changes: 8 additions & 18 deletions pkg/logql/engine_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ import (
"errors"
"fmt"
"math"
"regexp"
"strings"
"testing"
"time"
Expand Down Expand Up @@ -2618,23 +2617,14 @@ func TestHashingStability(t *testing.T) {
expectedQueryHash := util.HashedQuery(test.qs)

// check that both places will end up having the same query hash, even though they're emitting different log lines.
require.Regexp(t,
regexp.MustCompile(
fmt.Sprintf(
`level=info org_id=fake msg="executing query" type=range query=.* length=5s step=1m0s query_hash=%d.*`, expectedQueryHash,
),
),
queryWithEngine(),
)

require.Regexp(t,
regexp.MustCompile(
fmt.Sprintf(
`level=info org_id=fake latency=slow query=".*" query_hash=%d query_type=metric range_type=range.*\n`, expectedQueryHash,
),
),
queryDirectly(),
)
withEngine := queryWithEngine()
require.Contains(t, withEngine, fmt.Sprintf("query_hash=%d", expectedQueryHash))
require.Contains(t, withEngine, "step=1m0s")

directly := queryDirectly()
require.Contains(t, directly, fmt.Sprintf("query_hash=%d", expectedQueryHash))
require.Contains(t, directly, "length=5s")
require.Contains(t, directly, "latency=slow")
}
}

Expand Down
Loading