forked from open-telemetry/opentelemetry-java
-
Notifications
You must be signed in to change notification settings - Fork 1
/
JaegerPropagator.java
295 lines (251 loc) · 9.87 KB
/
JaegerPropagator.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
/*
* Copyright The OpenTelemetry Authors
* SPDX-License-Identifier: Apache-2.0
*/
package io.opentelemetry.extension.trace.propagation;
import io.opentelemetry.api.baggage.Baggage;
import io.opentelemetry.api.baggage.BaggageBuilder;
import io.opentelemetry.api.internal.StringUtils;
import io.opentelemetry.api.internal.TemporaryBuffers;
import io.opentelemetry.api.trace.Span;
import io.opentelemetry.api.trace.SpanContext;
import io.opentelemetry.api.trace.SpanId;
import io.opentelemetry.api.trace.TraceFlags;
import io.opentelemetry.api.trace.TraceId;
import io.opentelemetry.api.trace.TraceState;
import io.opentelemetry.context.Context;
import io.opentelemetry.context.propagation.TextMapGetter;
import io.opentelemetry.context.propagation.TextMapPropagator;
import io.opentelemetry.context.propagation.TextMapSetter;
import java.io.UnsupportedEncodingException;
import java.net.URLDecoder;
import java.util.Collection;
import java.util.Collections;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;
/**
* Implementation of the Jaeger propagation protocol. See <a
* href=https://www.jaegertracing.io/docs/client-libraries/#propagation-format>Jaeger Propagation
* Format</a>.
*/
@Immutable
public final class JaegerPropagator implements TextMapPropagator {
private static final Logger logger = Logger.getLogger(JaegerPropagator.class.getName());
static final String PROPAGATION_HEADER = "uber-trace-id";
static final String BAGGAGE_HEADER = "jaeger-baggage";
static final String BAGGAGE_PREFIX = "uberctx-";
// Parent span has been deprecated but Jaeger propagation protocol requires it
static final char DEPRECATED_PARENT_SPAN = '0';
static final char PROPAGATION_HEADER_DELIMITER = ':';
private static final int MAX_TRACE_ID_LENGTH = TraceId.getLength();
private static final int MAX_SPAN_ID_LENGTH = SpanId.getLength();
private static final int MAX_FLAGS_LENGTH = 2;
private static final char IS_SAMPLED_CHAR = '1';
private static final char NOT_SAMPLED_CHAR = '0';
private static final int PROPAGATION_HEADER_DELIMITER_SIZE = 1;
private static final int TRACE_ID_HEX_SIZE = TraceId.getLength();
private static final int SPAN_ID_HEX_SIZE = SpanId.getLength();
private static final int PARENT_SPAN_ID_SIZE = 1;
private static final int SAMPLED_FLAG_SIZE = 1;
private static final int SPAN_ID_OFFSET = TRACE_ID_HEX_SIZE + PROPAGATION_HEADER_DELIMITER_SIZE;
private static final int PARENT_SPAN_ID_OFFSET =
SPAN_ID_OFFSET + SPAN_ID_HEX_SIZE + PROPAGATION_HEADER_DELIMITER_SIZE;
private static final int SAMPLED_FLAG_OFFSET =
PARENT_SPAN_ID_OFFSET + PARENT_SPAN_ID_SIZE + PROPAGATION_HEADER_DELIMITER_SIZE;
private static final int PROPAGATION_HEADER_SIZE = SAMPLED_FLAG_OFFSET + SAMPLED_FLAG_SIZE;
private static final Collection<String> FIELDS = Collections.singletonList(PROPAGATION_HEADER);
private static final JaegerPropagator INSTANCE = new JaegerPropagator();
private JaegerPropagator() {
// singleton
}
public static JaegerPropagator getInstance() {
return INSTANCE;
}
@Override
public Collection<String> fields() {
return FIELDS;
}
@Override
public <C> void inject(Context context, @Nullable C carrier, TextMapSetter<C> setter) {
if (context == null) {
return;
}
if (setter == null) {
return;
}
SpanContext spanContext = Span.fromContext(context).getSpanContext();
if (spanContext.isValid()) {
injectSpan(spanContext, carrier, setter);
}
injectBaggage(Baggage.fromContext(context), carrier, setter);
}
private static <C> void injectSpan(
SpanContext spanContext, @Nullable C carrier, TextMapSetter<C> setter) {
char[] chars = TemporaryBuffers.chars(PROPAGATION_HEADER_SIZE);
String traceId = spanContext.getTraceId();
traceId.getChars(0, traceId.length(), chars, 0);
chars[SPAN_ID_OFFSET - 1] = PROPAGATION_HEADER_DELIMITER;
String spanId = spanContext.getSpanId();
spanId.getChars(0, spanId.length(), chars, SPAN_ID_OFFSET);
chars[PARENT_SPAN_ID_OFFSET - 1] = PROPAGATION_HEADER_DELIMITER;
chars[PARENT_SPAN_ID_OFFSET] = DEPRECATED_PARENT_SPAN;
chars[SAMPLED_FLAG_OFFSET - 1] = PROPAGATION_HEADER_DELIMITER;
chars[SAMPLED_FLAG_OFFSET] = spanContext.isSampled() ? IS_SAMPLED_CHAR : NOT_SAMPLED_CHAR;
setter.set(carrier, PROPAGATION_HEADER, new String(chars, 0, PROPAGATION_HEADER_SIZE));
}
private static <C> void injectBaggage(
Baggage baggage, @Nullable C carrier, TextMapSetter<C> setter) {
baggage.forEach(
(key, baggageEntry) -> setter.set(carrier, BAGGAGE_PREFIX + key, baggageEntry.getValue()));
}
@Override
public <C> Context extract(Context context, @Nullable C carrier, TextMapGetter<C> getter) {
if (context == null) {
return Context.root();
}
if (getter == null) {
return context;
}
SpanContext spanContext = getSpanContextFromHeader(carrier, getter);
if (spanContext.isValid()) {
context = context.with(Span.wrap(spanContext));
}
Baggage baggage = getBaggageFromHeader(carrier, getter);
if (baggage != null) {
context = context.with(baggage);
}
return context;
}
@Override
public String toString() {
return "JaegerPropagator";
}
private static <C> SpanContext getSpanContextFromHeader(
@Nullable C carrier, TextMapGetter<C> getter) {
String value = getter.get(carrier, PROPAGATION_HEADER);
if (StringUtils.isNullOrEmpty(value)) {
return SpanContext.getInvalid();
}
// if the delimiter (:) cannot be found then the propagation value could be URL
// encoded, so we need to decode it before attempting to split it.
if (value.lastIndexOf(PROPAGATION_HEADER_DELIMITER) == -1) {
try {
// the propagation value
value = URLDecoder.decode(value, "UTF-8");
} catch (UnsupportedEncodingException e) {
logger.fine(
"Error decoding '"
+ PROPAGATION_HEADER
+ "' with value "
+ value
+ ". Returning INVALID span context.");
return SpanContext.getInvalid();
}
}
String[] parts = value.split(String.valueOf(PROPAGATION_HEADER_DELIMITER));
if (parts.length != 4) {
logger.fine(
"Invalid header '"
+ PROPAGATION_HEADER
+ "' with value "
+ value
+ ". Returning INVALID span context.");
return SpanContext.getInvalid();
}
String traceId = parts[0];
if (!isTraceIdValid(traceId)) {
logger.fine(
"Invalid TraceId in Jaeger header: '"
+ PROPAGATION_HEADER
+ "' with traceId "
+ traceId
+ ". Returning INVALID span context.");
return SpanContext.getInvalid();
}
String spanId = parts[1];
if (!isSpanIdValid(spanId)) {
logger.fine(
"Invalid SpanId in Jaeger header: '"
+ PROPAGATION_HEADER
+ "'. Returning INVALID span context.");
return SpanContext.getInvalid();
}
String flags = parts[3];
if (!isFlagsValid(flags)) {
logger.fine(
"Invalid Flags in Jaeger header: '"
+ PROPAGATION_HEADER
+ "'. Returning INVALID span context.");
return SpanContext.getInvalid();
}
return buildSpanContext(traceId, spanId, flags);
}
@Nullable
private static <C> Baggage getBaggageFromHeader(@Nullable C carrier, TextMapGetter<C> getter) {
BaggageBuilder builder = null;
Iterable<String> keys = carrier != null ? getter.keys(carrier) : Collections.emptyList();
for (String key : keys) {
if (key.startsWith(BAGGAGE_PREFIX)) {
if (key.length() == BAGGAGE_PREFIX.length()) {
continue;
}
if (builder == null) {
builder = Baggage.builder();
}
String value = getter.get(carrier, key);
if (value != null) {
builder.put(key.substring(BAGGAGE_PREFIX.length()), value);
}
} else if (key.equals(BAGGAGE_HEADER)) {
String value = getter.get(carrier, key);
if (value != null) {
if (builder == null) {
builder = Baggage.builder();
}
builder = parseBaggageHeader(value, builder);
}
}
}
return builder == null ? null : builder.build();
}
private static BaggageBuilder parseBaggageHeader(String header, BaggageBuilder builder) {
for (String part : header.split("\\s*,\\s*")) {
String[] kv = part.split("\\s*=\\s*");
if (kv.length == 2) {
builder.put(kv[0], kv[1]);
} else {
logger.fine("malformed token in " + BAGGAGE_HEADER + " header: " + part);
}
}
return builder;
}
private static SpanContext buildSpanContext(String traceId, String spanId, String flags) {
try {
String otelTraceId = StringUtils.padLeft(traceId, MAX_TRACE_ID_LENGTH);
String otelSpanId = StringUtils.padLeft(spanId, MAX_SPAN_ID_LENGTH);
int flagsInt = Integer.parseInt(flags);
return SpanContext.createFromRemoteParent(
otelTraceId,
otelSpanId,
((flagsInt & 1) == 1) ? TraceFlags.getSampled() : TraceFlags.getDefault(),
TraceState.getDefault());
} catch (RuntimeException e) {
logger.log(
Level.FINE,
"Error parsing '" + PROPAGATION_HEADER + "' header. Returning INVALID span context.",
e);
return SpanContext.getInvalid();
}
}
private static boolean isTraceIdValid(String value) {
return !(StringUtils.isNullOrEmpty(value) || value.length() > MAX_TRACE_ID_LENGTH);
}
private static boolean isSpanIdValid(String value) {
return !(StringUtils.isNullOrEmpty(value) || value.length() > MAX_SPAN_ID_LENGTH);
}
private static boolean isFlagsValid(String value) {
return !(StringUtils.isNullOrEmpty(value) || value.length() > MAX_FLAGS_LENGTH);
}
}