| 1 |
// Copyright The OpenTelemetry Authors |
| 2 |
// SPDX-License-Identifier: Apache-2.0 |
| 3 |
|
| 4 |
package exemplar |
| 5 |
|
| 6 |
import ( |
| 7 |
"context" |
| 8 |
"sync" |
| 9 |
"testing" |
| 10 |
"time" |
| 11 |
|
| 12 |
"github.com/stretchr/testify/assert" |
| 13 |
"github.com/stretchr/testify/require" |
| 14 |
|
| 15 |
"go.opentelemetry.io/otel/attribute" |
| 16 |
"go.opentelemetry.io/otel/trace" |
| 17 |
) |
| 18 |
|
| 19 |
// Sat Jan 01 2000 00:00:00 GMT+0000. |
| 20 |
var staticTime = time.Unix(946684800, 0) |
| 21 |
|
| 22 |
type factory func(requestedCap int) (r ReservoirProvider, actualCap int) |
| 23 |
|
| 24 |
func ReservoirTest[N int64 | float64](f factory) func(*testing.T) { |
| 25 |
return func(t *testing.T) { |
| 26 |
t.Helper() |
| 27 |
|
| 28 |
ctx := t.Context() |
| 29 |
|
| 30 |
t.Run("CaptureSpanContext", func(t *testing.T) { |
| 31 |
t.Helper() |
| 32 |
|
| 33 |
rp, n := f(1) |
| 34 |
if n < 1 { |
| 35 |
t.Skip("skipping, reservoir capacity less than 1:", n) |
| 36 |
} |
| 37 |
r := rp(*attribute.EmptySet()) |
| 38 |
|
| 39 |
tID, sID := trace.TraceID{0x01}, trace.SpanID{0x01} |
| 40 |
sc := trace.NewSpanContext(trace.SpanContextConfig{ |
| 41 |
TraceID: tID, |
| 42 |
SpanID: sID, |
| 43 |
TraceFlags: trace.FlagsSampled, |
| 44 |
}) |
| 45 |
ctx := trace.ContextWithSpanContext(ctx, sc) |
| 46 |
|
| 47 |
r.Offer(ctx, staticTime, NewValue(N(10)), nil) |
| 48 |
|
| 49 |
var dest []Exemplar |
| 50 |
r.Collect(&dest) |
| 51 |
|
| 52 |
want := Exemplar{ |
| 53 |
Time: staticTime, |
| 54 |
Value: NewValue(N(10)), |
| 55 |
SpanID: sID[:], |
| 56 |
TraceID: tID[:], |
| 57 |
} |
| 58 |
require.Len(t, dest, 1, "number of collected exemplars") |
| 59 |
assert.Equal(t, want, dest[0]) |
| 60 |
}) |
| 61 |
|
| 62 |
t.Run("FilterAttributes", func(t *testing.T) { |
| 63 |
t.Helper() |
| 64 |
|
| 65 |
rp, n := f(1) |
| 66 |
if n < 1 { |
| 67 |
t.Skip("skipping, reservoir capacity less than 1:", n) |
| 68 |
} |
| 69 |
r := rp(*attribute.EmptySet()) |
| 70 |
|
| 71 |
adminTrue := attribute.Bool("admin", true) |
| 72 |
r.Offer(ctx, staticTime, NewValue(N(10)), []attribute.KeyValue{adminTrue}) |
| 73 |
|
| 74 |
var dest []Exemplar |
| 75 |
r.Collect(&dest) |
| 76 |
|
| 77 |
want := Exemplar{ |
| 78 |
FilteredAttributes: []attribute.KeyValue{adminTrue}, |
| 79 |
Time: staticTime, |
| 80 |
Value: NewValue(N(10)), |
| 81 |
} |
| 82 |
require.Len(t, dest, 1, "number of collected exemplars") |
| 83 |
assert.Equal(t, want, dest[0]) |
| 84 |
}) |
| 85 |
|
| 86 |
t.Run("CollectLessThanN", func(t *testing.T) { |
| 87 |
t.Helper() |
| 88 |
|
| 89 |
rp, n := f(2) |
| 90 |
if n < 2 { |
| 91 |
t.Skip("skipping, reservoir capacity less than 2:", n) |
| 92 |
} |
| 93 |
r := rp(*attribute.EmptySet()) |
| 94 |
|
| 95 |
r.Offer(ctx, staticTime, NewValue(N(10)), nil) |
| 96 |
|
| 97 |
var dest []Exemplar |
| 98 |
r.Collect(&dest) |
| 99 |
// No empty exemplars are exported. |
| 100 |
require.Len(t, dest, 1, "number of collected exemplars") |
| 101 |
}) |
| 102 |
|
| 103 |
t.Run("MultipleOffers", func(t *testing.T) { |
| 104 |
t.Helper() |
| 105 |
|
| 106 |
rp, n := f(3) |
| 107 |
if n < 1 { |
| 108 |
t.Skip("skipping, reservoir capacity less than 1:", n) |
| 109 |
} |
| 110 |
r := rp(*attribute.EmptySet()) |
| 111 |
|
| 112 |
for i := 0; i < n+1; i++ { |
| 113 |
v := NewValue(N(i)) |
| 114 |
r.Offer(ctx, staticTime, v, nil) |
| 115 |
} |
| 116 |
|
| 117 |
var dest []Exemplar |
| 118 |
r.Collect(&dest) |
| 119 |
assert.Len(t, dest, n, "multiple offers did not fill reservoir") |
| 120 |
|
| 121 |
// Ensure the collect reset also resets any counting state. |
| 122 |
for i := 0; i < n+1; i++ { |
| 123 |
v := NewValue(N(i)) |
| 124 |
r.Offer(ctx, staticTime, v, nil) |
| 125 |
} |
| 126 |
|
| 127 |
dest = dest[:0] |
| 128 |
r.Collect(&dest) |
| 129 |
assert.Len(t, dest, n, "internal count state not reset") |
| 130 |
}) |
| 131 |
|
| 132 |
t.Run("DropAll", func(t *testing.T) { |
| 133 |
t.Helper() |
| 134 |
|
| 135 |
rp, n := f(0) |
| 136 |
if n > 0 { |
| 137 |
t.Skip("skipping, reservoir capacity greater than 0:", n) |
| 138 |
} |
| 139 |
r := rp(*attribute.EmptySet()) |
| 140 |
|
| 141 |
r.Offer(t.Context(), staticTime, NewValue(N(10)), nil) |
| 142 |
|
| 143 |
dest := []Exemplar{{}} // Should be reset to empty. |
| 144 |
r.Collect(&dest) |
| 145 |
assert.Empty(t, dest, "no exemplars should be collected") |
| 146 |
}) |
| 147 |
|
| 148 |
t.Run("Negative reservoir capacity drops all", func(t *testing.T) { |
| 149 |
t.Helper() |
| 150 |
|
| 151 |
rp, n := f(-1) |
| 152 |
if n > 0 { |
| 153 |
t.Skip("skipping, reservoir capacity greater than 0:", n) |
| 154 |
} |
| 155 |
assert.Zero(t, n) |
| 156 |
r := rp(*attribute.EmptySet()) |
| 157 |
|
| 158 |
r.Offer(t.Context(), staticTime, NewValue(N(10)), nil) |
| 159 |
|
| 160 |
dest := []Exemplar{{}} // Should be reset to empty. |
| 161 |
r.Collect(&dest) |
| 162 |
assert.Empty(t, dest, "no exemplars should be collected") |
| 163 |
}) |
| 164 |
} |
| 165 |
} |
| 166 |
|
| 167 |
func reservoirConcurrentSafeTest[N int64 | float64](f factory) func(*testing.T) { |
| 168 |
return func(t *testing.T) { |
| 169 |
t.Helper() |
| 170 |
rp, n := f(1) |
| 171 |
if n < 1 { |
| 172 |
t.Skip("skipping, reservoir capacity less than 1:", n) |
| 173 |
} |
| 174 |
r := rp(*attribute.EmptySet()) |
| 175 |
|
| 176 |
var wg sync.WaitGroup |
| 177 |
|
| 178 |
const goroutines = 2 |
| 179 |
|
| 180 |
// Call Offer concurrently with another Offer, and with Collect. |
| 181 |
for i := range goroutines { |
| 182 |
wg.Add(1) |
| 183 |
go func(iteration int) { |
| 184 |
ctx, ts, val, attrs := generateOfferInputs[N](iteration + 1) |
| 185 |
r.Offer(ctx, ts, val, attrs) |
| 186 |
wg.Done() |
| 187 |
}(i) |
| 188 |
} |
| 189 |
|
| 190 |
// Also test concurrent Collect calls |
| 191 |
wg.Go(func() { |
| 192 |
var dest []Exemplar |
| 193 |
r.Collect(&dest) |
| 194 |
}) |
| 195 |
|
| 196 |
wg.Wait() |
| 197 |
|
| 198 |
// Final collect to validate state |
| 199 |
var dest []Exemplar |
| 200 |
r.Collect(&dest) |
| 201 |
assert.NotEmpty(t, dest) |
| 202 |
for _, e := range dest { |
| 203 |
validateExemplar[N](t, e) |
| 204 |
} |
| 205 |
} |
| 206 |
} |
| 207 |
|
| 208 |
func generateOfferInputs[N int64 | float64]( |
| 209 |
i int, |
| 210 |
) (context.Context, time.Time, Value, []attribute.KeyValue) { |
| 211 |
sc := trace.NewSpanContext(trace.SpanContextConfig{ |
| 212 |
TraceID: trace.TraceID([16]byte{byte(i)}), |
| 213 |
SpanID: trace.SpanID([8]byte{byte(i)}), |
| 214 |
TraceFlags: trace.FlagsSampled, |
| 215 |
}) |
| 216 |
ctx := trace.ContextWithSpanContext(context.Background(), sc) |
| 217 |
ts := time.Unix(int64(i), int64(i)) |
| 218 |
val := NewValue(N(i)) |
| 219 |
attrs := []attribute.KeyValue{attribute.Int("i", i)} |
| 220 |
return ctx, ts, val, attrs |
| 221 |
} |
| 222 |
|
| 223 |
func validateExemplar[N int64 | float64](t *testing.T, e Exemplar) { |
| 224 |
t.Helper() |
| 225 |
i := 0 |
| 226 |
switch e.Value.Type() { |
| 227 |
case Int64ValueType: |
| 228 |
i = int(e.Value.Int64()) |
| 229 |
case Float64ValueType: |
| 230 |
i = int(e.Value.Float64()) |
| 231 |
default: |
| 232 |
t.Fatalf("unexpected value type: %v", e.Value.Type()) |
| 233 |
} |
| 234 |
if i == 0 { |
| 235 |
t.Fatal("empty exemplar") |
| 236 |
} |
| 237 |
ctx, ts, _, attrs := generateOfferInputs[N](i) |
| 238 |
sc := trace.SpanContextFromContext(ctx) |
| 239 |
tID := sc.TraceID() |
| 240 |
sID := sc.SpanID() |
| 241 |
assert.Equal(t, tID[:], e.TraceID) |
| 242 |
assert.Equal(t, sID[:], e.SpanID) |
| 243 |
assert.Equal(t, ts, e.Time) |
| 244 |
assert.Equal(t, attrs, e.FilteredAttributes) |
| 245 |
} |