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
|
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0
#include "opentelemetry/sdk/trace/batch_span_processor.h"
#include "opentelemetry/sdk/trace/span_data.h"
#include "opentelemetry/sdk/trace/tracer.h"
#include <gtest/gtest.h>
#include <chrono>
#include <thread>
OPENTELEMETRY_BEGIN_NAMESPACE
/**
* Returns a mock span exporter meant exclusively for testing only
*/
class MockSpanExporter final : public sdk::trace::SpanExporter
{
public:
MockSpanExporter(
std::shared_ptr<std::vector<std::unique_ptr<sdk::trace::SpanData>>> spans_received,
std::shared_ptr<std::atomic<bool>> is_shutdown,
std::shared_ptr<std::atomic<bool>> is_export_completed =
std::shared_ptr<std::atomic<bool>>(new std::atomic<bool>(false)),
const std::chrono::milliseconds export_delay = std::chrono::milliseconds(0)) noexcept
: spans_received_(spans_received),
is_shutdown_(is_shutdown),
is_export_completed_(is_export_completed),
export_delay_(export_delay)
{}
std::unique_ptr<sdk::trace::Recordable> MakeRecordable() noexcept override
{
return std::unique_ptr<sdk::trace::Recordable>(new sdk::trace::SpanData);
}
sdk::common::ExportResult Export(
const nostd::span<std::unique_ptr<sdk::trace::Recordable>> &recordables) noexcept override
{
*is_export_completed_ = false;
std::this_thread::sleep_for(export_delay_);
for (auto &recordable : recordables)
{
auto span = std::unique_ptr<sdk::trace::SpanData>(
static_cast<sdk::trace::SpanData *>(recordable.release()));
if (span != nullptr)
{
spans_received_->push_back(std::move(span));
}
}
*is_export_completed_ = true;
return sdk::common::ExportResult::kSuccess;
}
bool Shutdown(
std::chrono::microseconds timeout = std::chrono::microseconds::max()) noexcept override
{
*is_shutdown_ = true;
return true;
}
bool IsExportCompleted() { return is_export_completed_->load(); }
private:
std::shared_ptr<std::vector<std::unique_ptr<sdk::trace::SpanData>>> spans_received_;
std::shared_ptr<std::atomic<bool>> is_shutdown_;
std::shared_ptr<std::atomic<bool>> is_export_completed_;
// Meant exclusively to test force flush timeout
const std::chrono::milliseconds export_delay_;
};
/**
* Fixture Class
*/
class BatchSpanProcessorTestPeer : public testing::Test
{
public:
std::unique_ptr<std::vector<std::unique_ptr<sdk::trace::Recordable>>> GetTestSpans(
std::shared_ptr<sdk::trace::SpanProcessor> processor,
const int num_spans)
{
std::unique_ptr<std::vector<std::unique_ptr<sdk::trace::Recordable>>> test_spans(
new std::vector<std::unique_ptr<sdk::trace::Recordable>>);
for (int i = 0; i < num_spans; ++i)
{
test_spans->push_back(processor->MakeRecordable());
static_cast<sdk::trace::SpanData *>(test_spans->at(i).get())
->SetName("Span " + std::to_string(i));
}
return test_spans;
}
};
/* ################################## TESTS ############################################ */
TEST_F(BatchSpanProcessorTestPeer, TestShutdown)
{
std::shared_ptr<std::atomic<bool>> is_shutdown(new std::atomic<bool>(false));
std::shared_ptr<std::vector<std::unique_ptr<sdk::trace::SpanData>>> spans_received(
new std::vector<std::unique_ptr<sdk::trace::SpanData>>);
auto batch_processor =
std::shared_ptr<sdk::trace::BatchSpanProcessor>(new sdk::trace::BatchSpanProcessor(
std::unique_ptr<MockSpanExporter>(new MockSpanExporter(spans_received, is_shutdown)),
sdk::trace::BatchSpanProcessorOptions()));
const int num_spans = 3;
auto test_spans = GetTestSpans(batch_processor, num_spans);
for (int i = 0; i < num_spans; ++i)
{
batch_processor->OnEnd(std::move(test_spans->at(i)));
}
EXPECT_TRUE(batch_processor->Shutdown());
// It's safe to shutdown again
EXPECT_TRUE(batch_processor->Shutdown());
EXPECT_EQ(num_spans, spans_received->size());
for (int i = 0; i < num_spans; ++i)
{
EXPECT_EQ("Span " + std::to_string(i), spans_received->at(i)->GetName());
}
EXPECT_TRUE(is_shutdown->load());
}
TEST_F(BatchSpanProcessorTestPeer, TestForceFlush)
{
std::shared_ptr<std::atomic<bool>> is_shutdown(new std::atomic<bool>(false));
std::shared_ptr<std::vector<std::unique_ptr<sdk::trace::SpanData>>> spans_received(
new std::vector<std::unique_ptr<sdk::trace::SpanData>>);
auto batch_processor =
std::shared_ptr<sdk::trace::BatchSpanProcessor>(new sdk::trace::BatchSpanProcessor(
std::unique_ptr<MockSpanExporter>(new MockSpanExporter(spans_received, is_shutdown)),
sdk::trace::BatchSpanProcessorOptions()));
const int num_spans = 2048;
auto test_spans = GetTestSpans(batch_processor, num_spans);
for (int i = 0; i < num_spans; ++i)
{
batch_processor->OnEnd(std::move(test_spans->at(i)));
}
// Give some time to export
std::this_thread::sleep_for(std::chrono::milliseconds(50));
EXPECT_TRUE(batch_processor->ForceFlush());
EXPECT_EQ(num_spans, spans_received->size());
for (int i = 0; i < num_spans; ++i)
{
EXPECT_EQ("Span " + std::to_string(i), spans_received->at(i)->GetName());
}
// Create some more spans to make sure that the processor still works
auto more_test_spans = GetTestSpans(batch_processor, num_spans);
for (int i = 0; i < num_spans; ++i)
{
batch_processor->OnEnd(std::move(more_test_spans->at(i)));
}
// Give some time to export the spans
std::this_thread::sleep_for(std::chrono::milliseconds(50));
EXPECT_TRUE(batch_processor->ForceFlush());
EXPECT_EQ(num_spans * 2, spans_received->size());
for (int i = 0; i < num_spans; ++i)
{
EXPECT_EQ("Span " + std::to_string(i % num_spans),
spans_received->at(num_spans + i)->GetName());
}
}
TEST_F(BatchSpanProcessorTestPeer, TestManySpansLoss)
{
/* Test that when exporting more than max_queue_size spans, some are most likely lost*/
std::shared_ptr<std::atomic<bool>> is_shutdown(new std::atomic<bool>(false));
std::shared_ptr<std::vector<std::unique_ptr<sdk::trace::SpanData>>> spans_received(
new std::vector<std::unique_ptr<sdk::trace::SpanData>>);
const int max_queue_size = 4096;
auto batch_processor =
std::shared_ptr<sdk::trace::BatchSpanProcessor>(new sdk::trace::BatchSpanProcessor(
std::unique_ptr<MockSpanExporter>(new MockSpanExporter(spans_received, is_shutdown)),
sdk::trace::BatchSpanProcessorOptions()));
auto test_spans = GetTestSpans(batch_processor, max_queue_size);
for (int i = 0; i < max_queue_size; ++i)
{
batch_processor->OnEnd(std::move(test_spans->at(i)));
}
// Give some time to export the spans
std::this_thread::sleep_for(std::chrono::milliseconds(700));
EXPECT_TRUE(batch_processor->ForceFlush());
// Span should be exported by now
EXPECT_GE(max_queue_size, spans_received->size());
}
TEST_F(BatchSpanProcessorTestPeer, TestManySpansLossLess)
{
/* Test that no spans are lost when sending max_queue_size spans */
std::shared_ptr<std::atomic<bool>> is_shutdown(new std::atomic<bool>(false));
std::shared_ptr<std::vector<std::unique_ptr<sdk::trace::SpanData>>> spans_received(
new std::vector<std::unique_ptr<sdk::trace::SpanData>>);
const int num_spans = 2048;
auto batch_processor =
std::shared_ptr<sdk::trace::BatchSpanProcessor>(new sdk::trace::BatchSpanProcessor(
std::unique_ptr<MockSpanExporter>(new MockSpanExporter(spans_received, is_shutdown)),
sdk::trace::BatchSpanProcessorOptions()));
auto test_spans = GetTestSpans(batch_processor, num_spans);
for (int i = 0; i < num_spans; ++i)
{
batch_processor->OnEnd(std::move(test_spans->at(i)));
}
// Give some time to export the spans
std::this_thread::sleep_for(std::chrono::milliseconds(50));
EXPECT_TRUE(batch_processor->ForceFlush());
EXPECT_EQ(num_spans, spans_received->size());
for (int i = 0; i < num_spans; ++i)
{
EXPECT_EQ("Span " + std::to_string(i), spans_received->at(i)->GetName());
}
}
TEST_F(BatchSpanProcessorTestPeer, TestScheduleDelayMillis)
{
/* Test that max_export_batch_size spans are exported every schedule_delay_millis
seconds */
std::shared_ptr<std::atomic<bool>> is_shutdown(new std::atomic<bool>(false));
std::shared_ptr<std::atomic<bool>> is_export_completed(new std::atomic<bool>(false));
std::shared_ptr<std::vector<std::unique_ptr<sdk::trace::SpanData>>> spans_received(
new std::vector<std::unique_ptr<sdk::trace::SpanData>>);
const std::chrono::milliseconds export_delay(0);
const size_t max_export_batch_size = 512;
sdk::trace::BatchSpanProcessorOptions options{};
options.schedule_delay_millis = std::chrono::milliseconds(2000);
auto batch_processor =
std::shared_ptr<sdk::trace::BatchSpanProcessor>(new sdk::trace::BatchSpanProcessor(
std::unique_ptr<MockSpanExporter>(
new MockSpanExporter(spans_received, is_shutdown, is_export_completed, export_delay)),
options));
auto test_spans = GetTestSpans(batch_processor, max_export_batch_size);
for (size_t i = 0; i < max_export_batch_size; ++i)
{
batch_processor->OnEnd(std::move(test_spans->at(i)));
}
// Sleep for schedule_delay_millis milliseconds
std::this_thread::sleep_for(options.schedule_delay_millis);
// small delay to give time to export
std::this_thread::sleep_for(std::chrono::milliseconds(50));
// Spans should be exported by now
EXPECT_TRUE(is_export_completed->load());
EXPECT_EQ(max_export_batch_size, spans_received->size());
for (size_t i = 0; i < max_export_batch_size; ++i)
{
EXPECT_EQ("Span " + std::to_string(i), spans_received->at(i)->GetName());
}
}
OPENTELEMETRY_END_NAMESPACE
|
