File: histogram_test.go

package info (click to toggle)
golang-github-victoriametrics-metrics 1.13.1%2Bds-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 236 kB
  • sloc: makefile: 2
file content (221 lines) | stat: -rw-r--r-- 7,975 bytes parent folder | download
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
package metrics

import (
	"bytes"
	"fmt"
	"math"
	"reflect"
	"strings"
	"testing"
	"time"
)

func TestGetBucketIdxAndOffset(t *testing.T) {
	f := func(v float64, bucketIdxExpected int, offsetExpected uint) {
		t.Helper()
		bucketIdx, offset := getBucketIdxAndOffset(v)
		if bucketIdx != bucketIdxExpected {
			t.Fatalf("unexpected bucketIdx for %g; got %d; want %d", v, bucketIdx, bucketIdxExpected)
		}
		if offset != offsetExpected {
			t.Fatalf("unexpected offset for %g; got %d; want %d", v, offset, offsetExpected)
		}
	}
	const step = 1.0 / decimalMultiplier
	const prec = 2 * decimalPrecision
	f(0, -1, 0)
	f(math.Pow10(e10Min-10), -1, 1)
	f(math.Pow10(e10Min-1), -1, 1)
	f(3*math.Pow10(e10Min-1), -1, 1)
	f(9*math.Pow10(e10Min-1), -1, 1)
	f(9.999*math.Pow10(e10Min-1), -1, 1)
	f(math.Pow10(e10Min), -1, 1)
	f((1+prec)*math.Pow10(e10Min), 0, 0)
	f((1+step)*math.Pow10(e10Min), 0, 0)
	f((1+step+prec)*math.Pow10(e10Min), 0, 1)
	f((1+2*step+prec)*math.Pow10(e10Min), 0, 2)
	f((1+3*step+prec)*math.Pow10(e10Min), 0, 3)
	f(math.Pow10(e10Min+1), 0, bucketSize-1)
	f((1+prec)*math.Pow10(e10Min+1), 1, 0)
	f((1+step)*math.Pow10(e10Min+1), 1, 0)
	f((1+step+prec)*math.Pow10(e10Min+1), 1, 1)
	f(0.1, -e10Min-2, bucketSize-1)
	f((1+prec)*0.1, -e10Min-1, 0)
	f((1+step)*0.1, -e10Min-1, 0)
	f((1+step+prec)*0.1, -e10Min-1, 1)
	f((1+(bucketSize-1)*step)*0.1, -e10Min-1, bucketSize-2)
	f((1+(bucketSize-1)*step+prec)*0.1, -e10Min-1, bucketSize-1)
	f(math.Pow10(e10Max-2), bucketsCount-3, bucketSize-1)
	f((1+prec)*math.Pow10(e10Max-2), bucketsCount-2, 0)
	f(math.Pow10(e10Max-1), bucketsCount-2, bucketSize-1)
	f((1+prec)*math.Pow10(e10Max-1), bucketsCount-1, 0)
	f((1+(bucketSize-1)*step)*math.Pow10(e10Max-1), bucketsCount-1, bucketSize-2)
	f((1+(bucketSize-1)*step+prec)*math.Pow10(e10Max-1), bucketsCount-1, bucketSize-1)
	f(math.Pow10(e10Max), bucketsCount-1, bucketSize-1)
	f((1+prec)*math.Pow10(e10Max), -1, 2)
	f((1+3*step+prec)*math.Pow10(e10Max), -1, 2)
	f(math.Inf(1), -1, 2)

	f(999, 11, 17)
	f(1000, 11, 17)
	f(1001, 12, 0)
	f(1002, 12, 0)
	f(1003, 12, 0)
}

