forked from lightstep/lightstep-tracer-go
-
Notifications
You must be signed in to change notification settings - Fork 0
/
tracer_transport_test.go
533 lines (444 loc) · 16.8 KB
/
tracer_transport_test.go
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
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
package lightstep_test
import (
"bytes"
"encoding/json"
"io"
"strconv"
"strings"
"time"
"github.com/lightstep/lightstep-tracer-common/golang/gogo/collectorpb"
. "github.com/lightstep/lightstep-tracer-go"
. "github.com/onsi/ginkgo"
. "github.com/onsi/gomega"
"github.com/opentracing/opentracing-go"
"github.com/opentracing/opentracing-go/log"
)
// Interfaces
type Reference interface {
GetSpanContext() SpanContext
}
type Span interface {
GetOperationName() string
GetSpanContext() SpanContext
GetTags() interface{}
GetReferences() interface{}
GetReference(i int) Reference
GetLogs() []interface{}
}
type fakeCollectorClient interface {
ConnectorFactory() ConnectorFactory
ReportCallCount() int
GetSpansLen() int
GetSpan(i int) Span
}
// Describe Test
var _ = Describe("Tracer Transports", func() {
var options *Options
var tracer opentracing.Tracer
var fakeClient fakeCollectorClient
const port = 9090
BeforeEach(func() {
options = &Options{}
})
JustBeforeEach(func() {
options.ConnFactory = fakeClient.ConnectorFactory()
tracer = NewTracer(*options)
// make sure the fake client is working
Eventually(fakeClient.ReportCallCount).ShouldNot(BeZero())
})
AfterEach(func() {
closeTestTracer(tracer)
})
ItShouldBehaveLikeATracer := func(tracerTestOptions ...testOption) {
testOptions := toTestOptions(tracerTestOptions)
Context("with default options", func() {
BeforeEach(func() {
options.AccessToken = "0987654321"
options.Collector = Endpoint{Host: "localhost", Port: port, Plaintext: true}
options.ReportingPeriod = 1 * time.Millisecond
options.MinReportingPeriod = 1 * time.Millisecond
options.ReportTimeout = 10 * time.Millisecond
})
It("Should record baggage info internally", func() {
span := tracer.StartSpan("x")
span.SetBaggageItem("x", "y")
Expect(span.BaggageItem("x")).To(Equal("y"))
})
It("Should send span operation names to the collector", func() {
tracer.StartSpan("smooth").Finish()
Eventually(fakeClient.GetSpansLen).Should(Equal(1))
Expect(fakeClient.GetSpan(0).GetOperationName()).To(Equal("smooth"))
})
It("Should send tags back to the collector", func() {
span := tracer.StartSpan("brokay doogle")
span.SetTag("tag", "you're it!")
span.Finish()
Eventually(fakeClient.GetSpansLen).Should(Equal(1))
Expect(fakeClient.GetSpan(0).GetTags()).To(HaveKeyValues(KeyValue("tag", "you're it!")))
})
if testOptions.supportsBaggage {
It("Should send baggage info to the collector", func() {
span := tracer.StartSpan("x")
span.SetBaggageItem("x", "y")
span.Finish()
Eventually(fakeClient.GetSpansLen).Should(Equal(1))
Expect(fakeClient.GetSpan(0).GetSpanContext().Baggage).To(BeEquivalentTo(map[string]string{"x": "y"}))
})
It("ForeachBaggageItem", func() {
span := tracer.StartSpan("x")
span.SetBaggageItem("x", "y")
baggage := map[string]string{}
span.Context().ForeachBaggageItem(func(k, v string) bool {
baggage[k] = v
return true
})
Expect(baggage).To(BeEquivalentTo(map[string]string{"x": "y"}))
span.SetBaggageItem("a", "b")
baggage = map[string]string{}
span.Context().ForeachBaggageItem(func(k, v string) bool {
baggage[k] = v
return false // exit early
})
Expect(baggage).To(HaveLen(1))
span.Finish()
Eventually(fakeClient.GetSpansLen).Should(Equal(1))
Expect(fakeClient.GetSpan(0).GetSpanContext().Baggage).To(HaveLen(2))
})
}
Describe("CloseTracer", func() {
It("Should not explode when called twice", func() {
closeTestTracer(tracer)
closeTestTracer(tracer)
})
It("Should behave nicely", func() {
By("Not hanging")
closeTestTracer(tracer)
By("Stop communication with server")
lastCallCount := fakeClient.ReportCallCount()
Consistently(fakeClient.ReportCallCount, 0.5, 0.05).Should(Equal(lastCallCount))
By("Allowing other tracers to reconnect to the server")
tracer = NewTracer(*options)
Eventually(fakeClient.ReportCallCount).ShouldNot(Equal(lastCallCount))
})
})
Describe("Options", func() {
const expectedTraceID uint64 = 1
const expectedSpanID uint64 = 2
const expectedParentSpanID uint64 = 3
Context("when the TraceID is set", func() {
JustBeforeEach(func() {
tracer.StartSpan("x", SetTraceID(expectedTraceID)).Finish()
})
It("should set the specified options", func() {
Eventually(fakeClient.GetSpansLen).Should(Equal(1))
Expect(fakeClient.GetSpan(0).GetSpanContext().TraceID).To(Equal(expectedTraceID))
Expect(fakeClient.GetSpan(0).GetSpanContext().SpanID).ToNot(Equal(uint64(0)))
if testOptions.supportsReference {
Expect(fakeClient.GetSpan(0).GetReferences()).To(BeEmpty())
}
})
})
Context("when both the TraceID and SpanID are set", func() {
JustBeforeEach(func() {
tracer.StartSpan("x", SetTraceID(expectedTraceID), SetSpanID(expectedSpanID)).Finish()
})
It("Should set the specified options", func() {
Eventually(fakeClient.GetSpansLen).Should(Equal(1))
Expect(fakeClient.GetSpan(0).GetSpanContext().TraceID).To(Equal(expectedTraceID))
Expect(fakeClient.GetSpan(0).GetSpanContext().SpanID).To(Equal(expectedSpanID))
if testOptions.supportsReference {
Expect(fakeClient.GetSpan(0).GetReferences()).To(BeEmpty())
}
})
})
Context("when TraceID, SpanID, and ParentSpanID are set", func() {
JustBeforeEach(func() {
tracer.StartSpan("x", SetTraceID(expectedTraceID), SetSpanID(expectedSpanID), SetParentSpanID(expectedParentSpanID)).Finish()
})
It("Should set the specified options", func() {
Eventually(fakeClient.GetSpansLen).Should(Equal(1))
Expect(fakeClient.GetSpan(0).GetSpanContext().TraceID).To(Equal(expectedTraceID))
Expect(fakeClient.GetSpan(0).GetSpanContext().SpanID).To(Equal(expectedSpanID))
if testOptions.supportsReference {
Expect(fakeClient.GetSpan(0).GetReferences()).ToNot(BeEmpty())
Expect(fakeClient.GetSpan(0).GetReference(0).GetSpanContext().SpanID).To(Equal(expectedParentSpanID))
}
})
})
})
Describe("Binary Carriers", func() {
const knownCarrier1 = "EigJOjioEaYHBgcRNmifUO7/xlgYASISCgdjaGVja2VkEgdiYWdnYWdl"
const knownCarrier2 = "EigJEX+FpwZ/EmYR2gfYQbxCMskYASISCgdjaGVja2VkEgdiYWdnYWdl"
const badCarrier1 = "Y3QbxCMskYASISCgdjaGVja2VkEgd"
var knownContext1 = SpanContext{
SpanID: 6397081719746291766,
TraceID: 506100417967962170,
Baggage: map[string]string{"checked": "baggage"},
}
var knownContext2 = SpanContext{
SpanID: 14497723526785009626,
TraceID: 7355080808006516497,
Baggage: map[string]string{"checked": "baggage"},
}
var testContext1 = SpanContext{
SpanID: 123,
TraceID: 456,
Baggage: nil,
}
var testContext2 = SpanContext{
SpanID: 123000000000,
TraceID: 456000000000,
Baggage: map[string]string{"a": "1", "b": "2", "c": "3"},
}
Context("tracer inject", func() {
var carrierString string
var carrierBytes []byte
BeforeEach(func() {
carrierString = ""
carrierBytes = []byte{}
})
It("Should support injecting into strings ", func() {
for _, origContext := range []SpanContext{knownContext1, knownContext2, testContext1, testContext2} {
err := tracer.Inject(origContext, opentracing.Binary, &carrierString)
Expect(err).ToNot(HaveOccurred())
context, err := tracer.Extract(opentracing.Binary, carrierString)
Expect(err).ToNot(HaveOccurred())
Expect(context).To(BeEquivalentTo(origContext))
}
})
It("Should support injecting into byte arrays", func() {
for _, origContext := range []SpanContext{knownContext1, knownContext2, testContext1, testContext2} {
err := tracer.Inject(origContext, opentracing.Binary, &carrierBytes)
Expect(err).ToNot(HaveOccurred())
context, err := tracer.Extract(opentracing.Binary, carrierBytes)
Expect(err).ToNot(HaveOccurred())
Expect(context).To(BeEquivalentTo(origContext))
}
})
It("Should support injecting into io.Writer", func() {
for _, origContext := range []SpanContext{knownContext1, knownContext2, testContext1, testContext2} {
buf := bytes.NewBuffer(nil)
err := tracer.Inject(origContext, opentracing.Binary, io.Writer(buf))
Expect(err).ToNot(HaveOccurred())
context, err := tracer.Extract(opentracing.Binary, io.Reader(buf))
Expect(err).ToNot(HaveOccurred())
Expect(context).To(BeEquivalentTo(origContext))
}
})
It("Should return nil for nil contexts", func() {
err := tracer.Inject(nil, opentracing.Binary, carrierString)
Expect(err).To(HaveOccurred())
err = tracer.Inject(nil, opentracing.Binary, carrierBytes)
Expect(err).To(HaveOccurred())
})
})
Context("tracer extract", func() {
It("Should extract SpanContext from carrier as string", func() {
context, err := tracer.Extract(opentracing.Binary, knownCarrier1)
Expect(context).To(BeEquivalentTo(knownContext1))
Expect(err).To(BeNil())
context, err = tracer.Extract(opentracing.Binary, knownCarrier2)
Expect(context).To(BeEquivalentTo(knownContext2))
Expect(err).To(BeNil())
})
It("Should extract SpanContext from carrier as []byte", func() {
context, err := tracer.Extract(opentracing.Binary, []byte(knownCarrier1))
Expect(context).To(BeEquivalentTo(knownContext1))
Expect(err).To(BeNil())
context, err = tracer.Extract(opentracing.Binary, []byte(knownCarrier2))
Expect(context).To(BeEquivalentTo(knownContext2))
Expect(err).To(BeNil())
})
It("Should extract SpanContext from carrier as io.Reader", func() {
buf := bytes.NewBuffer([]byte(knownCarrier1))
context, err := tracer.Extract(opentracing.Binary, io.Reader(buf))
Expect(context).To(BeEquivalentTo(knownContext1))
Expect(err).To(BeNil())
buf = bytes.NewBuffer([]byte(knownCarrier2))
context, err = tracer.Extract(opentracing.Binary, io.Reader(buf))
Expect(context).To(BeEquivalentTo(knownContext2))
Expect(err).To(BeNil())
})
It("Should return nil for bad carriers", func() {
for _, carrier := range []interface{}{badCarrier1, []byte(badCarrier1), "", []byte(nil)} {
context, err := tracer.Extract(opentracing.Binary, carrier)
Expect(context).To(BeNil())
Expect(err).To(HaveOccurred())
}
})
})
})
})
Context("With custom log length", func() {
BeforeEach(func() {
options.AccessToken = "0987654321"
options.Collector = Endpoint{Host: "localhost", Port: port, Plaintext: true}
options.ReportingPeriod = 1 * time.Millisecond
options.MinReportingPeriod = 1 * time.Millisecond
options.ReportTimeout = 10 * time.Millisecond
options.MaxLogKeyLen = 10
options.MaxLogValueLen = 11
})
Describe("Logging", func() {
JustBeforeEach(func() {
span := tracer.StartSpan("spantastic")
span.LogFields(
log.String("donut", "bacon"),
log.Object("key", []interface{}{"gr", 8}),
log.String("donut army"+strings.Repeat("O", 50), strings.Repeat("O", 110)),
log.Int("life", 42),
)
span.Finish()
})
It("Should send logs back to the collector", func() {
Eventually(fakeClient.GetSpansLen).Should(Equal(1))
obj, _ := json.Marshal([]interface{}{"gr", 8})
expectedKeyValues := []*collectorpb.KeyValue{KeyValue("donut", "bacon")}
if testOptions.supportsTypedValues {
expectedKeyValues = append(expectedKeyValues,
KeyValue("key", string(obj), true),
KeyValue("donut arm…", "OOOOOOOOOO…"),
KeyValue("life", 42),
)
} else {
expectedKeyValues = append(expectedKeyValues,
KeyValue("key", string(obj)),
KeyValue("donut arm…", "OOOOOOOOOO…"),
KeyValue("life", "42"),
)
}
Expect(fakeClient.GetSpan(0).GetLogs()).To(HaveLen(1))
Expect(fakeClient.GetSpan(0).GetLogs()[0]).To(HaveKeyValues(expectedKeyValues...))
})
})
})
Context("With custom MaxBufferedSpans", func() {
BeforeEach(func() {
options.AccessToken = "0987654321"
options.Collector = Endpoint{Host: "localhost", Port: port, Plaintext: true}
options.ReportingPeriod = 1 * time.Millisecond
options.MinReportingPeriod = 1 * time.Millisecond
options.ReportTimeout = 10 * time.Millisecond
options.MaxLogKeyLen = 10
options.MaxLogValueLen = 11
options.MaxBufferedSpans = 10
})
Describe("SpanBuffer", func() {
It("should respect MaxBufferedSpans", func() {
startNSpans(10, tracer)
Eventually(fakeClient.GetSpansLen).Should(Equal(10))
startNSpans(10, tracer)
Eventually(fakeClient.GetSpansLen).Should(Equal(10))
})
})
})
Context("With DropSpanLogs set", func() {
BeforeEach(func() {
options.AccessToken = "0987654321"
options.Collector = Endpoint{Host: "localhost", Port: port, Plaintext: true}
options.ReportingPeriod = 1 * time.Millisecond
options.MinReportingPeriod = 1 * time.Millisecond
options.ReportTimeout = 10 * time.Millisecond
options.DropSpanLogs = true
})
It("Should not record logs", func() {
span := tracer.StartSpan("x")
span.LogFields(log.String("Led", "Zeppelin"), log.Uint32("32bit", 4294967295))
span.SetTag("tag", "value")
span.Finish()
Eventually(fakeClient.GetSpansLen).Should(Equal(1))
Expect(fakeClient.GetSpan(0).GetOperationName()).To(Equal("x"))
Expect(fakeClient.GetSpan(0).GetTags()).To(HaveKeyValues(KeyValue("tag", "value")))
Expect(fakeClient.GetSpan(0).GetLogs()).To(BeEmpty())
})
})
Context("With MaxLogsPerSpan set", func() {
BeforeEach(func() {
options.AccessToken = "0987654321"
options.Collector = Endpoint{Host: "localhost", Port: port, Plaintext: true}
options.ReportingPeriod = 1 * time.Millisecond
options.MinReportingPeriod = 1 * time.Millisecond
options.ReportTimeout = 10 * time.Millisecond
options.MaxLogsPerSpan = 10
})
It("keeps all logs if they don't exceed MaxLogsPerSpan", func() {
const logCount = 10
span := tracer.StartSpan("span")
for i := 0; i < logCount; i++ {
span.LogKV("id", i)
}
span.Finish()
Eventually(fakeClient.GetSpansLen).Should(Equal(1))
Expect(fakeClient.GetSpan(0).GetOperationName()).To(Equal("span"))
Expect(fakeClient.GetSpan(0).GetLogs()).To(HaveLen(10))
for i, log := range fakeClient.GetSpan(0).GetLogs() {
if testOptions.supportsTypedValues {
Expect(log).To(HaveKeyValues(KeyValue("id", i)))
} else {
Expect(log).To(HaveKeyValues(KeyValue("id", strconv.FormatInt(int64(i), 10))))
}
}
})
It("throws away the middle logs when they exceed MaxLogsPerSpan", func() {
const logCount = 50
span := tracer.StartSpan("span")
for i := 0; i < logCount; i++ {
span.LogKV("id", i)
}
span.Finish()
Eventually(fakeClient.GetSpansLen).Should(Equal(1))
Expect(fakeClient.GetSpan(0).GetOperationName()).To(Equal("span"))
Expect(fakeClient.GetSpan(0).GetLogs()).To(HaveLen(10))
split := (len(fakeClient.GetSpan(0).GetLogs()) - 1) / 2
firstLogs := fakeClient.GetSpan(0).GetLogs()[:split]
for i, log := range firstLogs {
if testOptions.supportsTypedValues {
Expect(log).To(HaveKeyValues(KeyValue("id", i)))
} else {
Expect(log).To(HaveKeyValues(KeyValue("id", strconv.FormatInt(int64(i), 10))))
}
}
warnLog := fakeClient.GetSpan(0).GetLogs()[split]
expectedKeyValues := []*collectorpb.KeyValue{
KeyValue("event", "dropped Span logs"),
}
if testOptions.supportsTypedValues {
expectedKeyValues = append(expectedKeyValues,
KeyValue("dropped_log_count", logCount-len(fakeClient.GetSpan(0).GetLogs())+1),
)
} else {
expectedKeyValues = append(expectedKeyValues,
KeyValue("dropped_log_count", strconv.FormatInt(int64(logCount-len(fakeClient.GetSpan(0).GetLogs())+1), 10)),
)
}
expectedKeyValues = append(expectedKeyValues, KeyValue("component", "basictracer"))
Expect(warnLog).To(HaveKeyValues(expectedKeyValues...))
lastLogs := fakeClient.GetSpan(0).GetLogs()[split+1:]
for i, log := range lastLogs {
if testOptions.supportsTypedValues {
Expect(log).To(HaveKeyValues(KeyValue("id", logCount-len(lastLogs)+i)))
} else {
Expect(log).To(HaveKeyValues(KeyValue("id", strconv.FormatInt(int64(logCount-len(lastLogs)+i), 10))))
}
}
})
})
}
Context("with http enabled", func() {
BeforeEach(func() {
options.UseHttp = true
})
// TODO(dolan) - Add http tests.
})
Context("with grpc enabled", func() {
BeforeEach(func() {
options.UseGRPC = true
fakeClient = newGrpcFakeClient()
})
ItShouldBehaveLikeATracer(
thatSupportsBaggage(),
thatSupportsReference(),
thatSupportsTypedValues(),
)
})
})