-
Notifications
You must be signed in to change notification settings - Fork 3.3k
/
views.go
373 lines (312 loc) · 10.6 KB
/
views.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
package queryrange
import (
"fmt"
"io"
"sort"
"github.com/cespare/xxhash/v2"
"github.com/gogo/protobuf/protoc-gen-gogo/descriptor"
jsoniter "github.com/json-iterator/go"
"github.com/richardartoul/molecule"
"github.com/richardartoul/molecule/src/codec"
"github.com/grafana/loki/v3/pkg/logproto"
"github.com/grafana/loki/v3/pkg/querier/queryrange/queryrangebase"
)
// Pull fiel numbers from protobuf message descriptions.
var (
queryResponse *QueryResponse
_, queryResponseDescription = descriptor.ForMessage(queryResponse)
seriesResponseFieldNumber = queryResponseDescription.GetFieldDescriptor("series").GetNumber()
seriesResponse *LokiSeriesResponse
_, seriesResponseDescription = descriptor.ForMessage(seriesResponse)
dataFieldNumber = seriesResponseDescription.GetFieldDescriptor("Data").GetNumber()
seriesIdentifier *logproto.SeriesIdentifier
_, seriesIdentifierDescription = descriptor.ForMessage(seriesIdentifier)
labelsFieldNumber = seriesIdentifierDescription.GetFieldDescriptor("labels").GetNumber()
)
// GetLokiSeriesResponseView returns a view on the series response of a
// QueryResponse. Returns an error if the message was empty. Note: the method
// does not verify that the reply is a properly encoded QueryResponse protobuf.
func GetLokiSeriesResponseView(data []byte) (view *LokiSeriesResponseView, err error) {
b := codec.NewBuffer(data)
err = molecule.MessageEach(b, func(fieldNum int32, value molecule.Value) (bool, error) {
if fieldNum == seriesResponseFieldNumber {
if len(value.Bytes) > 0 {
// We might be able to avoid an allocation and
// copy here by using value.Bytes
data, err = value.AsBytesSafe()
if err != nil {
return false, fmt.Errorf("could not allocate message bytes: %w", err)
}
view = &LokiSeriesResponseView{buffer: data}
}
}
return true, nil
})
if err == nil && view == nil {
err = fmt.Errorf("loki series response message was empty")
}
return
}
// LokiSeriesResponseView holds the raw bytes of a LokiSeriesResponse protobuf
// message. It is decoded lazily view ForEachSeries.
type LokiSeriesResponseView struct {
buffer []byte
headers []queryrangebase.PrometheusResponseHeader
}
var _ queryrangebase.Response = &LokiSeriesResponseView{}
func (v *LokiSeriesResponseView) GetHeaders() []*queryrangebase.PrometheusResponseHeader {
return convertPrometheusResponseHeadersToPointers(v.headers)
}
func (v *LokiSeriesResponseView) WithHeaders(h []queryrangebase.PrometheusResponseHeader) queryrangebase.Response {
v.headers = h
return v
}
func (v *LokiSeriesResponseView) SetHeader(name, value string) {
v.headers = setHeader(v.headers, name, value)
}
// Implement proto.Message
func (v *LokiSeriesResponseView) Reset() {}
func (v *LokiSeriesResponseView) String() string { return "" }
func (v *LokiSeriesResponseView) ProtoMessage() {}
// ForEachSeries iterates of the []logproto.SeriesIdentifier slice and pass a
// view on each identifier to the callback supplied.
func (v *LokiSeriesResponseView) ForEachSeries(fn func(view *SeriesIdentifierView) error) error {
return molecule.MessageEach(codec.NewBuffer(v.buffer), func(fieldNum int32, value molecule.Value) (bool, error) {
if fieldNum == dataFieldNumber {
identifier, err := value.AsBytesUnsafe()
if err != nil {
return false, err
}
view := &SeriesIdentifierView{buffer: identifier}
err = fn(view)
if err != nil {
return false, err
}
}
return true, nil
})
}
// SeriesIdentifierView holds the raw bytes of a logproto.SeriesIdentifier
// protobuf message.
type SeriesIdentifierView struct {
buffer []byte
}
// ForEachLabel iterates over each name-value label pair of the identifier map.
// Note: the strings passed to the supplied callback are unsafe views on the
// underlying data.
func (v *SeriesIdentifierView) ForEachLabel(fn func(string, string) error) error {
pair := make([]string, 0, 2)
return molecule.MessageEach(codec.NewBuffer(v.buffer), func(fieldNum int32, data molecule.Value) (bool, error) {
if fieldNum == 1 {
entry, err := data.AsBytesUnsafe()
if err != nil {
return false, err
}
err = molecule.MessageEach(codec.NewBuffer(entry), func(fieldNum int32, labelOrKey molecule.Value) (bool, error) {
s, err := labelOrKey.AsStringUnsafe()
if err != nil {
return false, err
}
pair = append(pair, s)
return true, nil
})
if err != nil {
return false, err
}
if len(pair) != 2 {
return false, fmt.Errorf("unexpected label pair length, go (%d), want (2)", len(pair))
}
err = fn(pair[0], pair[1])
if err != nil {
return false, err
}
pair = pair[:0]
return true, nil
}
return true, nil
})
}
// This is the separator define in the Prometheus Labels.Hash function.
var sep = string([]byte{'\xff'})
// HashFast is a faster version of the Hash method that uses an unsafe string of
// the name value label pairs. It does not have to allocate strings and is not
// using the separator. Thus it is not equivalent to the original Prometheus
// label hash function.
func (v *SeriesIdentifierView) HashFast(b []byte, keyLabelPairs []string) (uint64, []string, error) {
keyLabelPairs = keyLabelPairs[:0]
err := molecule.MessageEach(codec.NewBuffer(v.buffer), func(fieldNum int32, data molecule.Value) (bool, error) {
if fieldNum == 1 {
entry, err := data.AsStringUnsafe()
if err != nil {
return false, err
}
keyLabelPairs = append(keyLabelPairs, entry)
return true, err
}
return true, nil
})
if err != nil {
return 0, nil, err
}
sort.Strings(keyLabelPairs)
// Use xxhash.Sum64(b) for fast path as it's faster.
b = b[:0]
for i, pair := range keyLabelPairs {
if len(b)+len(pair) >= cap(b) {
// If labels entry is 1KB+ do not allocate whole entry.
h := xxhash.New()
_, _ = h.Write(b)
for _, pair := range keyLabelPairs[i:] {
_, _ = h.WriteString(pair)
}
return h.Sum64(), keyLabelPairs, nil
}
b = append(b, pair...)
}
return xxhash.Sum64(b), keyLabelPairs, nil
}
// Hash is adapted from SeriesIdentifier.Hash and produces the same hash for the
// same input as the original Prometheus hash method.
func (v *SeriesIdentifierView) Hash(b []byte, keyLabelPairs []string) (uint64, []string, error) {
keyLabelPairs = keyLabelPairs[:0]
err := v.ForEachLabel(func(name, value string) error {
pair := name + sep + value + sep
keyLabelPairs = append(keyLabelPairs, pair)
return nil
})
if err != nil {
return 0, nil, err
}
sort.Strings(keyLabelPairs)
// Use xxhash.Sum64(b) for fast path as it's faster.
b = b[:0]
for i, pair := range keyLabelPairs {
if len(b)+len(pair) >= cap(b) {
// If labels entry is 1KB+ do not allocate whole entry.
h := xxhash.New()
_, _ = h.Write(b)
for _, pair := range keyLabelPairs[i:] {
_, _ = h.WriteString(pair)
}
return h.Sum64(), keyLabelPairs, nil
}
b = append(b, pair...)
}
return xxhash.Sum64(b), keyLabelPairs, nil
}
// MergedSeriesResponseView holds references to all series responses that should
// be merged before serialization to JSON. The de-duplication happens during the
// ForEachUniqueSeries iteration.
type MergedSeriesResponseView struct {
responses []*LokiSeriesResponseView
headers []queryrangebase.PrometheusResponseHeader
}
var _ queryrangebase.Response = &MergedSeriesResponseView{}
func (v *MergedSeriesResponseView) GetHeaders() []*queryrangebase.PrometheusResponseHeader {
return convertPrometheusResponseHeadersToPointers(v.headers)
}
func (v *MergedSeriesResponseView) WithHeaders(headers []queryrangebase.PrometheusResponseHeader) queryrangebase.Response {
v.headers = headers
return v
}
func (v *MergedSeriesResponseView) SetHeader(name, value string) {
v.headers = setHeader(v.headers, name, value)
}
// Implement proto.Message
func (v *MergedSeriesResponseView) Reset() {}
func (v *MergedSeriesResponseView) String() string { return "" }
func (v *MergedSeriesResponseView) ProtoMessage() {}
// ForEachUniqueSeries iterates over all unique series identifiers of all series
// responses. It uses the HashFast method before passing the identifier view to
// the supplied callback.
func (v *MergedSeriesResponseView) ForEachUniqueSeries(fn func(*SeriesIdentifierView) error) error {
uniqueSeries := make(map[uint64]struct{})
b := make([]byte, 0, 1024)
keyBuffer := make([]string, 0, 32)
var key uint64
var err error
for _, response := range v.responses {
err = response.ForEachSeries(func(series *SeriesIdentifierView) error {
key, keyBuffer, err = series.HashFast(b, keyBuffer)
if err != nil {
return err
}
if _, duplicate := uniqueSeries[key]; !duplicate {
err = fn(series)
if err != nil {
return err
}
uniqueSeries[key] = struct{}{}
}
return nil
})
if err != nil {
return err
}
}
return nil
}
// Materialize produces a LokiSeriesResponse instance that is a deserialized
// probobuf message.
func (v *MergedSeriesResponseView) Materialize() (*LokiSeriesResponse, error) {
mat := &LokiSeriesResponse{}
err := v.ForEachUniqueSeries(func(series *SeriesIdentifierView) error {
identifier := logproto.SeriesIdentifier{Labels: make([]logproto.SeriesIdentifier_LabelsEntry, 0)}
err := series.ForEachLabel(func(name, value string) error {
identifier.Labels = append(identifier.Labels, logproto.SeriesIdentifier_LabelsEntry{Key: name, Value: value})
return nil
})
if err != nil {
return fmt.Errorf("error stepping through labels of series: %w", err)
}
mat.Data = append(mat.Data, identifier)
return nil
})
return mat, err
}
// WriteSeriesResponseViewJSON writes a JSON response to the supplied write that
// is equivalent to marshal.WriteSeriesResponseJSON.
func WriteSeriesResponseViewJSON(v *MergedSeriesResponseView, w io.Writer) error {
s := jsoniter.ConfigFastest.BorrowStream(w)
defer jsoniter.ConfigFastest.ReturnStream(s)
s.WriteObjectStart()
s.WriteObjectField("status")
s.WriteString("success")
s.WriteMore()
s.WriteObjectField("data")
s.WriteArrayStart()
firstSeriesWrite := true
firstLabelWrite := true
err := v.ForEachUniqueSeries(func(id *SeriesIdentifierView) error {
if firstSeriesWrite {
firstSeriesWrite = false
} else {
s.WriteMore()
}
s.WriteObjectStart()
firstLabelWrite = true
err := id.ForEachLabel(func(name, value string) error {
if firstLabelWrite {
firstLabelWrite = false
} else {
s.WriteMore()
}
s.WriteObjectField(name)
s.WriteString(value)
return nil
})
if err != nil {
return err
}
s.WriteObjectEnd()
s.Flush()
return nil
})
if err != nil {
return err
}
s.WriteArrayEnd()
s.WriteObjectEnd()
s.WriteRaw("\n")
return s.Flush()
}