File: metric_test.go

package info (click to toggle)
golang-github-prometheus-client-golang 1.23.0-1
  • links: PTS, VCS
  • area: main
  • in suites: experimental, forky, sid
  • size: 3,192 kB
  • sloc: makefile: 68; ansic: 46; sh: 21
file content (357 lines) | stat: -rw-r--r-- 11,519 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
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
// Copyright 2014 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.

package prometheus

import (
	"errors"
	"fmt"
	"math"
	"testing"
	"time"

	dto "github.com/prometheus/client_model/go"

	"google.golang.org/protobuf/proto"
	"google.golang.org/protobuf/types/known/timestamppb"
)

func TestBuildFQName(t *testing.T) {
	scenarios := []struct{ namespace, subsystem, name, result string }{
		{"a", "b", "c", "a_b_c"},
		{"", "b", "c", "b_c"},
		{"a", "", "c", "a_c"},
		{"", "", "c", "c"},
		{"a", "b", "", ""},
		{"a", "", "", ""},
		{"", "b", "", ""},
		{" ", "", "", ""},
	}

	for i, s := range scenarios {
		if want, got := s.result, BuildFQName(s.namespace, s.subsystem, s.name); want != got {
			t.Errorf("%d. want %s, got %s", i, want, got)
		}
	}
}

func TestWithExemplarsMetric(t *testing.T) {
	t.Run("histogram", func(t *testing.T) {
		// Create a constant histogram from values we got from a 3rd party telemetry system.
		h := MustNewConstHistogram(
			NewDesc("http_request_duration_seconds", "A histogram of the HTTP request durations.", nil, nil),
			4711, 403.34,
			// Four buckets, but we expect five as the +Inf bucket will be created if we see value outside of those buckets.
			map[float64]uint64{25: 121, 50: 2403, 100: 3221, 200: 4233},
		)

		m := &withExemplarsMetric{Metric: h, exemplars: []*dto.Exemplar{
			{Value: proto.Float64(2000.0)}, // Unordered exemplars.
			{Value: proto.Float64(500.0)},
			{Value: proto.Float64(42.0)},
			{Value: proto.Float64(157.0)},
			{Value: proto.Float64(100.0)},
			{Value: proto.Float64(89.0)},
			{Value: proto.Float64(24.0)},
			{Value: proto.Float64(25.1)},
		}}
		metric := dto.Metric{}
		if err := m.Write(&metric); err != nil {
			t.Fatal(err)
		}
		if want, got := 5, len(metric.GetHistogram().Bucket); want != got {
			t.Errorf("want %v, got %v", want, got)
		}

		expectedExemplarVals := []float64{24.0, 25.1, 89.0, 157.0, 500.0}
		for i, b := range metric.GetHistogram().Bucket {
			if b.Exemplar == nil {
				t.Errorf("Expected exemplar for bucket %v, got nil", i)
			}
			if want, got := expectedExemplarVals[i], *metric.GetHistogram().Bucket[i].Exemplar.Value; want != got {
				t.Errorf("%v: want %v, got %v", i, want, got)
			}
		}

		infBucket := metric.GetHistogram().Bucket[len(metric.GetHistogram().Bucket)-1]

		if want, got := math.Inf(1), infBucket.GetUpperBound(); want != got {
			t.Errorf("want %v, got %v", want, got)
		}

		if want, got := uint64(4711), infBucket.GetCumulativeCount(); want != got {
			t.Errorf("want %v, got %v", want, got)
		}
	})
}

