mockforge-tracing 0.3.138

OpenTelemetry and distributed tracing integration for MockForge
Documentation
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
//! Trace context propagation utilities
//!
//! Implements W3C Trace Context standard for propagating trace information
//! across service boundaries.

use opentelemetry::propagation::{Extractor, Injector};
use opentelemetry::trace::{SpanId, TraceContextExt, TraceId};
use opentelemetry::{global, Context};
use std::collections::HashMap;

/// Trace context information
#[derive(Debug, Clone)]
pub struct TraceContext {
    pub trace_id: String,
    pub span_id: String,
    pub trace_flags: u8,
}

impl TraceContext {
    /// Create from OpenTelemetry context
    pub fn from_context(ctx: &Context) -> Option<Self> {
        let span = ctx.span();
        let span_context = span.span_context();
        if span_context.is_valid() {
            Some(Self {
                trace_id: format!("{:032x}", span_context.trace_id()),
                span_id: format!("{:016x}", span_context.span_id()),
                trace_flags: span_context.trace_flags().to_u8(),
            })
        } else {
            None
        }
    }

    /// Get trace ID as TraceId type
    pub fn trace_id(&self) -> Option<TraceId> {
        TraceId::from_hex(&self.trace_id).ok()
    }

    /// Get span ID as SpanId type
    pub fn span_id(&self) -> Option<SpanId> {
        SpanId::from_hex(&self.span_id).ok()
    }
}

/// Extract trace context from HTTP headers
pub fn extract_trace_context(headers: &HashMap<String, String>) -> Context {
    let extractor = HeaderExtractor(headers);
    global::get_text_map_propagator(|prop| prop.extract(&extractor))
}

/// Inject trace context into HTTP headers
pub fn inject_trace_context(ctx: &Context, headers: &mut HashMap<String, String>) {
    let mut injector = HeaderInjector(headers);
    global::get_text_map_propagator(|prop| prop.inject_context(ctx, &mut injector));
}

/// HTTP header extractor for trace context
struct HeaderExtractor<'a>(&'a HashMap<String, String>);

impl<'a> Extractor for HeaderExtractor<'a> {
    fn get(&self, key: &str) -> Option<&str> {
        self.0.get(key).map(|v| v.as_str())
    }

    fn keys(&self) -> Vec<&str> {
        self.0.keys().map(|k| k.as_str()).collect()
    }
}

/// HTTP header injector for trace context
struct HeaderInjector<'a>(&'a mut HashMap<String, String>);

impl<'a> Injector for HeaderInjector<'a> {
    fn set(&mut self, key: &str, value: String) {
        self.0.insert(key.to_string(), value);
    }
}

/// Extract trace context from Axum HTTP headers
pub fn extract_from_axum_headers(headers: &http::HeaderMap) -> Context {
    let mut header_map = HashMap::new();
    for (key, value) in headers.iter() {
        if let Ok(value_str) = value.to_str() {
            header_map.insert(key.to_string(), value_str.to_string());
        }
    }
    extract_trace_context(&header_map)
}

