/
Tracer.java
445 lines (371 loc) · 16.1 KB
/
Tracer.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
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
/*
* Copyright 2018 Expedia, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
package com.expedia.www.haystack.client;
import com.expedia.www.haystack.client.dispatchers.Dispatcher;
import com.expedia.www.haystack.client.idgenerators.IdGenerator;
import com.expedia.www.haystack.client.idgenerators.LongIdGenerator;
import com.expedia.www.haystack.client.metrics.*;
import com.expedia.www.haystack.client.metrics.Timer;
import com.expedia.www.haystack.client.metrics.Timer.Sample;
import com.expedia.www.haystack.client.propagation.Extractor;
import com.expedia.www.haystack.client.propagation.Injector;
import com.expedia.www.haystack.client.propagation.PropagationRegistry;
import com.expedia.www.haystack.client.propagation.TextMapPropagator;
import io.opentracing.References;
import io.opentracing.Scope;
import io.opentracing.ScopeManager;
import io.opentracing.Span;
import io.opentracing.propagation.Format;
import io.opentracing.propagation.TextMap;
import io.opentracing.tag.Tags;
import io.opentracing.util.ThreadLocalScopeManager;
import org.apache.commons.lang3.builder.ReflectionToStringBuilder;
import org.apache.commons.lang3.builder.ToStringStyle;
import java.io.IOException;
import java.util.*;
public class Tracer implements io.opentracing.Tracer {
private final static IdGenerator DEFAULT_ID_GENERATOR = new LongIdGenerator();
private final static Boolean DEFAULT_DUAL_SPAN_MODE = false;
private final Dispatcher dispatcher;
private final IdGenerator idGenerator;
protected final Clock clock;
protected final PropagationRegistry registry;
private final String serviceName;
private final ScopeManager scopeManager;
private final boolean dualSpanMode;
private final Counter spansCreatedCounter;
private final Timer dispatchTimer;
private final Timer closeTimer;
private final Counter closeExceptionCounter;
private final Timer flushTimer;
private final Counter flushExceptionCounter;
private final Timer injectTimer;
private final Counter injectFailureCounter;
private final Timer extractTimer;
private final Counter extractFailureCounter;
public Tracer(String serviceName, ScopeManager scopeManager, Clock clock,
Dispatcher dispatcher, PropagationRegistry registry, Metrics metrics) {
this(serviceName, scopeManager, clock, dispatcher, registry, metrics, DEFAULT_DUAL_SPAN_MODE, DEFAULT_ID_GENERATOR);
}
public Tracer(String serviceName, ScopeManager scopeManager, Clock clock,
Dispatcher dispatcher, PropagationRegistry registry,
Metrics metrics, boolean dualSpanMode, IdGenerator idGenerator) {
this.serviceName = serviceName;
this.scopeManager = scopeManager;
this.clock = clock;
this.idGenerator = idGenerator;
this.dispatcher = dispatcher;
this.registry = registry;
this.dualSpanMode = dualSpanMode;
this.dispatchTimer = Timer.builder("dispatch").register(metrics);
this.closeTimer = Timer.builder("close").register(metrics);
this.closeExceptionCounter = Counter.builder("close").tag(new Tag("state", "exception")).register(metrics);
this.flushTimer = Timer.builder("flush").register(metrics);
this.flushExceptionCounter = Counter.builder("flush").tag(new Tag("state", "exception")).register(metrics);
this.spansCreatedCounter = Counter.builder("spans").register(metrics);
this.injectTimer = Timer.builder("inject").register(metrics);
this.injectFailureCounter = Counter.builder("inject").tag(new Tag("state", "exception")).register(metrics);
this.extractTimer = Timer.builder("extract").register(metrics);
this.extractFailureCounter = Counter.builder("extract").tag(new Tag("state", "exception")).register(metrics);
Runtime.getRuntime().addShutdownHook(new Thread(() -> {
Tracer.this.close();
}));
}
@Override
public String toString() {
return new ReflectionToStringBuilder(this, ToStringStyle.SIMPLE_STYLE)
.setExcludeFieldNames("clock", "activeSource")
.toString();
}
public void close(){
try (Sample timer = closeTimer.start()) {
dispatcher.close();
} catch (IOException e) {
closeExceptionCounter.increment();
}
}
public void flush() throws IOException {
try (Sample timer = flushTimer.start()) {
dispatcher.flush();
} catch (IOException e) {
flushExceptionCounter.increment();
throw e;
}
}
void dispatch(com.expedia.www.haystack.client.Span span) {
try (Sample timer = dispatchTimer.start()) {
dispatcher.dispatch(span);
}
}
/**
* @return the dispatcher
*/
public Dispatcher getDispatcher() {
return dispatcher;
}
/**
* @return the serviceName
*/
public String getServiceName() {
return serviceName;
}
@Override
public SpanBuilder buildSpan(String operationName) {
spansCreatedCounter.increment();
return new SpanBuilder(this, clock, operationName);
}
@Override
public <C> void inject(io.opentracing.SpanContext spanContext, Format<C> format, C carrier) {
try (Sample sample = injectTimer.start()) {
final Injector<C> injector = registry.getInjector(format);
if (injector == null) {
injectFailureCounter.increment();
throw new IllegalArgumentException(String.format("Unsupported format: %s", format));
} else if (!(spanContext instanceof SpanContext)) {
injectFailureCounter.increment();
throw new IllegalArgumentException(String.format("Invalid SpanContext type: %s", spanContext));
}
injector.inject((SpanContext) spanContext, carrier);
}
}
@Override
public <C> SpanContext extract(Format<C> format, C carrier) {
try (Sample sample = extractTimer.start()) {
final Extractor<C> extractor = registry.getExtractor(format);
if (extractor == null) {
extractFailureCounter.increment();
throw new IllegalArgumentException(String.format("Unsupported format: %s", format));
}
return extractor.extract(carrier);
}
}
@Override
public Span activeSpan() {
return scopeManager.activeSpan();
}
@Override
public Scope activateSpan(Span span) {
return scopeManager.activate(span);
}
@Override
public ScopeManager scopeManager() {
return scopeManager;
}
public static class SpanBuilder implements io.opentracing.Tracer.SpanBuilder {
protected final Tracer tracer;
protected Clock clock;
protected Boolean ignoreActive;
protected String operationName;
protected Long startTime;
protected final List<Reference> references;
protected final Map<String, Object> tags;
protected SpanBuilder(Tracer tracer, Clock clock, String operationName) {
this.tracer = tracer;
this.clock = clock;
this.operationName = operationName;
this.startTime = 0l;
this.ignoreActive = false;
this.references = new ArrayList<>();
this.tags = new HashMap<>();
}
@Override
public SpanBuilder asChildOf(io.opentracing.SpanContext parent) {
return this.addReference(References.CHILD_OF, parent);
}
@Override
public SpanBuilder asChildOf(Span parent) {
if (parent == null) {
return this;
}
return this.addReference(References.CHILD_OF, parent.context());
}
@Override
public SpanBuilder addReference(String referenceType, io.opentracing.SpanContext referencedContext) {
if (referencedContext == null) {
return this;
}
if (!(referencedContext instanceof SpanContext)) {
// can't do much here, so ignore it
return this;
}
references.add(new Reference(referenceType, (SpanContext) referencedContext));
return this;
}
@Override
public SpanBuilder ignoreActiveSpan() {
this.ignoreActive = true;
return this;
}
@Override
public SpanBuilder withTag(String key, String value) {
this.tags.put(key, value);
return this;
}
@Override
public SpanBuilder withTag(String key, boolean value) {
this.tags.put(key, value);
return this;
}
@Override
public SpanBuilder withTag(String key, Number value) {
this.tags.put(key, value);
return this;
}
@Override
public <T> io.opentracing.Tracer.SpanBuilder withTag(io.opentracing.tag.Tag<T> tag, T value) {
if (tag != null && tag.getKey() != null) {
this.tags.put(tag.getKey(), value);
}
return this;
}
@Override
public SpanBuilder withStartTimestamp(long microseconds) {
this.startTime = microseconds;
return this;
}
boolean isServerSpan() {
return Tags.SPAN_KIND_SERVER.equals(tags.get(Tags.SPAN_KIND.getKey()));
}
protected SpanContext createNewContext() {
return createContext(tracer.idGenerator.generateTraceId(), tracer.idGenerator.generateSpanId(), null, Collections.emptyMap());
}
protected SpanContext createContext(UUID traceId, UUID spanId, UUID parentId, Map<String, String> baggage) {
return new SpanContext(traceId, spanId, parentId, baggage, false);
}
protected SpanContext createContext(Object traceId, Object spanId, Object parentId, Map<String, String> baggage) {//doubt parentId
return new SpanContext(traceId, spanId, parentId, baggage, false);
}
protected SpanContext createDependentContext() {
Reference parent = references.get(0);
for (Reference reference : references) {
if (References.CHILD_OF.equals(reference.getReferenceType())) {
// first parent wins
parent = reference;
break;
}
}
Map<String, String> baggage = new HashMap<>();
for (Reference reference : references) {
baggage.putAll(reference.getContext().getBaggage());
}
// This is a check to see if the tracer is configured to support single
// single span type (Zipkin style shared span id) or
// dual span type (client and server having their own span ids ).
// a. If tracer is not of dualSpanType and if it is a server span then we
// just return the parent context with the same shared span ids
// b. If tracer is not of dualSpanType and if the parent context is an extracted one from the wire
// then we assume this is the first span in the server and so just return the parent context
// with the same shared span ids
if (!tracer.dualSpanMode && (isServerSpan() || parent.getContext().isExtractedContext())) {
return createContext(parent.getContext().getTraceId(),
parent.getContext().getSpanId(),
parent.getContext().getParentId(),
baggage);
}
return createContext(parent.getContext().getTraceId(),
tracer.idGenerator.generateSpanId(),
parent.getContext().getSpanId(),
baggage);
}
SpanContext createContext() {
// handle active spans if needed
if (references.isEmpty() && !ignoreActive && tracer.activeSpan() != null) {
asChildOf(tracer.activeSpan());
}
if (references.isEmpty()) {
return createNewContext();
}
return createDependentContext();
}
private long calculateStartTime() {
if (startTime == 0) {
return clock.microTime();
}
return startTime;
}
@Override
public com.expedia.www.haystack.client.Span start() {
return new com.expedia.www.haystack.client.Span(tracer, clock, operationName, createContext(), calculateStartTime(), tags, references);
}
}
public static class Builder {
protected String serviceName;
protected ScopeManager scopeManager = new ThreadLocalScopeManager();
protected Clock clock = new SystemClock();
protected Dispatcher dispatcher;
protected PropagationRegistry registry = new PropagationRegistry();
protected Metrics metrics;
protected IdGenerator idGenerator;
private boolean dualSpanMode;
public Builder(MetricsRegistry registry, String serviceName, Dispatcher dispatcher) {
this(new Metrics(registry, Tracer.class.getName(), Collections.emptyList()), serviceName, dispatcher);
}
public Builder(Metrics metrics, String serviceName, Dispatcher dispatcher) {
this.serviceName = serviceName;
this.dispatcher = dispatcher;
this.metrics = metrics;
TextMapPropagator textMapPropagator = new TextMapPropagator.Builder().build();
withFormat(Format.Builtin.TEXT_MAP, (Injector<TextMap>) textMapPropagator);
withFormat(Format.Builtin.TEXT_MAP, (Extractor<TextMap>) textMapPropagator);
TextMapPropagator httpPropagator = new TextMapPropagator.Builder().withURLCodex().build();
withFormat(Format.Builtin.HTTP_HEADERS, (Injector<TextMap>) httpPropagator);
withFormat(Format.Builtin.HTTP_HEADERS, (Extractor<TextMap>) httpPropagator);
}
public Builder withScopeManager(ScopeManager scope) {
this.scopeManager = scope;
return this;
}
public Builder withClock(Clock clock) {
this.clock = clock;
return this;
}
public Builder withIdGenerator(IdGenerator idGenerator) {
this.idGenerator = idGenerator;
return this;
}
public <T> Builder withFormat(Format<T> format, Injector<T> injector) {
registry.register(format, injector);
return this;
}
public <T> Builder withFormat(Format<T> format, Extractor<T> extractor) {
registry.register(format, extractor);
return this;
}
public <T> Builder withoutFormat(Format<T> format) {
registry.deregisterInjector(format);
registry.deregisterExtractor(format);
return this;
}
public Builder clearAllFormats() {
registry.clear();
return this;
}
/**
* Enables production of client and server spans with two different span-ids. If not enabled,
* this will cause the Tracer to produce client and server spans with shared span-ids (Zipkin style)
* @return this builder instance
*/
public Builder withDualSpanMode() {
dualSpanMode = true;
return this;
}
public Tracer build() {
idGenerator = idGenerator == null ? DEFAULT_ID_GENERATOR : idGenerator;
return new Tracer(serviceName, scopeManager, clock, dispatcher, registry, metrics, dualSpanMode, idGenerator);
}
}
}