func TestWithExemplarsNativeHistogramMetric(t *testing.T) {
	t.Run("native histogram single exemplar", func(t *testing.T) {
		// Create a constant histogram from values we got from a 3rd party telemetry system.
		h := MustNewConstNativeHistogram(
			NewDesc("http_request_duration_seconds", "A histogram of the HTTP request durations.", nil, nil),
			10, 12.1, map[int]int64{1: 7, 2: 1, 3: 2}, map[int]int64{}, 0, 2, 0.2, time.Date(
				2009, 11, 17, 20, 34, 58, 651387237, time.UTC))
		m := &withExemplarsMetric{Metric: h, exemplars: []*dto.Exemplar{
			{Value: proto.Float64(2000.0), Timestamp: timestamppb.New(time.Date(2009, 11, 17, 20, 34, 58, 3243244, time.UTC))},
		}}
		metric := dto.Metric{}
		if err := m.Write(&metric); err != nil {
			t.Fatal(err)
		}
		if want, got := 1, len(metric.GetHistogram().Exemplars); want != got {
			t.Errorf("want %v, got %v", want, got)
		}

		for _, b := range metric.GetHistogram().Bucket {
			if b.Exemplar != nil {
				t.Error("Not expecting exemplar for bucket")
			}
		}
	})
	t.Run("native histogram multiple exemplar", func(t *testing.T) {
		// Create a constant histogram from values we got from a 3rd party telemetry system.
		h := MustNewConstNativeHistogram(
			NewDesc("http_request_duration_seconds", "A histogram of the HTTP request durations.", nil, nil),
			10, 12.1, map[int]int64{1: 7, 2: 1, 3: 2}, map[int]int64{}, 0, 2, 0.2, time.Date(
				2009, 11, 17, 20, 34, 58, 651387237, time.UTC))
		m := &withExemplarsMetric{Metric: h, exemplars: []*dto.Exemplar{
			{Value: proto.Float64(2000.0), Timestamp: timestamppb.New(time.Date(2009, 11, 17, 20, 34, 58, 3243244, time.UTC))},
			{Value: proto.Float64(1000.0), Timestamp: timestamppb.New(time.Date(2009, 11, 17, 20, 34, 59, 3243244, time.UTC))},
		}}
		metric := dto.Metric{}
		if err := m.Write(&metric); err != nil {
			t.Fatal(err)
		}
		if want, got := 2, len(metric.GetHistogram().Exemplars); want != got {
			t.Errorf("want %v, got %v", want, got)
		}

		for _, b := range metric.GetHistogram().Bucket {
			if b.Exemplar != nil {
				t.Error("Not expecting exemplar for bucket")
			}
		}
	})
	t.Run("native histogram exemplar without timestamp", func(t *testing.T) {
		// Create a constant histogram from values we got from a 3rd party telemetry system.
		h := MustNewConstNativeHistogram(
			NewDesc("http_request_duration_seconds", "A histogram of the HTTP request durations.", nil, nil),
			10, 12.1, map[int]int64{1: 7, 2: 1, 3: 2}, map[int]int64{}, 0, 2, 0.2, time.Date(
				2009, 11, 17, 20, 34, 58, 651387237, time.UTC))
		m := MustNewMetricWithExemplars(h, Exemplar{
			Value: 1000.0,
		})
		metric := dto.Metric{}
		if err := m.Write(&metric); err != nil {
			t.Fatal(err)
		}
		if want, got := 1, len(metric.GetHistogram().Exemplars); want != got {
			t.Errorf("want %v, got %v", want, got)
		}
		if got := metric.GetHistogram().Exemplars[0].Timestamp; got == nil {
			t.Errorf("Got nil timestamp")
		}

		for _, b := range metric.GetHistogram().Bucket {
			if b.Exemplar != nil {
				t.Error("Not expecting exemplar for bucket")
			}
		}
	})
	t.Run("nativehistogram metric exemplars should be available in both buckets and exemplars", func(t *testing.T) {
		now := time.Now()
		tcs := []struct {
			Name                         string
			Count                        uint64
			Sum                          float64
			PositiveBuckets              map[int]int64
			NegativeBuckets              map[int]int64
			ZeroBucket                   uint64
			NativeHistogramSchema        int32
			NativeHistogramZeroThreshold float64
			CreatedTimestamp             time.Time
			Bucket                       []*dto.Bucket
			Exemplars                    []Exemplar
			Want                         *dto.Metric
		}{
			{
				Name:  "test_metric",
				Count: 6,
				Sum:   7.4,
				PositiveBuckets: map[int]int64{
					0: 1, 2: 2, 4: 2,
				},
				NegativeBuckets: map[int]int64{},
				ZeroBucket:      1,

				NativeHistogramSchema:        2,
				NativeHistogramZeroThreshold: 2.938735877055719e-39,
				CreatedTimestamp:             now,
				Bucket: []*dto.Bucket{
					{
						CumulativeCount: PointOf(uint64(6)),
						UpperBound:      PointOf(float64(1)),
					},
					{
						CumulativeCount: PointOf(uint64(8)),
						UpperBound:      PointOf(float64(2)),
					},
					{
						CumulativeCount: PointOf(uint64(11)),
						UpperBound:      PointOf(float64(5)),
					},
					{
						CumulativeCount: PointOf(uint64(13)),
						UpperBound:      PointOf(float64(10)),
					},
				},
				Exemplars: []Exemplar{
					{
						Timestamp: now,
						Value:     10,
					},
				},
				Want: &dto.Metric{
					Histogram: &dto.Histogram{
						SampleCount:   proto.Uint64(6),
						SampleSum:     proto.Float64(7.4),
						Schema:        proto.Int32(2),
						ZeroThreshold: proto.Float64(2.938735877055719e-39),
						ZeroCount:     proto.Uint64(1),
						PositiveSpan: []*dto.BucketSpan{
							{Offset: proto.Int32(0), Length: proto.Uint32(5)},
						},
						PositiveDelta: []int64{1, -1, 2, -2, 2},
						Exemplars: []*dto.Exemplar{
							{
								Value:     PointOf(float64(10)),
								Timestamp: timestamppb.New(now),
							},
						},
						Bucket: []*dto.Bucket{
							{
								CumulativeCount: PointOf(uint64(6)),
								UpperBound:      PointOf(float64(1)),
							},
							{
								CumulativeCount: PointOf(uint64(8)),
								UpperBound:      PointOf(float64(2)),
							},
							{
								CumulativeCount: PointOf(uint64(11)),
								UpperBound:      PointOf(float64(5)),
							},
							{
								CumulativeCount: PointOf(uint64(13)),
								UpperBound:      PointOf(float64(10)),
								Exemplar: &dto.Exemplar{
									Timestamp: timestamppb.New(now),
									Value:     PointOf(float64(10)),
								},
							},
						},
						CreatedTimestamp: timestamppb.New(now),
					},
				},
			},
		}

		for _, tc := range tcs {
			m, err := newNativeHistogramWithClassicBuckets(NewDesc(tc.Name, "None", []string{}, map[string]string{}), tc.Count, tc.Sum, tc.PositiveBuckets, tc.NegativeBuckets, tc.ZeroBucket, tc.NativeHistogramSchema, tc.NativeHistogramZeroThreshold, tc.CreatedTimestamp, tc.Bucket)
			if err != nil {
				t.Fail()
			}
			metricWithExemplar, err := NewMetricWithExemplars(m, tc.Exemplars[0])
			if err != nil {
				t.Fail()
			}
			got := &dto.Metric{}
			err = metricWithExemplar.Write(got)
			if err != nil {
				t.Fail()
			}

			if !proto.Equal(tc.Want, got) {
				t.Errorf("want histogram %q, got %q", tc.Want, got)
			}

		}
	})
}

