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
|
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0
#include "opentelemetry/sdk/trace/samplers/trace_id_ratio.h"
#include "opentelemetry/trace/span_context_kv_iterable_view.h"
#include "src/common/random.h"
#include <gtest/gtest.h>
#include <cstdlib>
#include <ctime>
using opentelemetry::sdk::common::Random;
using opentelemetry::sdk::trace::Decision;
using opentelemetry::sdk::trace::TraceIdRatioBasedSampler;
namespace trace_api = opentelemetry::trace;
namespace common = opentelemetry::common;
namespace
{
/*
* Helper function for running TraceIdBased sampler tests.
* Given a span context, sampler, and number of iterations this function
* will return the number of RECORD_AND_SAMPLE decision based on randomly
* generated traces.
*
* @param context a required valid span context
* @param sampler a required valid sampler
* @param iterations a required number specifying the number of times to
* generate a random trace_id and check if it should sample using the provided
* provider and context
*/
int RunShouldSampleCountDecision(trace_api::SpanContext &context,
TraceIdRatioBasedSampler &sampler,
int iterations)
{
int actual_count = 0;
trace_api::SpanKind span_kind = trace_api::SpanKind::kInternal;
using M = std::map<std::string, int>;
M m1 = {{}};
using L = std::vector<std::pair<trace_api::SpanContext, std::map<std::string, std::string>>>;
L l1 = {{trace_api::SpanContext(false, false), {}}, {trace_api::SpanContext(false, false), {}}};
common::KeyValueIterableView<M> view{m1};
trace_api::SpanContextKeyValueIterableView<L> links{l1};
for (int i = 0; i < iterations; ++i)
{
uint8_t buf[16] = {0};
Random::GenerateRandomBuffer(buf);
trace_api::TraceId trace_id(buf);
auto result = sampler.ShouldSample(context, trace_id, "", span_kind, view, links);
if (result.decision == Decision::RECORD_AND_SAMPLE)
{
++actual_count;
}
}
return actual_count;
}
} // namespace
TEST(TraceIdRatioBasedSampler, ShouldSampleWithoutContext)
{
trace_api::TraceId invalid_trace_id;
trace_api::SpanKind span_kind = trace_api::SpanKind::kInternal;
using M = std::map<std::string, int>;
M m1 = {{}};
using L = std::vector<std::pair<trace_api::SpanContext, std::map<std::string, std::string>>>;
L l1 = {{trace_api::SpanContext(false, false), {}}, {trace_api::SpanContext(false, false), {}}};
common::KeyValueIterableView<M> view{m1};
trace_api::SpanContextKeyValueIterableView<L> links{l1};
TraceIdRatioBasedSampler s1(0.01);
auto sampling_result = s1.ShouldSample(trace_api::SpanContext::GetInvalid(), invalid_trace_id, "",
span_kind, view, links);
ASSERT_EQ(Decision::RECORD_AND_SAMPLE, sampling_result.decision);
ASSERT_EQ(nullptr, sampling_result.attributes);
constexpr uint8_t buf[] = {0, 0, 0, 0, 0, 0, 0, 0x80, 0, 0, 0, 0, 0, 0, 0, 0};
trace_api::TraceId valid_trace_id(buf);
sampling_result = s1.ShouldSample(trace_api::SpanContext::GetInvalid(), valid_trace_id, "",
span_kind, view, links);
ASSERT_EQ(Decision::DROP, sampling_result.decision);
ASSERT_EQ(nullptr, sampling_result.attributes);
TraceIdRatioBasedSampler s2(0.50000001);
sampling_result = s2.ShouldSample(trace_api::SpanContext::GetInvalid(), valid_trace_id, "",
span_kind, view, links);
ASSERT_EQ(Decision::RECORD_AND_SAMPLE, sampling_result.decision);
ASSERT_EQ(nullptr, sampling_result.attributes);
TraceIdRatioBasedSampler s3(0.49999999);
sampling_result = s3.ShouldSample(trace_api::SpanContext::GetInvalid(), valid_trace_id, "",
span_kind, view, links);
ASSERT_EQ(Decision::DROP, sampling_result.decision);
ASSERT_EQ(nullptr, sampling_result.attributes);
TraceIdRatioBasedSampler s4(0.50000000);
sampling_result = s4.ShouldSample(trace_api::SpanContext::GetInvalid(), valid_trace_id, "",
span_kind, view, links);
ASSERT_EQ(Decision::RECORD_AND_SAMPLE, sampling_result.decision);
ASSERT_EQ(nullptr, sampling_result.attributes);
}
TEST(TraceIdRatioBasedSampler, ShouldSampleWithContext)
{
uint8_t trace_id_buffer[trace_api::TraceId::kSize] = {1};
trace_api::TraceId trace_id{trace_id_buffer};
uint8_t span_id_buffer[trace_api::SpanId::kSize] = {1};
trace_api::SpanId span_id{span_id_buffer};
trace_api::SpanKind span_kind = trace_api::SpanKind::kInternal;
trace_api::SpanContext c1(trace_id, span_id, trace_api::TraceFlags{0}, false);
trace_api::SpanContext c2(trace_id, span_id, trace_api::TraceFlags{1}, false);
trace_api::SpanContext c3(trace_id, span_id, trace_api::TraceFlags{0}, true);
trace_api::SpanContext c4(trace_id, span_id, trace_api::TraceFlags{1}, true);
using M = std::map<std::string, int>;
M m1 = {{}};
using L = std::vector<std::pair<trace_api::SpanContext, std::map<std::string, std::string>>>;
L l1 = {{trace_api::SpanContext(false, false), {}}, {trace_api::SpanContext(false, false), {}}};
common::KeyValueIterableView<M> view{m1};
trace_api::SpanContextKeyValueIterableView<L> links{l1};
TraceIdRatioBasedSampler s1(0.01);
auto sampling_result = s1.ShouldSample(c1, trace_id, "", span_kind, view, links);
ASSERT_EQ(Decision::RECORD_AND_SAMPLE, sampling_result.decision);
ASSERT_EQ(nullptr, sampling_result.attributes);
sampling_result = s1.ShouldSample(c2, trace_id, "", span_kind, view, links);
ASSERT_EQ(Decision::RECORD_AND_SAMPLE, sampling_result.decision);
ASSERT_EQ(nullptr, sampling_result.attributes);
sampling_result = s1.ShouldSample(c3, trace_id, "", span_kind, view, links);
ASSERT_EQ(Decision::RECORD_AND_SAMPLE, sampling_result.decision);
ASSERT_EQ(nullptr, sampling_result.attributes);
sampling_result = s1.ShouldSample(c4, trace_id, "", span_kind, view, links);
ASSERT_EQ(Decision::RECORD_AND_SAMPLE, sampling_result.decision);
ASSERT_EQ(nullptr, sampling_result.attributes);
}
TEST(TraceIdRatioBasedSampler, TraceIdRatioBasedSamplerHalf)
{
double ratio = 0.5;
int iterations = 100000;
int expected_count = static_cast<int>(iterations * ratio);
int variance = static_cast<int>(iterations * 0.01);
trace_api::SpanContext c(true, true);
TraceIdRatioBasedSampler s(ratio);
int actual_count = RunShouldSampleCountDecision(c, s, iterations);
ASSERT_TRUE(actual_count < (expected_count + variance));
ASSERT_TRUE(actual_count > (expected_count - variance));
}
TEST(TraceIdRatioBasedSampler, TraceIdRatioBasedSamplerOnePercent)
{
double ratio = 0.01;
int iterations = 100000;
int expected_count = static_cast<int>(iterations * ratio);
int variance = static_cast<int>(iterations * 0.01);
trace_api::SpanContext c(true, true);
TraceIdRatioBasedSampler s(ratio);
int actual_count = RunShouldSampleCountDecision(c, s, iterations);
ASSERT_TRUE(actual_count < (expected_count + variance));
ASSERT_TRUE(actual_count > (expected_count - variance));
}
TEST(TraceIdRatioBasedSampler, TraceIdRatioBasedSamplerAll)
{
double ratio = 1.0;
int iterations = 100000;
int expected_count = static_cast<int>(iterations * ratio);
trace_api::SpanContext c(true, true);
TraceIdRatioBasedSampler s(ratio);
int actual_count = RunShouldSampleCountDecision(c, s, iterations);
ASSERT_EQ(actual_count, expected_count);
}
TEST(TraceIdRatioBasedSampler, TraceIdRatioBasedSamplerNone)
{
double ratio = 0.0;
int iterations = 100000;
int expected_count = static_cast<int>(iterations * ratio);
trace_api::SpanContext c(true, true);
TraceIdRatioBasedSampler s(ratio);
int actual_count = RunShouldSampleCountDecision(c, s, iterations);
ASSERT_EQ(actual_count, expected_count);
}
TEST(TraceIdRatioBasedSampler, GetDescription)
{
TraceIdRatioBasedSampler s1(0.01);
ASSERT_EQ("TraceIdRatioBasedSampler{0.010000}", s1.GetDescription());
TraceIdRatioBasedSampler s2(0.00);
ASSERT_EQ("TraceIdRatioBasedSampler{0.000000}", s2.GetDescription());
TraceIdRatioBasedSampler s3(1.00);
ASSERT_EQ("TraceIdRatioBasedSampler{1.000000}", s3.GetDescription());
TraceIdRatioBasedSampler s4(0.102030405);
ASSERT_EQ("TraceIdRatioBasedSampler{0.102030}", s4.GetDescription());
TraceIdRatioBasedSampler s5(3.00);
ASSERT_EQ("TraceIdRatioBasedSampler{1.000000}", s5.GetDescription());
TraceIdRatioBasedSampler s6(-3.00);
ASSERT_EQ("TraceIdRatioBasedSampler{0.000000}", s6.GetDescription());
TraceIdRatioBasedSampler s7(1.00000000001);
ASSERT_EQ("TraceIdRatioBasedSampler{1.000000}", s7.GetDescription());
TraceIdRatioBasedSampler s8(-1.00000000001);
ASSERT_EQ("TraceIdRatioBasedSampler{0.000000}", s8.GetDescription());
TraceIdRatioBasedSampler s9(0.50);
ASSERT_EQ("TraceIdRatioBasedSampler{0.500000}", s9.GetDescription());
}
|