func TestGetVMRange(t *testing.T) {
	f := func(bucketIdx int, offset uint, vmrangeExpected string) {
		t.Helper()
		vmrange := getVMRange(bucketIdx, offset)
		if vmrange != vmrangeExpected {
			t.Fatalf("unexpected vmrange for bucketIdx=%d, offset=%d; got %s; want %s", bucketIdx, offset, vmrange, vmrangeExpected)
		}
	}
	const step = 1.0 / decimalMultiplier
	f(-1, 0, "0...0")
	f(-1, 1, fmt.Sprintf("0...1.0e%d", e10Min))
	f(-1, 2, fmt.Sprintf("1.0e%d...+Inf", e10Max))
	f(0, 0, fmt.Sprintf("1.0e%d...%.1fe%d", e10Min, 1+step, e10Min))
	f(0, 1, fmt.Sprintf("%.1fe%d...%.1fe%d", 1+step, e10Min, 1+2*step, e10Min))
	f(0, bucketSize-2, fmt.Sprintf("%.1fe%d...%.1fe%d", 1+(bucketSize-2)*step, e10Min, 1+(bucketSize-1)*step, e10Min))
	f(0, bucketSize-1, fmt.Sprintf("%.1fe%d...%.1fe%d", 1+(bucketSize-1)*step, e10Min, 1.0, e10Min+1))
	f(-e10Min, 0, fmt.Sprintf("%.1fe%d...%.1fe%d", 1.0, 0, 1+step, 0))
	f(-e10Min, 1, fmt.Sprintf("%.1fe%d...%.1fe%d", 1+step, 0, 1+2*step, 0))
	f(-e10Min, bucketSize-2, fmt.Sprintf("%.1fe%d...%.1fe%d", 1+(bucketSize-2)*step, 0, 1+(bucketSize-1)*step, 0))
	f(-e10Min, bucketSize-1, fmt.Sprintf("%.1fe%d...%.1fe%d", 1+(bucketSize-1)*step, 0, 1.0, 1))
	f(bucketsCount-1, bucketSize-2, fmt.Sprintf("%.1fe%d...%.1fe%d", 1+(bucketSize-2)*step, e10Max-1, 1+(bucketSize-1)*step, e10Max-1))
	f(bucketsCount-1, bucketSize-1, fmt.Sprintf("%.1fe%d...%.1fe%d", 1+(bucketSize-1)*step, e10Max-1, 1.0, e10Max))
}

func TestHistogramSerial(t *testing.T) {
	name := `TestHistogramSerial`
	h := NewHistogram(name)

	// Verify that the histogram is invisible in the output of WritePrometheus when it has no data.
	var bb bytes.Buffer
	WritePrometheus(&bb, false)
	result := bb.String()
	if strings.Contains(result, name) {
		t.Fatalf("histogram %s shouldn't be visible in the WritePrometheus output; got\n%s", name, result)
	}

	// Write data to histogram
	for i := 98; i < 218; i++ {
		h.Update(float64(i))
	}

	// Make sure the histogram prints <prefix>_xbucket on marshalTo call
	testMarshalTo(t, h, "prefix", "prefix_bucket{vmrange=\"9.5e1...1.0e2\"} 3\nprefix_bucket{vmrange=\"1.0e2...1.5e2\"} 50\nprefix_bucket{vmrange=\"1.5e2...2.0e2\"} 50\nprefix_bucket{vmrange=\"2.0e2...2.5e2\"} 17\nprefix_sum 18900\nprefix_count 120\n")
	testMarshalTo(t, h, `	  m{foo="bar"}`, "\t  m_bucket{foo=\"bar\",vmrange=\"9.5e1...1.0e2\"} 3\n\t  m_bucket{foo=\"bar\",vmrange=\"1.0e2...1.5e2\"} 50\n\t  m_bucket{foo=\"bar\",vmrange=\"1.5e2...2.0e2\"} 50\n\t  m_bucket{foo=\"bar\",vmrange=\"2.0e2...2.5e2\"} 17\n\t  m_sum{foo=\"bar\"} 18900\n\t  m_count{foo=\"bar\"} 120\n")

	// Verify Reset
	h.Reset()
	bb.Reset()
	WritePrometheus(&bb, false)
	result = bb.String()
	if strings.Contains(result, name) {
		t.Fatalf("unexpected histogram %s in the WritePrometheus output; got\n%s", name, result)
	}

	// Verify supported ranges
	for e10 := -100; e10 < 100; e10++ {
		for offset := 0; offset < bucketSize; offset++ {
			m := 1 + float64(offset+1)/decimalMultiplier
			f1 := m * math.Pow10(e10)
			h.Update(f1)
			f2 := (m + 0.5/decimalMultiplier) * math.Pow10(e10)
			h.Update(f2)
			f3 := (m + 2*decimalPrecision) * math.Pow10(e10)
			h.Update(f3)
		}
	}
	h.UpdateDuration(time.Now().Add(-time.Minute))

	// Verify edge cases
	h.Update(0)
	h.Update(math.Inf(1))
	h.Update(math.Inf(-1))
	h.Update(math.NaN())
	h.Update(-123)

	// Make sure the histogram becomes visible in the output of WritePrometheus,
	// since now it contains values.
	bb.Reset()
	WritePrometheus(&bb, false)
	result = bb.String()
	if !strings.Contains(result, name) {
		t.Fatalf("missing histogram %s in the WritePrometheus output; got\n%s", name, result)
	}
}

