mirror of
https://github.com/prometheus/prometheus.git
synced 2025-11-04 10:21:02 +01:00
57c18420ab
- Adjust doc comments to go1.19 style. - Break down some overly long lines. - Minor doc comment tweaks and fixes. - Some renaming. Some rationales for the last point: I have renamed “interjections” into “inserts”, mostly because it is shorter, and the word shows up a lot by now (and the concept is cryptic enough to not obfuscate it even more with abbreviations). I have also tried to find more descriptive naming for the “compare spans” functions. Signed-off-by: beorn7 <beorn@grafana.com>
576 lines
13 KiB
Go
576 lines
13 KiB
Go
// Copyright 2021 The Prometheus Authors
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
// The code in this file was largely written by Damian Gryski as part of
|
|
// https://github.com/dgryski/go-tsz and published under the license below.
|
|
// It was modified to accommodate reading from byte slices without modifying
|
|
// the underlying bytes, which would panic when reading from mmap'd
|
|
// read-only byte slices.
|
|
package chunkenc
|
|
|
|
import (
|
|
"math"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"github.com/prometheus/prometheus/model/histogram"
|
|
)
|
|
|
|
// Example of a span layout and resulting bucket indices (_idx_ is used in this
|
|
// histogram, others are shown just for context):
|
|
//
|
|
// spans : [offset: 0, length: 2] [offset 1, length 1]
|
|
// bucket idx : _0_ _1_ 2 [3] 4 ...
|
|
|
|
func TestBucketIterator(t *testing.T) {
|
|
type test struct {
|
|
spans []histogram.Span
|
|
idxs []int
|
|
}
|
|
tests := []test{
|
|
{
|
|
spans: []histogram.Span{
|
|
{
|
|
Offset: 0,
|
|
Length: 1,
|
|
},
|
|
},
|
|
idxs: []int{0},
|
|
},
|
|
{
|
|
spans: []histogram.Span{
|
|
{
|
|
Offset: 0,
|
|
Length: 2,
|
|
},
|
|
{
|
|
Offset: 1,
|
|
Length: 1,
|
|
},
|
|
},
|
|
idxs: []int{0, 1, 3},
|
|
},
|
|
{
|
|
spans: []histogram.Span{
|
|
{
|
|
Offset: 100,
|
|
Length: 4,
|
|
},
|
|
{
|
|
Offset: 8,
|
|
Length: 7,
|
|
},
|
|
{
|
|
Offset: 0,
|
|
Length: 1,
|
|
},
|
|
},
|
|
idxs: []int{100, 101, 102, 103, 112, 113, 114, 115, 116, 117, 118, 119},
|
|
},
|
|
// The below 2 sets ore the ones described in expandSpansForward's comments.
|
|
{
|
|
spans: []histogram.Span{
|
|
{Offset: 0, Length: 2},
|
|
{Offset: 2, Length: 1},
|
|
{Offset: 3, Length: 2},
|
|
{Offset: 3, Length: 1},
|
|
{Offset: 1, Length: 1},
|
|
},
|
|
idxs: []int{0, 1, 4, 8, 9, 13, 15},
|
|
},
|
|
{
|
|
spans: []histogram.Span{
|
|
{Offset: 0, Length: 3},
|
|
{Offset: 1, Length: 1},
|
|
{Offset: 1, Length: 4},
|
|
{Offset: 3, Length: 3},
|
|
},
|
|
idxs: []int{0, 1, 2, 4, 6, 7, 8, 9, 13, 14, 15},
|
|
},
|
|
}
|
|
for _, test := range tests {
|
|
b := newBucketIterator(test.spans)
|
|
var got []int
|
|
v, ok := b.Next()
|
|
for ok {
|
|
got = append(got, v)
|
|
v, ok = b.Next()
|
|
}
|
|
require.Equal(t, test.idxs, got)
|
|
}
|
|
}
|
|
|
|
func TestCompareSpansAndInsert(t *testing.T) {
|
|
scenarios := []struct {
|
|
description string
|
|
spansA, spansB []histogram.Span
|
|
fInserts, bInserts []Insert
|
|
bucketsIn, bucketsOut []int64
|
|
}{
|
|
{
|
|
description: "single prepend at the beginning",
|
|
spansA: []histogram.Span{
|
|
{Offset: -10, Length: 3},
|
|
},
|
|
spansB: []histogram.Span{
|
|
{Offset: -11, Length: 4},
|
|
},
|
|
fInserts: []Insert{
|
|
{
|
|
pos: 0,
|
|
num: 1,
|
|
},
|
|
},
|
|
bucketsIn: []int64{6, -3, 0},
|
|
bucketsOut: []int64{0, 6, -3, 0},
|
|
},
|
|
{
|
|
description: "single append at the end",
|
|
spansA: []histogram.Span{
|
|
{Offset: -10, Length: 3},
|
|
},
|
|
spansB: []histogram.Span{
|
|
{Offset: -10, Length: 4},
|
|
},
|
|
fInserts: []Insert{
|
|
{
|
|
pos: 3,
|
|
num: 1,
|
|
},
|
|
},
|
|
bucketsIn: []int64{6, -3, 0},
|
|
bucketsOut: []int64{6, -3, 0, -3},
|
|
},
|
|
{
|
|
description: "double prepend at the beginning",
|
|
spansA: []histogram.Span{
|
|
{Offset: -10, Length: 3},
|
|
},
|
|
spansB: []histogram.Span{
|
|
{Offset: -12, Length: 5},
|
|
},
|
|
fInserts: []Insert{
|
|
{
|
|
pos: 0,
|
|
num: 2,
|
|
},
|
|
},
|
|
bucketsIn: []int64{6, -3, 0},
|
|
bucketsOut: []int64{0, 0, 6, -3, 0},
|
|
},
|
|
{
|
|
description: "double append at the end",
|
|
spansA: []histogram.Span{
|
|
{Offset: -10, Length: 3},
|
|
},
|
|
spansB: []histogram.Span{
|
|
{Offset: -10, Length: 5},
|
|
},
|
|
fInserts: []Insert{
|
|
{
|
|
pos: 3,
|
|
num: 2,
|
|
},
|
|
},
|
|
bucketsIn: []int64{6, -3, 0},
|
|
bucketsOut: []int64{6, -3, 0, -3, 0},
|
|
},
|
|
{
|
|
description: "double prepond at the beginning and double append at the end",
|
|
spansA: []histogram.Span{
|
|
{Offset: -10, Length: 3},
|
|
},
|
|
spansB: []histogram.Span{
|
|
{Offset: -12, Length: 7},
|
|
},
|
|
fInserts: []Insert{
|
|
{
|
|
pos: 0,
|
|
num: 2,
|
|
},
|
|
{
|
|
pos: 3,
|
|
num: 2,
|
|
},
|
|
},
|
|
bucketsIn: []int64{6, -3, 0},
|
|
bucketsOut: []int64{0, 0, 6, -3, 0, -3, 0},
|
|
},
|
|
{
|
|
description: "single removal of bucket at the start",
|
|
spansA: []histogram.Span{
|
|
{Offset: -10, Length: 4},
|
|
},
|
|
spansB: []histogram.Span{
|
|
{Offset: -9, Length: 3},
|
|
},
|
|
bInserts: []Insert{
|
|
{pos: 0, num: 1},
|
|
},
|
|
},
|
|
{
|
|
description: "single removal of bucket in the middle",
|
|
spansA: []histogram.Span{
|
|
{Offset: -10, Length: 4},
|
|
},
|
|
spansB: []histogram.Span{
|
|
{Offset: -10, Length: 2},
|
|
{Offset: 1, Length: 1},
|
|
},
|
|
bInserts: []Insert{
|
|
{pos: 2, num: 1},
|
|
},
|
|
},
|
|
{
|
|
description: "single removal of bucket at the end",
|
|
spansA: []histogram.Span{
|
|
{Offset: -10, Length: 4},
|
|
},
|
|
spansB: []histogram.Span{
|
|
{Offset: -10, Length: 3},
|
|
},
|
|
bInserts: []Insert{
|
|
{pos: 3, num: 1},
|
|
},
|
|
},
|
|
{
|
|
description: "as described in doc comment",
|
|
spansA: []histogram.Span{
|
|
{Offset: 0, Length: 2},
|
|
{Offset: 2, Length: 1},
|
|
{Offset: 3, Length: 2},
|
|
{Offset: 3, Length: 1},
|
|
{Offset: 1, Length: 1},
|
|
},
|
|
spansB: []histogram.Span{
|
|
{Offset: 0, Length: 3},
|
|
{Offset: 1, Length: 1},
|
|
{Offset: 1, Length: 4},
|
|
{Offset: 3, Length: 3},
|
|
},
|
|
fInserts: []Insert{
|
|
{
|
|
pos: 2,
|
|
num: 1,
|
|
},
|
|
{
|
|
pos: 3,
|
|
num: 2,
|
|
},
|
|
{
|
|
pos: 6,
|
|
num: 1,
|
|
},
|
|
},
|
|
bucketsIn: []int64{6, -3, 0, -1, 2, 1, -4},
|
|
bucketsOut: []int64{6, -3, -3, 3, -3, 0, 2, 2, 1, -5, 1},
|
|
},
|
|
{
|
|
description: "both forward and backward inserts, complex case",
|
|
spansA: []histogram.Span{
|
|
{Offset: 0, Length: 2},
|
|
{Offset: 2, Length: 1},
|
|
{Offset: 3, Length: 2},
|
|
{Offset: 3, Length: 1},
|
|
{Offset: 1, Length: 1},
|
|
},
|
|
spansB: []histogram.Span{
|
|
{Offset: 1, Length: 2},
|
|
{Offset: 1, Length: 1},
|
|
{Offset: 1, Length: 2},
|
|
{Offset: 1, Length: 1},
|
|
{Offset: 4, Length: 1},
|
|
},
|
|
fInserts: []Insert{
|
|
{
|
|
pos: 2,
|
|
num: 1,
|
|
},
|
|
{
|
|
pos: 3,
|
|
num: 2,
|
|
},
|
|
{
|
|
pos: 6,
|
|
num: 1,
|
|
},
|
|
},
|
|
bInserts: []Insert{
|
|
{
|
|
pos: 0,
|
|
num: 1,
|
|
},
|
|
{
|
|
pos: 5,
|
|
num: 1,
|
|
},
|
|
{
|
|
pos: 6,
|
|
num: 1,
|
|
},
|
|
{
|
|
pos: 7,
|
|
num: 1,
|
|
},
|
|
},
|
|
},
|
|
}
|
|
|
|
for _, s := range scenarios {
|
|
t.Run(s.description, func(t *testing.T) {
|
|
if len(s.bInserts) > 0 {
|
|
fInserts, bInserts, _ := expandSpansBothWays(s.spansA, s.spansB)
|
|
require.Equal(t, s.fInserts, fInserts)
|
|
require.Equal(t, s.bInserts, bInserts)
|
|
}
|
|
|
|
inserts, valid := expandSpansForward(s.spansA, s.spansB)
|
|
if len(s.bInserts) > 0 {
|
|
require.False(t, valid, "compareScan unexpectedly returned true")
|
|
return
|
|
}
|
|
require.True(t, valid, "compareScan unexpectedly returned false")
|
|
require.Equal(t, s.fInserts, inserts)
|
|
|
|
gotBuckets := make([]int64, len(s.bucketsOut))
|
|
insert(s.bucketsIn, gotBuckets, inserts, true)
|
|
require.Equal(t, s.bucketsOut, gotBuckets)
|
|
|
|
floatBucketsIn := make([]float64, len(s.bucketsIn))
|
|
last := s.bucketsIn[0]
|
|
floatBucketsIn[0] = float64(last)
|
|
for i := 1; i < len(floatBucketsIn); i++ {
|
|
last += s.bucketsIn[i]
|
|
floatBucketsIn[i] = float64(last)
|
|
}
|
|
floatBucketsOut := make([]float64, len(s.bucketsOut))
|
|
last = s.bucketsOut[0]
|
|
floatBucketsOut[0] = float64(last)
|
|
for i := 1; i < len(floatBucketsOut); i++ {
|
|
last += s.bucketsOut[i]
|
|
floatBucketsOut[i] = float64(last)
|
|
}
|
|
gotFloatBuckets := make([]float64, len(floatBucketsOut))
|
|
insert(floatBucketsIn, gotFloatBuckets, inserts, false)
|
|
require.Equal(t, floatBucketsOut, gotFloatBuckets)
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestWriteReadHistogramChunkLayout(t *testing.T) {
|
|
layouts := []struct {
|
|
schema int32
|
|
zeroThreshold float64
|
|
positiveSpans, negativeSpans []histogram.Span
|
|
}{
|
|
{
|
|
schema: 3,
|
|
zeroThreshold: 0,
|
|
positiveSpans: []histogram.Span{{Offset: -4, Length: 3}, {Offset: 2, Length: 42}},
|
|
negativeSpans: nil,
|
|
},
|
|
{
|
|
schema: -2,
|
|
zeroThreshold: 2.938735877055719e-39, // Default value in client_golang.
|
|
positiveSpans: nil,
|
|
negativeSpans: []histogram.Span{{Offset: 2, Length: 5}, {Offset: 1, Length: 34}},
|
|
},
|
|
{
|
|
schema: 6,
|
|
zeroThreshold: 1024, // The largest power of two we can encode in one byte.
|
|
positiveSpans: nil,
|
|
negativeSpans: nil,
|
|
},
|
|
{
|
|
schema: 6,
|
|
zeroThreshold: 1025,
|
|
positiveSpans: []histogram.Span{{Offset: 2, Length: 5}, {Offset: 1, Length: 34}, {Offset: 0, Length: 0}}, // Weird span.
|
|
negativeSpans: []histogram.Span{{Offset: -345, Length: 4545}, {Offset: 53645665, Length: 345}, {Offset: 945995, Length: 85848}},
|
|
},
|
|
{
|
|
schema: 6,
|
|
zeroThreshold: 2048,
|
|
positiveSpans: nil,
|
|
negativeSpans: nil,
|
|
},
|
|
{
|
|
schema: 0,
|
|
zeroThreshold: math.Ldexp(0.5, -242), // The smallest power of two we can encode in one byte.
|
|
positiveSpans: []histogram.Span{{Offset: -4, Length: 3}},
|
|
negativeSpans: []histogram.Span{{Offset: 2, Length: 5}, {Offset: 1, Length: 34}},
|
|
},
|
|
{
|
|
schema: 0,
|
|
zeroThreshold: math.Ldexp(0.5, -243),
|
|
positiveSpans: []histogram.Span{{Offset: -4, Length: 3}},
|
|
negativeSpans: []histogram.Span{{Offset: 2, Length: 5}, {Offset: 1, Length: 34}},
|
|
},
|
|
{
|
|
schema: 4,
|
|
zeroThreshold: 42, // Not a power of two.
|
|
positiveSpans: nil,
|
|
negativeSpans: nil,
|
|
},
|
|
}
|
|
|
|
bs := bstream{}
|
|
|
|
for _, l := range layouts {
|
|
writeHistogramChunkLayout(&bs, l.schema, l.zeroThreshold, l.positiveSpans, l.negativeSpans)
|
|
}
|
|
|
|
bsr := newBReader(bs.bytes())
|
|
|
|
for _, want := range layouts {
|
|
gotSchema, gotZeroThreshold, gotPositiveSpans, gotNegativeSpans, err := readHistogramChunkLayout(&bsr)
|
|
require.NoError(t, err)
|
|
require.Equal(t, want.schema, gotSchema)
|
|
require.Equal(t, want.zeroThreshold, gotZeroThreshold)
|
|
require.Equal(t, want.positiveSpans, gotPositiveSpans)
|
|
require.Equal(t, want.negativeSpans, gotNegativeSpans)
|
|
}
|
|
}
|
|
|
|
func TestSpansFromBidirectionalCompareSpans(t *testing.T) {
|
|
cases := []struct {
|
|
s1, s2, exp []histogram.Span
|
|
}{
|
|
{ // All empty.
|
|
s1: []histogram.Span{},
|
|
s2: []histogram.Span{},
|
|
},
|
|
{ // Same spans.
|
|
s1: []histogram.Span{},
|
|
s2: []histogram.Span{},
|
|
},
|
|
{
|
|
// Has the cases of
|
|
// 1. |----| (partial overlap)
|
|
// |----|
|
|
//
|
|
// 2. |-----| (no gap but no overlap as well)
|
|
// |---|
|
|
//
|
|
// 3. |----| (complete overlap)
|
|
// |----|
|
|
s1: []histogram.Span{
|
|
{Offset: 0, Length: 3},
|
|
{Offset: 3, Length: 3},
|
|
{Offset: 5, Length: 3},
|
|
},
|
|
s2: []histogram.Span{
|
|
{Offset: 0, Length: 2},
|
|
{Offset: 2, Length: 2},
|
|
{Offset: 2, Length: 3},
|
|
{Offset: 3, Length: 3},
|
|
},
|
|
exp: []histogram.Span{
|
|
{Offset: 0, Length: 3},
|
|
{Offset: 1, Length: 7},
|
|
{Offset: 3, Length: 3},
|
|
},
|
|
},
|
|
{
|
|
// s1 is superset of s2.
|
|
s1: []histogram.Span{
|
|
{Offset: 0, Length: 3},
|
|
{Offset: 3, Length: 5},
|
|
{Offset: 3, Length: 3},
|
|
},
|
|
s2: []histogram.Span{
|
|
{Offset: 0, Length: 2},
|
|
{Offset: 5, Length: 3},
|
|
{Offset: 4, Length: 3},
|
|
},
|
|
exp: []histogram.Span{
|
|
{Offset: 0, Length: 3},
|
|
{Offset: 3, Length: 5},
|
|
{Offset: 3, Length: 3},
|
|
},
|
|
},
|
|
{
|
|
// No overlaps but one span is side by side.
|
|
s1: []histogram.Span{
|
|
{Offset: 0, Length: 3},
|
|
{Offset: 3, Length: 3},
|
|
{Offset: 5, Length: 3},
|
|
},
|
|
s2: []histogram.Span{
|
|
{Offset: 3, Length: 3},
|
|
{Offset: 4, Length: 2},
|
|
},
|
|
exp: []histogram.Span{
|
|
{Offset: 0, Length: 9},
|
|
{Offset: 1, Length: 2},
|
|
{Offset: 2, Length: 3},
|
|
},
|
|
},
|
|
{
|
|
// No buckets in one of them.
|
|
s1: []histogram.Span{
|
|
{Offset: 0, Length: 3},
|
|
{Offset: 3, Length: 3},
|
|
{Offset: 5, Length: 3},
|
|
},
|
|
s2: []histogram.Span{},
|
|
exp: []histogram.Span{
|
|
{Offset: 0, Length: 3},
|
|
{Offset: 3, Length: 3},
|
|
{Offset: 5, Length: 3},
|
|
},
|
|
},
|
|
{ // Zero length spans.
|
|
s1: []histogram.Span{
|
|
{Offset: -5, Length: 0},
|
|
{Offset: 2, Length: 0},
|
|
{Offset: 3, Length: 3},
|
|
{Offset: 1, Length: 0},
|
|
{Offset: 2, Length: 3},
|
|
{Offset: 2, Length: 0},
|
|
{Offset: 2, Length: 0},
|
|
{Offset: 1, Length: 3},
|
|
{Offset: 4, Length: 0},
|
|
{Offset: 5, Length: 0},
|
|
},
|
|
s2: []histogram.Span{
|
|
{Offset: 0, Length: 2},
|
|
{Offset: 2, Length: 2},
|
|
{Offset: 1, Length: 0},
|
|
{Offset: 1, Length: 3},
|
|
{Offset: 3, Length: 3},
|
|
},
|
|
exp: []histogram.Span{
|
|
{Offset: 0, Length: 3},
|
|
{Offset: 1, Length: 7},
|
|
{Offset: 3, Length: 3},
|
|
},
|
|
},
|
|
}
|
|
|
|
for _, c := range cases {
|
|
s1c := make([]histogram.Span, len(c.s1))
|
|
s2c := make([]histogram.Span, len(c.s2))
|
|
copy(s1c, c.s1)
|
|
copy(s2c, c.s2)
|
|
|
|
_, _, act := expandSpansBothWays(c.s1, c.s2)
|
|
require.Equal(t, c.exp, act)
|
|
// Check that s1 and s2 are not modified.
|
|
require.Equal(t, s1c, c.s1)
|
|
require.Equal(t, s2c, c.s2)
|
|
_, _, act = expandSpansBothWays(c.s2, c.s1)
|
|
require.Equal(t, c.exp, act)
|
|
}
|
|
}
|