func PointOf[T any](value T) *T {
	return &value
}

// newNativeHistogramWithClassicBuckets returns a Metric representing
// a native histogram that also has classic buckets. This is for testing purposes.
func newNativeHistogramWithClassicBuckets(
	desc *Desc,
	count uint64,
	sum float64,
	positiveBuckets, negativeBuckets map[int]int64,
	zeroBucket uint64,
	schema int32,
	zeroThreshold float64,
	createdTimestamp time.Time,
	// DummyNativeHistogram also defines buckets in the metric for testing
	buckets []*dto.Bucket,
	labelValues ...string,
) (Metric, error) {
	if desc.err != nil {
		fmt.Println("error", desc.err)
		return nil, desc.err
	}
	if err := validateLabelValues(labelValues, len(desc.variableLabels.names)); err != nil {
		return nil, err
	}
	if schema > nativeHistogramSchemaMaximum || schema < nativeHistogramSchemaMinimum {
		return nil, errors.New("invalid native histogram schema")
	}
	if err := validateCount(sum, count, negativeBuckets, positiveBuckets, zeroBucket); err != nil {
		return nil, err
	}

	NegativeSpan, NegativeDelta := makeBucketsFromMap(negativeBuckets)
	PositiveSpan, PositiveDelta := makeBucketsFromMap(positiveBuckets)
	ret := &constNativeHistogram{
		desc: desc,
		Histogram: dto.Histogram{
			CreatedTimestamp: timestamppb.New(createdTimestamp),
			Schema:           &schema,
			ZeroThreshold:    &zeroThreshold,
			SampleCount:      &count,
			SampleSum:        &sum,

			NegativeSpan:  NegativeSpan,
			NegativeDelta: NegativeDelta,

			PositiveSpan:  PositiveSpan,
			PositiveDelta: PositiveDelta,

			ZeroCount: proto.Uint64(zeroBucket),

			// DummyNativeHistogram also defines buckets in the metric
			Bucket: buckets,
		},
		labelPairs: MakeLabelPairs(desc, labelValues),
	}
	if *ret.ZeroThreshold == 0 && *ret.ZeroCount == 0 && len(ret.PositiveSpan) == 0 && len(ret.NegativeSpan) == 0 {
		ret.PositiveSpan = []*dto.BucketSpan{{
			Offset: proto.Int32(0),
			Length: proto.Uint32(0),
		}}
	}
	return ret, nil
}