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

Jump to bottom

fix: Correctly encode step when translating proto to http internally #13171

Merged
merged 1 commit into from
Jun 7, 2024
Merged

fix: Correctly encode step when translating proto to http internally #13171

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
57 changes: 57 additions & 0 deletions pkg/logproto/compat.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -506,6 +506,33 @@ func (m *ShardsRequest) LogToSpan(sp opentracing.Span) {
sp.LogFields(fields...)
}

func (m *DetectedFieldsRequest) GetCachingOptions() (res definitions.CachingOptions) { return }

func (m *DetectedFieldsRequest) WithStartEnd(start, end time.Time) definitions.Request {
clone := *m
clone.Start = start
clone.End = end
return &clone
}

func (m *DetectedFieldsRequest) WithQuery(query string) definitions.Request {
clone := *m
clone.Query = query
return &clone
}

func (m *DetectedFieldsRequest) LogToSpan(sp opentracing.Span) {
fields := []otlog.Field{
otlog.String("query", m.GetQuery()),
otlog.String("start", m.Start.String()),
otlog.String("end", m.End.String()),
otlog.String("step", time.Duration(m.Step).String()),
otlog.String("field_limit", fmt.Sprintf("%d", m.FieldLimit)),
otlog.String("line_limit", fmt.Sprintf("%d", m.LineLimit)),
}
sp.LogFields(fields...)
}

func (m *QueryPatternsRequest) GetCachingOptions() (res definitions.CachingOptions) { return }

func (m *QueryPatternsRequest) WithStartEnd(start, end time.Time) definitions.Request {
Expand Down Expand Up @@ -534,3 +561,33 @@ func (m *QueryPatternsRequest) LogToSpan(sp opentracing.Span) {
}
sp.LogFields(fields...)
}

func (m *DetectedLabelsRequest) GetStep() int64 { return 0 }

func (m *DetectedLabelsRequest) GetCachingOptions() (res definitions.CachingOptions) { return }

func (m *DetectedLabelsRequest) WithStartEnd(start, end time.Time) definitions.Request {
clone := *m
clone.Start = start
clone.End = end
return &clone
}

func (m *DetectedLabelsRequest) WithQuery(query string) definitions.Request {
clone := *m
clone.Query = query
return &clone
}

func (m *DetectedLabelsRequest) WithStartEndForCache(start, end time.Time) resultscache.Request {
return m.WithStartEnd(start, end).(resultscache.Request)
}

func (m *DetectedLabelsRequest) LogToSpan(sp opentracing.Span) {
fields := []otlog.Field{
otlog.String("query", m.GetQuery()),
otlog.String("start", m.Start.String()),
otlog.String("end", m.End.String()),
}
sp.LogFields(fields...)
}
10 changes: 8 additions & 2 deletions pkg/querier/queryrange/codec.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -919,7 +919,10 @@ func (c Codec) EncodeRequest(ctx context.Context, r queryrangebase.Request) (*ht
"end": []string{fmt.Sprintf("%d", request.End.UnixNano())},
"line_limit": []string{fmt.Sprintf("%d", request.GetLineLimit())},
"field_limit": []string{fmt.Sprintf("%d", request.GetFieldLimit())},
"step": []string{fmt.Sprintf("%d", request.GetStep())},
}

if request.Step != 0 {
params["step"] = []string{fmt.Sprintf("%f", float64(request.Step)/float64(1e3))}
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

An alternative is to format the step as a duration string so 3000 becomes 3000ms instead of 3.000 seconds.

}

u := &url.URL{
Expand All @@ -940,7 +943,10 @@ func (c Codec) EncodeRequest(ctx context.Context, r queryrangebase.Request) (*ht
"query": []string{request.GetQuery()},
"start": []string{fmt.Sprintf("%d", request.Start.UnixNano())},
"end": []string{fmt.Sprintf("%d", request.End.UnixNano())},
"step": []string{fmt.Sprintf("%d", request.GetStep())},
}

if request.Step != 0 {
params["step"] = []string{fmt.Sprintf("%f", float64(request.Step)/float64(1e3))}
}

u := &url.URL{
Expand Down
53 changes: 52 additions & 1 deletion pkg/querier/queryrange/codec_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import (
"net/http/httptest"
"net/url"
"strconv"
strings "strings"
"strings"
"testing"
"time"

Expand Down Expand Up @@ -202,6 +202,57 @@ func Test_codec_EncodeDecodeRequest(t *testing.T) {
Step: 30 * 1e3, // step is expected in ms; default is 0 or no step
AggregateBy: "series",
}, false},
{"detected_fields", func() (*http.Request, error) {
return DefaultCodec.EncodeRequest(ctx, &DetectedFieldsRequest{
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm a bit confused as to why we use a wrapped queryrange.DetectedFieldsRequest and not the raw logproto.DetectedFieldsRequest here - is this the right thing to do?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the query-frontend is messy for sure I think it's fine.

logproto.DetectedFieldsRequest{
Query: `{foo="bar"}`,
Start: start,
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Other proto api objects use unix nanos for time, but these 3 (DetectedFields/DetectedLabels/QueryPatterns) use google.protobuf.Timestamp instead. Is there a reason for that? Should we be consistent across all our APIs and use one or the other?

End: end,
Step: 30 * 1e3, // step is expected in ms; default is 0 or no step
LineLimit: 100,
FieldLimit: 100,
},
"/loki/api/v1/detected_fields",
})
}, &DetectedFieldsRequest{
logproto.DetectedFieldsRequest{
Query: `{foo="bar"}`,
Start: start,
End: end,
Step: 30 * 1e3, // step is expected in ms; default is 0 or no step
LineLimit: 100,
FieldLimit: 100,
},
"/loki/api/v1/detected_fields",
}, false},
{"patterns", func() (*http.Request, error) {
return DefaultCodec.EncodeRequest(ctx, &logproto.QueryPatternsRequest{
Start: start,
End: end,
Step: 30 * 1e3, // step is expected in ms
})
}, &logproto.QueryPatternsRequest{
Start: start,
End: end,
Step: 30 * 1e3, // step is expected in ms; default is 0 or no step
}, false},
{"detected_labels", func() (*http.Request, error) {
return DefaultCodec.EncodeRequest(ctx, &DetectedLabelsRequest{
"/loki/api/v1/detected_labels",
logproto.DetectedLabelsRequest{
Query: `{foo="bar"}`,
Start: start,
End: end,
},
})
}, &DetectedLabelsRequest{
"/loki/api/v1/detected_labels",
logproto.DetectedLabelsRequest{
Query: `{foo="bar"}`,
Start: start,
End: end,
},
}, false},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
Expand Down
Loading