/// Inject trace context into Axum HTTP headers
pub fn inject_into_axum_headers(ctx: &Context, headers: &mut http::HeaderMap) {
    let mut header_map = HashMap::new();
    inject_trace_context(ctx, &mut header_map);

    for (key, value) in header_map {
        if let (Ok(header_name), Ok(header_value)) =
            (http::HeaderName::try_from(&key), http::HeaderValue::try_from(&value))
        {
            headers.insert(header_name, header_value);
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_extract_inject_round_trip() {
        // Set up the global propagator
        use opentelemetry::global;
        use opentelemetry_sdk::propagation::TraceContextPropagator;
        global::set_text_map_propagator(TraceContextPropagator::new());

        let mut headers = HashMap::new();
        headers.insert(
            "traceparent".to_string(),
            "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01".to_string(),
        );

        let ctx = extract_trace_context(&headers);
        let trace_ctx = TraceContext::from_context(&ctx);

        assert!(trace_ctx.is_some());
        let trace_ctx = trace_ctx.unwrap();
        assert_eq!(trace_ctx.trace_id, "0af7651916cd43dd8448eb211c80319c");
    }

    #[test]
    fn test_empty_headers() {
        let headers = HashMap::new();
        let ctx = extract_trace_context(&headers);
        let trace_ctx = TraceContext::from_context(&ctx);

        // Should create a new trace context
        assert!(trace_ctx.is_none());
    }

    #[test]
    fn test_trace_context_debug() {
        let trace_ctx = TraceContext {
            trace_id: "0af7651916cd43dd8448eb211c80319c".to_string(),
            span_id: "b7ad6b7169203331".to_string(),
            trace_flags: 1,
        };
        let debug_str = format!("{:?}", trace_ctx);
        assert!(debug_str.contains("TraceContext"));
        assert!(debug_str.contains("0af7651916cd43dd8448eb211c80319c"));
        assert!(debug_str.contains("b7ad6b7169203331"));
    }

    #[test]
    fn test_trace_context_clone() {
        let trace_ctx = TraceContext {
            trace_id: "0af7651916cd43dd8448eb211c80319c".to_string(),
            span_id: "b7ad6b7169203331".to_string(),
            trace_flags: 1,
        };
        let cloned = trace_ctx.clone();
        assert_eq!(cloned.trace_id, trace_ctx.trace_id);
        assert_eq!(cloned.span_id, trace_ctx.span_id);
        assert_eq!(cloned.trace_flags, trace_ctx.trace_flags);
    }

    #[test]
    fn test_trace_context_trace_id_valid() {
        let trace_ctx = TraceContext {
            trace_id: "0af7651916cd43dd8448eb211c80319c".to_string(),
            span_id: "b7ad6b7169203331".to_string(),
            trace_flags: 1,
        };
        let trace_id = trace_ctx.trace_id();
        assert!(trace_id.is_some());
    }

    #[test]
    fn test_trace_context_trace_id_invalid() {
        let trace_ctx = TraceContext {
            trace_id: "invalid".to_string(),
            span_id: "b7ad6b7169203331".to_string(),
            trace_flags: 1,
        };
        let trace_id = trace_ctx.trace_id();
        assert!(trace_id.is_none());
    }

    #[test]
    fn test_trace_context_span_id_valid() {
        let trace_ctx = TraceContext {
            trace_id: "0af7651916cd43dd8448eb211c80319c".to_string(),
            span_id: "b7ad6b7169203331".to_string(),
            trace_flags: 1,
        };
        let span_id = trace_ctx.span_id();
        assert!(span_id.is_some());
    }

    #[test]
    fn test_trace_context_span_id_invalid() {
        let trace_ctx = TraceContext {
            trace_id: "0af7651916cd43dd8448eb211c80319c".to_string(),
            span_id: "invalid".to_string(),
            trace_flags: 1,
        };
        let span_id = trace_ctx.span_id();
        assert!(span_id.is_none());
    }

    #[test]
    fn test_inject_trace_context() {
        use opentelemetry::global;
        use opentelemetry_sdk::propagation::TraceContextPropagator;
        global::set_text_map_propagator(TraceContextPropagator::new());

        // First extract a context from headers
        let mut headers = HashMap::new();
        headers.insert(
            "traceparent".to_string(),
            "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01".to_string(),
        );

        let ctx = extract_trace_context(&headers);

        // Now inject into new headers
        let mut new_headers = HashMap::new();
        inject_trace_context(&ctx, &mut new_headers);

        // Verify traceparent was injected
        assert!(new_headers.contains_key("traceparent"));
        let traceparent = new_headers.get("traceparent").unwrap();
        assert!(traceparent.starts_with("00-0af7651916cd43dd8448eb211c80319c"));
    }

    #[test]
    fn test_inject_trace_context_empty_context() {
        use opentelemetry::global;
        use opentelemetry_sdk::propagation::TraceContextPropagator;
        global::set_text_map_propagator(TraceContextPropagator::new());

        let ctx = Context::new();
        let mut headers = HashMap::new();
        inject_trace_context(&ctx, &mut headers);

        // Empty context shouldn't inject anything meaningful
        // The header might be empty or not present
    }

    #[test]
    fn test_extract_from_axum_headers() {
        use opentelemetry::global;
        use opentelemetry_sdk::propagation::TraceContextPropagator;
        global::set_text_map_propagator(TraceContextPropagator::new());

        let mut headers = http::HeaderMap::new();
        headers.insert(
            "traceparent",
            "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01".parse().unwrap(),
        );

        let ctx = extract_from_axum_headers(&headers);
        let trace_ctx = TraceContext::from_context(&ctx);

        assert!(trace_ctx.is_some());
        let trace_ctx = trace_ctx.unwrap();
        assert_eq!(trace_ctx.trace_id, "0af7651916cd43dd8448eb211c80319c");
    }

    #[test]
    fn test_extract_from_axum_headers_empty() {
        let headers = http::HeaderMap::new();
        let ctx = extract_from_axum_headers(&headers);
        let trace_ctx = TraceContext::from_context(&ctx);

        assert!(trace_ctx.is_none());
    }

    #[test]
    fn test_extract_from_axum_headers_with_tracestate() {
        use opentelemetry::global;
        use opentelemetry_sdk::propagation::TraceContextPropagator;
        global::set_text_map_propagator(TraceContextPropagator::new());

        let mut headers = http::HeaderMap::new();
        headers.insert(
            "traceparent",
            "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01".parse().unwrap(),
        );
        headers.insert("tracestate", "congo=t61rcWkgMzE".parse().unwrap());

        let ctx = extract_from_axum_headers(&headers);
        let trace_ctx = TraceContext::from_context(&ctx);

        assert!(trace_ctx.is_some());
    }

    #[test]
    fn test_inject_into_axum_headers() {
        use opentelemetry::global;
        use opentelemetry_sdk::propagation::TraceContextPropagator;
        global::set_text_map_propagator(TraceContextPropagator::new());

        // First extract a context
        let mut input_headers = HashMap::new();
        input_headers.insert(
            "traceparent".to_string(),
            "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01".to_string(),
        );
        let ctx = extract_trace_context(&input_headers);

        // Inject into axum headers
        let mut axum_headers = http::HeaderMap::new();
        inject_into_axum_headers(&ctx, &mut axum_headers);

        // Verify header was injected
        assert!(axum_headers.contains_key("traceparent"));
    }

    #[test]
    fn test_inject_into_axum_headers_empty_context() {
        use opentelemetry::global;
        use opentelemetry_sdk::propagation::TraceContextPropagator;
        global::set_text_map_propagator(TraceContextPropagator::new());

        let ctx = Context::new();
        let mut headers = http::HeaderMap::new();
        inject_into_axum_headers(&ctx, &mut headers);

        // Should not panic, headers might be empty
    }

    #[test]
    fn test_header_extractor() {
        let mut headers = HashMap::new();
        headers.insert("key1".to_string(), "value1".to_string());
        headers.insert("key2".to_string(), "value2".to_string());

        let extractor = HeaderExtractor(&headers);

        assert_eq!(extractor.get("key1"), Some("value1"));
        assert_eq!(extractor.get("key2"), Some("value2"));
        assert_eq!(extractor.get("nonexistent"), None);

        let keys = extractor.keys();
        assert_eq!(keys.len(), 2);
        assert!(keys.contains(&"key1"));
        assert!(keys.contains(&"key2"));
    }

    #[test]
    fn test_header_injector() {
        let mut headers = HashMap::new();

        {
            let mut injector = HeaderInjector(&mut headers);
            injector.set("key1", "value1".to_string());
            injector.set("key2", "value2".to_string());
        }

        assert_eq!(headers.get("key1"), Some(&"value1".to_string()));
        assert_eq!(headers.get("key2"), Some(&"value2".to_string()));
    }

    #[test]
    fn test_header_injector_overwrite() {
        let mut headers = HashMap::new();
        headers.insert("key1".to_string(), "old_value".to_string());

        {
            let mut injector = HeaderInjector(&mut headers);
            injector.set("key1", "new_value".to_string());
        }

        assert_eq!(headers.get("key1"), Some(&"new_value".to_string()));
    }

    #[test]
    fn test_trace_context_trace_flags() {
        let trace_ctx = TraceContext {
            trace_id: "0af7651916cd43dd8448eb211c80319c".to_string(),
            span_id: "b7ad6b7169203331".to_string(),
            trace_flags: 0,
        };
        assert_eq!(trace_ctx.trace_flags, 0);

        let trace_ctx_sampled = TraceContext {
            trace_id: "0af7651916cd43dd8448eb211c80319c".to_string(),
            span_id: "b7ad6b7169203331".to_string(),
            trace_flags: 1,
        };
        assert_eq!(trace_ctx_sampled.trace_flags, 1);
    }

    #[test]
    fn test_extract_multiple_headers() {
        use opentelemetry::global;
        use opentelemetry_sdk::propagation::TraceContextPropagator;
        global::set_text_map_propagator(TraceContextPropagator::new());

        let mut headers = HashMap::new();
        headers.insert(
            "traceparent".to_string(),
            "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01".to_string(),
        );
        headers.insert("x-custom-header".to_string(), "custom-value".to_string());
        headers.insert("content-type".to_string(), "application/json".to_string());

        let ctx = extract_trace_context(&headers);
        let trace_ctx = TraceContext::from_context(&ctx);

        // Should still extract trace context correctly despite other headers
        assert!(trace_ctx.is_some());
        assert_eq!(trace_ctx.unwrap().trace_id, "0af7651916cd43dd8448eb211c80319c");
    }
}