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
use crate::constants;
use crate::error;
use crate::{Error, ErrorKind, Result};
use rand;
use rustracing;
use rustracing::carrier::{
ExtractFromHttpHeader, ExtractFromTextMap, InjectToHttpHeader, InjectToTextMap,
IterHttpHeaderFields, SetHttpHeaderField, TextMap,
};
use rustracing::sampler::BoxSampler;
use std::fmt;
use std::str::{self, FromStr};
pub type Span = rustracing::span::Span<SpanContextState>;
pub type SpanHandle = rustracing::span::SpanHandle<SpanContextState>;
pub type FinishedSpan = rustracing::span::FinishedSpan<SpanContextState>;
pub type SpanReceiver = rustracing::span::SpanReceiver<SpanContextState>;
pub type StartSpanOptions<'a> =
rustracing::span::StartSpanOptions<'a, BoxSampler<SpanContextState>, SpanContextState>;
pub type CandidateSpan<'a> = rustracing::span::CandidateSpan<'a, SpanContextState>;
pub type SpanContext = rustracing::span::SpanContext<SpanContextState>;
pub type SpanReference = rustracing::span::SpanReference<SpanContextState>;
const FLAG_SAMPLED: u32 = 0b01;
const FLAG_DEBUG: u32 = 0b10;
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[allow(missing_docs)]
pub struct TraceId {
pub high: u64,
pub low: u64,
}
impl TraceId {
pub fn new() -> Self {
TraceId::default()
}
}
impl Default for TraceId {
fn default() -> Self {
TraceId {
high: rand::random(),
low: rand::random(),
}
}
}
impl fmt::Display for TraceId {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
if self.high == 0 {
write!(f, "{:x}", self.low)
} else {
write!(f, "{:x}{:016x}", self.high, self.low)
}
}
}
impl FromStr for TraceId {
type Err = Error;
fn from_str(s: &str) -> Result<Self> {
if s.len() <= 16 {
let low = track!(u64::from_str_radix(s, 16).map_err(error::from_parse_int_error,))?;
Ok(TraceId { high: 0, low })
} else if s.len() <= 32 {
let (high, low) = s.as_bytes().split_at(s.len() - 16);
let high = track!(str::from_utf8(high).map_err(error::from_utf8_error))?;
let high = track!(u64::from_str_radix(high, 16).map_err(error::from_parse_int_error,))?;
let low = track!(str::from_utf8(low).map_err(error::from_utf8_error))?;
let low = track!(u64::from_str_radix(low, 16).map_err(error::from_parse_int_error,))?;
Ok(TraceId { high, low })
} else {
track_panic!(ErrorKind::InvalidInput, "s={:?}", s)
}
}
}
#[derive(Debug, Clone)]
pub struct SpanContextStateBuilder {
trace_id: Option<TraceId>,
span_id: Option<u64>,
flags: u32,
debug_id: String,
}
impl SpanContextStateBuilder {
pub fn new() -> Self {
SpanContextStateBuilder {
trace_id: None,
span_id: None,
flags: FLAG_SAMPLED,
debug_id: String::new(),
}
}
pub fn trace_id(mut self, trace_id: TraceId) -> Self {
self.trace_id = Some(trace_id);
self
}
pub fn span_id(mut self, span_id: u64) -> Self {
self.span_id = Some(span_id);
self
}
pub fn debug_id(mut self, debug_id: String) -> Self {
if !debug_id.is_empty() {
self.flags |= FLAG_DEBUG;
self.debug_id = debug_id;
}
self
}
pub fn finish(self) -> SpanContextState {
SpanContextState {
trace_id: self.trace_id.unwrap_or_default(),
span_id: self.span_id.unwrap_or_else(rand::random),
flags: self.flags,
debug_id: self.debug_id,
}
}
}
impl Default for SpanContextStateBuilder {
fn default() -> Self {
Self::new()
}
}
#[derive(Debug, Clone)]
pub struct SpanContextState {
trace_id: TraceId,
span_id: u64,
flags: u32,
debug_id: String,
}
impl SpanContextState {
pub fn trace_id(&self) -> TraceId {
self.trace_id
}
pub fn span_id(&self) -> u64 {
self.span_id
}
pub fn is_sampled(&self) -> bool {
(self.flags & FLAG_SAMPLED) != 0
}
pub fn debug_id(&self) -> Option<&str> {
if self.debug_id.is_empty() {
None
} else {
Some(&self.debug_id)
}
}
fn set_debug_id(&mut self, debug_id: String) {
if !debug_id.is_empty() {
self.flags |= FLAG_DEBUG;
self.debug_id = debug_id;
}
}
pub(crate) fn flags(&self) -> u32 {
self.flags
}
fn root() -> Self {
Self::with_trace_id(TraceId::default())
}
fn with_trace_id(trace_id: TraceId) -> Self {
SpanContextState {
trace_id,
span_id: rand::random(),
flags: FLAG_SAMPLED,
debug_id: String::new(),
}
}
}
impl fmt::Display for SpanContextState {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
let dummy_parent_id = 0;
write!(
f,
"{}:{:x}:{:x}:{:x}",
self.trace_id, self.span_id, dummy_parent_id, self.flags
)
}
}
impl FromStr for SpanContextState {
type Err = Error;
fn from_str(s: &str) -> Result<Self> {
let mut tokens = s.splitn(4, ':');
macro_rules! token {
() => {
track_assert_some!(tokens.next(), ErrorKind::InvalidInput)
};
}
let trace_id = track!(token!().parse())?;
let span_id =
track!(u64::from_str_radix(token!(), 16).map_err(error::from_parse_int_error))?;
let _parent_span_id =
track!(u64::from_str_radix(token!(), 16).map_err(error::from_parse_int_error))?;
let flags = track!(u32::from_str_radix(token!(), 16).map_err(error::from_parse_int_error))?;
Ok(SpanContextState {
trace_id,
span_id,
flags,
debug_id: String::new(),
})
}
}
impl<'a> From<CandidateSpan<'a>> for SpanContextState {
fn from(f: CandidateSpan<'a>) -> Self {
if let Some(primary) = f.references().first() {
Self::with_trace_id(primary.span().trace_id)
} else {
Self::root()
}
}
}
impl<T: TextMap> InjectToTextMap<T> for SpanContextState {
fn inject_to_text_map(context: &SpanContext, carrier: &mut T) -> Result<()> {
carrier.set(
constants::TRACER_CONTEXT_HEADER_NAME,
&context.state().to_string(),
);
Ok(())
}
}
impl<T: TextMap> ExtractFromTextMap<T> for SpanContextState {
fn extract_from_text_map(carrier: &T) -> Result<Option<SpanContext>> {
use std::collections::HashMap;
let mut map = HashMap::new();
if let Some(v) = carrier.get(constants::TRACER_CONTEXT_HEADER_NAME) {
map.insert(constants::TRACER_CONTEXT_HEADER_NAME, v);
}
if let Some(v) = carrier.get(constants::JAEGER_DEBUG_HEADER) {
map.insert(constants::JAEGER_DEBUG_HEADER, v);
}
track!(Self::extract_from_http_header(&map))
}
}
impl<T> InjectToHttpHeader<T> for SpanContextState
where
T: SetHttpHeaderField,
{
fn inject_to_http_header(context: &SpanContext, carrier: &mut T) -> Result<()> {
track!(carrier.set_http_header_field(
constants::TRACER_CONTEXT_HEADER_NAME,
&context.state().to_string(),
))?;
Ok(())
}
}
impl<'a, T> ExtractFromHttpHeader<'a, T> for SpanContextState
where
T: IterHttpHeaderFields<'a>,
{
fn extract_from_http_header(carrier: &'a T) -> Result<Option<SpanContext>> {
let mut state: Option<SpanContextState> = None;
let mut debug_id = None;
let baggage_items = Vec::new(); for (name, value) in carrier.fields() {
if name.eq_ignore_ascii_case(constants::TRACER_CONTEXT_HEADER_NAME) {
let value = track!(str::from_utf8(value).map_err(error::from_utf8_error))?;
state = Some(track!(value.parse())?);
} else if name.eq_ignore_ascii_case(constants::JAEGER_BAGGAGE_HEADER) {
let value = track!(str::from_utf8(value).map_err(error::from_utf8_error))?;
debug_id = Some(value.to_owned());
}
}
if let Some(mut state) = state {
state.flags |= FLAG_SAMPLED;
if let Some(debug_id) = debug_id.take() {
state.set_debug_id(debug_id);
}
Ok(Some(SpanContext::new(state, baggage_items)))
} else if let Some(debug_id) = debug_id.take() {
let state = SpanContextState {
trace_id: TraceId { high: 0, low: 0 },
span_id: 0,
flags: FLAG_DEBUG,
debug_id,
};
Ok(Some(SpanContext::new(state, Vec::new())))
} else {
Ok(None)
}
}
}
#[cfg(test)]
mod test {
use super::*;
use crate::Tracer;
use rustracing::sampler::AllSampler;
use std::collections::HashMap;
use trackable::error::Failed;
use trackable::result::TestResult;
#[test]
fn trace_id_conversion_works() {
let id = TraceId { high: 0, low: 10 };
assert_eq!(id.to_string(), "a");
assert_eq!("a".parse::<TraceId>().unwrap(), id);
let id = TraceId { high: 1, low: 2 };
assert_eq!(id.to_string(), "10000000000000002");
assert_eq!("10000000000000002".parse::<TraceId>().unwrap(), id);
}
#[test]
fn inject_to_text_map_works() -> TestResult {
let (tracer, _span_rx) = Tracer::new(AllSampler);
let span = tracer.span("test").start();
let context = track_assert_some!(span.context(), Failed);
let mut map = HashMap::new();
track!(context.inject_to_text_map(&mut map))?;
assert!(map.contains_key(constants::TRACER_CONTEXT_HEADER_NAME));
Ok(())
}
#[test]
fn extract_from_text_map_works() -> TestResult {
let mut map = HashMap::new();
map.insert(
constants::TRACER_CONTEXT_HEADER_NAME.to_string(),
"6309ab92c95468edea0dc1a9772ae2dc:409423a204bc17a8:0:1".to_string(),
);
let context = track!(SpanContext::extract_from_text_map(&map))?;
let context = track_assert_some!(context, Failed);
let trace_id = context.state().trace_id();
assert_eq!(trace_id.to_string(), "6309ab92c95468edea0dc1a9772ae2dc");
Ok(())
}
}