func TestHistogramConcurrent(t *testing.T) {
	name := "HistogramConcurrent"
	h := NewHistogram(name)
	err := testConcurrent(func() error {
		for f := 0.6; f < 1.4; f += 0.1 {
			h.Update(f)
		}
		return nil
	})
	if err != nil {
		t.Fatal(err)
	}
	testMarshalTo(t, h, "prefix", "prefix_bucket{vmrange=\"5.5e-1...6.0e-1\"} 5\nprefix_bucket{vmrange=\"6.5e-1...7.0e-1\"} 5\nprefix_bucket{vmrange=\"7.5e-1...8.0e-1\"} 5\nprefix_bucket{vmrange=\"8.5e-1...9.0e-1\"} 5\nprefix_bucket{vmrange=\"9.5e-1...1.0e0\"} 5\nprefix_bucket{vmrange=\"1.0e0...1.5e0\"} 15\nprefix_sum 38\nprefix_count 40\n")

	var labels []string
	var counts []uint64
	h.VisitNonZeroBuckets(func(label string, count uint64) {
		labels = append(labels, label)
		counts = append(counts, count)
	})
	labelsExpected := []string{"5.5e-1...6.0e-1", "6.5e-1...7.0e-1", "7.5e-1...8.0e-1", "8.5e-1...9.0e-1", "9.5e-1...1.0e0", "1.0e0...1.5e0"}
	if !reflect.DeepEqual(labels, labelsExpected) {
		t.Fatalf("unexpected labels; got %v; want %v", labels, labelsExpected)
	}
	countsExpected := []uint64{5, 5, 5, 5, 5, 15}
	if !reflect.DeepEqual(counts, countsExpected) {
		t.Fatalf("unexpected counts; got %v; want %v", counts, countsExpected)
	}
}

func TestHistogramWithTags(t *testing.T) {
	name := `TestHistogram{tag="foo"}`
	h := NewHistogram(name)
	h.Update(123)

	var bb bytes.Buffer
	WritePrometheus(&bb, false)
	result := bb.String()
	namePrefixWithTag := `TestHistogram_bucket{tag="foo",vmrange="1.0e2...1.5e2"} 1` + "\n"
	if !strings.Contains(result, namePrefixWithTag) {
		t.Fatalf("missing histogram %s in the WritePrometheus output; got\n%s", namePrefixWithTag, result)
	}
}

func TestGetOrCreateHistogramSerial(t *testing.T) {
	name := "GetOrCreateHistogramSerial"
	if err := testGetOrCreateHistogram(name); err != nil {
		t.Fatal(err)
	}
}

func TestGetOrCreateHistogramConcurrent(t *testing.T) {
	name := "GetOrCreateHistogramConcurrent"
	err := testConcurrent(func() error {
		return testGetOrCreateHistogram(name)
	})
	if err != nil {
		t.Fatal(err)
	}
}

func testGetOrCreateHistogram(name string) error {
	h1 := GetOrCreateHistogram(name)
	for i := 0; i < 10; i++ {
		h2 := GetOrCreateHistogram(name)
		if h1 != h2 {
			return fmt.Errorf("unexpected histogram returned; got %p; want %p", h2, h1)
		}
	}
	return nil
}