forked from open-telemetry/opentelemetry-java
-
Notifications
You must be signed in to change notification settings - Fork 1
/
SpanShimTest.java
279 lines (235 loc) · 9.62 KB
/
SpanShimTest.java
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
/*
* Copyright The OpenTelemetry Authors
* SPDX-License-Identifier: Apache-2.0
*/
package io.opentelemetry.opentracingshim;
import static io.opentelemetry.opentracingshim.TestUtils.getBaggageMap;
import static org.assertj.core.api.Assertions.assertThat;
import io.opentelemetry.api.common.AttributeKey;
import io.opentelemetry.api.trace.Span;
import io.opentelemetry.api.trace.Tracer;
import io.opentelemetry.sdk.trace.ReadableSpan;
import io.opentelemetry.sdk.trace.SdkTracerProvider;
import io.opentelemetry.sdk.trace.data.EventData;
import io.opentelemetry.sdk.trace.data.SpanData;
import io.opentelemetry.semconv.trace.attributes.SemanticAttributes;
import io.opentracing.log.Fields;
import java.math.BigInteger;
import java.util.HashMap;
import java.util.Map;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.TimeUnit;
import java.util.stream.IntStream;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
class SpanShimTest {
private final SdkTracerProvider tracerSdkFactory = SdkTracerProvider.builder().build();
private final Tracer tracer = tracerSdkFactory.get("SpanShimTest");
private final TelemetryInfo telemetryInfo =
new TelemetryInfo(tracer, OpenTracingPropagators.builder().build());
private Span span;
private static final String SPAN_NAME = "Span";
@BeforeEach
void setUp() {
span = telemetryInfo.tracer().spanBuilder(SPAN_NAME).startSpan();
}
@AfterEach
void tearDown() {
span.end();
}
@Test
void context_simple() {
SpanShim spanShim = new SpanShim(telemetryInfo, span);
SpanContextShim contextShim = (SpanContextShim) spanShim.context();
assertThat(contextShim).isNotNull();
assertThat(span.getSpanContext()).isEqualTo(contextShim.getSpanContext());
assertThat(span.getSpanContext().getTraceId().toString()).isEqualTo(contextShim.toTraceId());
assertThat(span.getSpanContext().getSpanId().toString()).isEqualTo(contextShim.toSpanId());
assertThat(contextShim.baggageItems().iterator().hasNext()).isFalse();
}
@Test
void setAttribute_unrecognizedType() {
SpanShim spanShim = new SpanShim(telemetryInfo, span);
spanShim.setTag("foo", BigInteger.ONE);
SpanData spanData = ((ReadableSpan) span).toSpanData();
assertThat(spanData.getAttributes().size()).isEqualTo(1);
assertThat(spanData.getAttributes().get(AttributeKey.stringKey("foo"))).isEqualTo("1");
}
@Test
void baggage() {
SpanShim spanShim = new SpanShim(telemetryInfo, span);
spanShim.setBaggageItem("key1", "value1");
spanShim.setBaggageItem("key2", "value2");
assertThat("value1").isEqualTo(spanShim.getBaggageItem("key1"));
assertThat("value2").isEqualTo(spanShim.getBaggageItem("key2"));
SpanContextShim contextShim = (SpanContextShim) spanShim.context();
assertThat(contextShim).isNotNull();
Map<String, String> baggageMap = getBaggageMap(contextShim.baggageItems());
assertThat(baggageMap.size()).isEqualTo(2);
assertThat("value1").isEqualTo(baggageMap.get("key1"));
assertThat("value2").isEqualTo(baggageMap.get("key2"));
}
@Test
void baggage_replacement() {
SpanShim spanShim = new SpanShim(telemetryInfo, span);
SpanContextShim contextShim1 = (SpanContextShim) spanShim.context();
spanShim.setBaggageItem("key1", "value1");
SpanContextShim contextShim2 = (SpanContextShim) spanShim.context();
assertThat(contextShim2).isNotEqualTo(contextShim1);
assertThat(contextShim1.baggageItems().iterator().hasNext()).isFalse(); /* original, empty */
assertThat(contextShim2.baggageItems().iterator()).hasNext(); /* updated, with values */
}
@SuppressWarnings("FutureReturnValueIgnored")
@Test
void baggage_multipleThreads() throws Exception {
ExecutorService executor = Executors.newCachedThreadPool();
SpanShim spanShim = new SpanShim(telemetryInfo, span);
int baggageItemsCount = 100;
IntStream.range(0, baggageItemsCount)
.forEach(i -> executor.execute(() -> spanShim.setBaggageItem("key-" + i, "value-" + i)));
executor.shutdown();
executor.awaitTermination(5, TimeUnit.SECONDS);
for (int i = 0; i < baggageItemsCount; i++) {
assertThat(spanShim.getBaggageItem("key-" + i)).isEqualTo("value-" + i);
}
}
@Test
void finish_micros() {
SpanShim spanShim = new SpanShim(telemetryInfo, span);
long micros = 123447307984L;
spanShim.finish(micros);
SpanData spanData = ((ReadableSpan) span).toSpanData();
assertThat(spanData.getEndEpochNanos()).isEqualTo(micros * 1000L);
}
@Test
public void log_error() {
SpanShim spanShim = new SpanShim(telemetryInfo, span);
Map<String, Object> fields = createErrorFields();
spanShim.log(fields);
SpanData spanData = ((ReadableSpan) span).toSpanData();
verifyErrorEvent(spanData);
}
@Test
public void log_error_with_timestamp() {
SpanShim spanShim = new SpanShim(telemetryInfo, span);
Map<String, Object> fields = createErrorFields();
long micros = 123447307984L;
spanShim.log(micros, fields);
SpanData spanData = ((ReadableSpan) span).toSpanData();
verifyErrorEvent(spanData);
}
@Test
public void log_exception() {
SpanShim spanShim = new SpanShim(telemetryInfo, span);
Map<String, Object> fields = createExceptionFields();
spanShim.log(fields);
SpanData spanData = ((ReadableSpan) span).toSpanData();
assertThat(spanData.getEvents()).hasSize(1);
verifyExceptionEvent(spanData);
}
@Test
public void log_error_with_exception() {
SpanShim spanShim = new SpanShim(telemetryInfo, span);
Map<String, Object> fields = createExceptionFields();
fields.putAll(createErrorFields());
long micros = 123447307984L;
spanShim.log(micros, fields);
SpanData spanData = ((ReadableSpan) span).toSpanData();
verifyErrorEvent(spanData);
}
@Test
public void log_exception_with_timestamp() {
SpanShim spanShim = new SpanShim(telemetryInfo, span);
Map<String, Object> fields = createExceptionFields();
long micros = 123447307984L;
spanShim.log(micros, fields);
SpanData spanData = ((ReadableSpan) span).toSpanData();
verifyExceptionEvent(spanData);
assertThat(spanData.getEvents().get(0).getEpochNanos()).isEqualTo(micros * 1000L);
}
@Test
public void log_fields() {
SpanShim spanShim = new SpanShim(telemetryInfo, span);
spanShim.log(putKeyValuePairsToMap(new HashMap<>()));
SpanData spanData = ((ReadableSpan) span).toSpanData();
verifyAttributes(spanData.getEvents().get(0));
}
@Test
void log_micros() {
SpanShim spanShim = new SpanShim(telemetryInfo, span);
long micros = 123447307984L;
spanShim.log(micros, "event");
SpanData spanData = ((ReadableSpan) span).toSpanData();
assertThat(spanData.getEvents().get(0).getEpochNanos()).isEqualTo(micros * 1000L);
}
@Test
void log_fields_micros() {
SpanShim spanShim = new SpanShim(telemetryInfo, span);
long micros = 123447307984L;
spanShim.log(micros, putKeyValuePairsToMap(new HashMap<>()));
SpanData spanData = ((ReadableSpan) span).toSpanData();
EventData eventData = spanData.getEvents().get(0);
assertThat(eventData.getEpochNanos()).isEqualTo(micros * 1000L);
verifyAttributes(eventData);
}
private static Map<String, Object> createErrorFields() {
Map<String, Object> fields = new HashMap<>();
fields.put(Fields.EVENT, "error");
fields.put(Fields.ERROR_OBJECT, new RuntimeException());
putKeyValuePairsToMap(fields);
return fields;
}
private static void verifyErrorEvent(SpanData spanData) {
assertThat(spanData.getEvents()).hasSize(1);
EventData eventData = spanData.getEvents().get(0);
assertThat(eventData.getName()).isEqualTo("exception");
verifyAttributes(eventData);
}
private static Map<String, Object> createExceptionFields() {
Map<String, Object> fields = new HashMap<>();
fields.put(Fields.EVENT, "error");
fields.put(Fields.ERROR_KIND, "kind");
fields.put(Fields.MESSAGE, "message");
fields.put(Fields.STACK, "stack");
putKeyValuePairsToMap(fields);
return fields;
}
private static Map<String, Object> putKeyValuePairsToMap(Map<String, Object> fields) {
fields.put("keyForString", "value");
fields.put("keyForInt", 1);
fields.put("keyForDouble", 1.0);
fields.put("keyForBoolean", true);
return fields;
}
private static void verifyExceptionEvent(SpanData spanData) {
assertThat(spanData.getEvents()).hasSize(1);
EventData eventData = spanData.getEvents().get(0);
assertThat(eventData.getName()).isEqualTo("exception");
assertThat(
eventData
.getAttributes()
.get(AttributeKey.stringKey(SemanticAttributes.EXCEPTION_TYPE.getKey())))
.isEqualTo("kind");
assertThat(
eventData
.getAttributes()
.get(AttributeKey.stringKey(SemanticAttributes.EXCEPTION_MESSAGE.getKey())))
.isEqualTo("message");
assertThat(
eventData
.getAttributes()
.get(AttributeKey.stringKey(SemanticAttributes.EXCEPTION_STACKTRACE.getKey())))
.isEqualTo("stack");
verifyAttributes(eventData);
}
private static void verifyAttributes(EventData eventData) {
assertThat(eventData.getAttributes().get(AttributeKey.stringKey("keyForString")))
.isEqualTo("value");
assertThat(eventData.getAttributes().get(AttributeKey.longKey("keyForInt"))).isEqualTo(1);
assertThat(eventData.getAttributes().get(AttributeKey.doubleKey("keyForDouble")))
.isEqualTo(1.0);
assertThat(eventData.getAttributes().get(AttributeKey.booleanKey("keyForBoolean"))).isTrue();
}
}