logfire 0.9.0

Rust SDK for Pydantic Logfire
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
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
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
//! Integration tests for HTTP sink with mock server.

use logfire::config::AdvancedOptions;
use wiremock::matchers::{header, method, path};
use wiremock::{Mock, MockServer, ResponseTemplate};

use insta::assert_debug_snapshot;
use logfire::{configure, set_local_logfire, span};
use opentelemetry_proto::tonic::collector::trace::v1::ExportTraceServiceRequest;
use prost::Message;

use crate::test_utils::{DeterministicIdGenerator, make_trace_request_deterministic};

#[path = "../src/test_utils.rs"]
mod test_utils;

/// Test HTTP protobuf export infrastructure
#[tokio::test]
async fn test_http_protobuf_export() {
    let mock_server = MockServer::start().await;

    let traces_mock = Mock::given(method("POST"))
        .and(path("/v1/traces"))
        .and(header("content-type", "application/x-protobuf"))
        .and(header("authorization", "Bearer test-token"))
        .respond_with(ResponseTemplate::new(200));

    mock_server.register(traces_mock).await;

    let env_guard = ENV_MUTEX.lock().unwrap();
    // SAFETY: Holding mutex to prevent other thread interacting with env
    unsafe {
        std::env::set_var("OTEL_EXPORTER_OTLP_PROTOCOL", "http/protobuf");
    }

    let logfire = configure()
        .local()
        .send_to_logfire(true)
        .with_token("test-token")
        .with_advanced_options(
            AdvancedOptions::default()
                .with_base_url(mock_server.uri())
                .with_id_generator(DeterministicIdGenerator::new()),
        )
        .finish()
        .unwrap();

    // SAFETY: As above
    unsafe {
        std::env::remove_var("OTEL_EXPORTER_OTLP_PROTOCOL");
    }
    drop(env_guard);

    let guard = set_local_logfire(logfire);
    span!("test_span").in_scope(|| {});
    guard.shutdown().unwrap();

    let requests = mock_server.received_requests().await.unwrap();
    assert_eq!(requests.len(), 1);
    let request = &requests[0];

    assert_eq!(request.method.as_str(), "POST");
    assert_eq!(request.url.path(), "/v1/traces");
    let mut body = ExportTraceServiceRequest::decode(request.body.as_slice())
        .expect("failed to decode trace request");
    make_trace_request_deterministic(&mut body);

    assert_debug_snapshot!(body, @r#"
    ExportTraceServiceRequest {
        resource_spans: [
            ResourceSpans {
                resource: Some(
                    Resource {
                        attributes: [
                            KeyValue {
                                key: "service.name",
                                value: Some(
                                    AnyValue {
                                        value: Some(
                                            StringValue(
                                                "unknown_service",
                                            ),
                                        ),
                                    },
                                ),
                            },
                            KeyValue {
                                key: "telemetry.sdk.language",
                                value: Some(
                                    AnyValue {
                                        value: Some(
                                            StringValue(
                                                "rust",
                                            ),
                                        ),
                                    },
                                ),
                            },
                            KeyValue {
                                key: "telemetry.sdk.name",
                                value: Some(
                                    AnyValue {
                                        value: Some(
                                            StringValue(
                                                "opentelemetry",
                                            ),
                                        ),
                                    },
                                ),
                            },
                            KeyValue {
                                key: "telemetry.sdk.version",
                                value: Some(
                                    AnyValue {
                                        value: Some(
                                            StringValue(
                                                "0.30.0",
                                            ),
                                        ),
                                    },
                                ),
                            },
                        ],
                        dropped_attributes_count: 0,
                        entity_refs: [],
                    },
                ),
                scope_spans: [
                    ScopeSpans {
                        scope: Some(
                            InstrumentationScope {
                                name: "logfire",
                                version: "",
                                attributes: [],
                                dropped_attributes_count: 0,
                            },
                        ),
                        spans: [
                            Span {
                                trace_id: [
                                    0,
                                    0,
                                    0,
                                    0,
                                    0,
                                    0,
                                    0,
                                    0,
                                    0,
                                    0,
                                    0,
                                    0,
                                    0,
                                    0,
                                    0,
                                    240,
                                ],
                                span_id: [
                                    0,
                                    0,
                                    0,
                                    0,
                                    0,
                                    0,
                                    0,
                                    240,
                                ],
                                trace_state: "",
                                parent_span_id: [],
                                flags: 1,
                                name: "test_span",
                                kind: Internal,
                                start_time_unix_nano: 0,
                                end_time_unix_nano: 1000000000,
                                attributes: [
                                    KeyValue {
                                        key: "busy_ns",
                                        value: Some(
                                            AnyValue {
                                                value: Some(
                                                    IntValue(
                                                        0,
                                                    ),
                                                ),
                                            },
                                        ),
                                    },
                                    KeyValue {
                                        key: "code.filepath",
                                        value: Some(
                                            AnyValue {
                                                value: Some(
                                                    StringValue(
                                                        "tests/test_http_sink.rs",
                                                    ),
                                                ),
                                            },
                                        ),
                                    },
                                    KeyValue {
                                        key: "code.lineno",
                                        value: Some(
                                            AnyValue {
                                                value: Some(
                                                    IntValue(
                                                        55,
                                                    ),
                                                ),
                                            },
                                        ),
                                    },
                                    KeyValue {
                                        key: "code.namespace",
                                        value: Some(
                                            AnyValue {
                                                value: Some(
                                                    StringValue(
                                                        "test_http_sink",
                                                    ),
                                                ),
                                            },
                                        ),
                                    },
                                    KeyValue {
                                        key: "idle_ns",
                                        value: Some(
                                            AnyValue {
                                                value: Some(
                                                    IntValue(
                                                        0,
                                                    ),
                                                ),
                                            },
                                        ),
                                    },
                                    KeyValue {
                                        key: "logfire.json_schema",
                                        value: Some(
                                            AnyValue {
                                                value: Some(
                                                    StringValue(
                                                        "{\"type\":\"object\",\"properties\":{}}",
                                                    ),
                                                ),
                                            },
                                        ),
                                    },
                                    KeyValue {
                                        key: "logfire.level_num",
                                        value: Some(
                                            AnyValue {
                                                value: Some(
                                                    IntValue(
                                                        9,
                                                    ),
                                                ),
                                            },
                                        ),
                                    },
                                    KeyValue {
                                        key: "logfire.msg",
                                        value: Some(
                                            AnyValue {
                                                value: Some(
                                                    StringValue(
                                                        "test_span",
                                                    ),
                                                ),
                                            },
                                        ),
                                    },
                                    KeyValue {
                                        key: "logfire.span_type",
                                        value: Some(
                                            AnyValue {
                                                value: Some(
                                                    StringValue(
                                                        "span",
                                                    ),
                                                ),
                                            },
                                        ),
                                    },
                                    KeyValue {
                                        key: "thread.id",
                                        value: Some(
                                            AnyValue {
                                                value: Some(
                                                    IntValue(
                                                        0,
                                                    ),
                                                ),
                                            },
                                        ),
                                    },
                                    KeyValue {
                                        key: "thread.name",
                                        value: Some(
                                            AnyValue {
                                                value: Some(
                                                    StringValue(
                                                        "test_http_protobuf_export",
                                                    ),
                                                ),
                                            },
                                        ),
                                    },
                                ],
                                dropped_attributes_count: 0,
                                events: [],
                                dropped_events_count: 0,
                                links: [],
                                dropped_links_count: 0,
                                status: Some(
                                    Status {
                                        message: "",
                                        code: Unset,
                                    },
                                ),
                            },
                        ],
                        schema_url: "",
                    },
                ],
                schema_url: "",
            },
        ],
    }
    "#);
}

/// Test HTTP JSON export to mock server
#[tokio::test]
async fn test_http_json_export() {
    let mock_server = MockServer::start().await;

    let traces_mock = Mock::given(method("POST"))
        .and(path("/v1/traces"))
        .and(header("content-type", "application/json"))
        .and(header("authorization", "Bearer test-token"))
        .respond_with(ResponseTemplate::new(200));

    mock_server.register(traces_mock).await;

    let env_guard = ENV_MUTEX.lock().unwrap();
    // SAFETY: Holding mutex to prevent other thread interacting with env
    unsafe {
        std::env::set_var("OTEL_EXPORTER_OTLP_PROTOCOL", "http/json");
    }

    let logfire = configure()
        .local()
        .send_to_logfire(true)
        .with_token("test-token")
        .with_advanced_options(
            AdvancedOptions::default()
                .with_base_url(mock_server.uri())
                .with_id_generator(DeterministicIdGenerator::new()),
        )
        .finish()
        .unwrap();

    // SAFETY: As above
    unsafe {
        std::env::remove_var("OTEL_EXPORTER_OTLP_PROTOCOL");
    }
    drop(env_guard);

    let guard = set_local_logfire(logfire);
    span!("json_test_span").in_scope(|| {});
    guard.shutdown().unwrap();

    let requests = mock_server.received_requests().await.unwrap();
    assert_eq!(requests.len(), 1);
    let request = &requests[0];

    assert_eq!(request.method.as_str(), "POST");
    assert_eq!(request.url.path(), "/v1/traces");
    let mut body: ExportTraceServiceRequest =
        serde_json::from_slice(&request.body).expect("failed to decode trace request");

    make_trace_request_deterministic(&mut body);

    assert_debug_snapshot!(body, @r#"
    ExportTraceServiceRequest {
        resource_spans: [
            ResourceSpans {
                resource: Some(
                    Resource {
                        attributes: [
                            KeyValue {
                                key: "service.name",
                                value: Some(
                                    AnyValue {
                                        value: Some(
                                            StringValue(
                                                "unknown_service",
                                            ),
                                        ),
                                    },
                                ),
                            },
                            KeyValue {
                                key: "telemetry.sdk.language",
                                value: Some(
                                    AnyValue {
                                        value: Some(
                                            StringValue(
                                                "rust",
                                            ),
                                        ),
                                    },
                                ),
                            },
                            KeyValue {
                                key: "telemetry.sdk.name",
                                value: Some(
                                    AnyValue {
                                        value: Some(
                                            StringValue(
                                                "opentelemetry",
                                            ),
                                        ),
                                    },
                                ),
                            },
                            KeyValue {
                                key: "telemetry.sdk.version",
                                value: Some(
                                    AnyValue {
                                        value: Some(
                                            StringValue(
                                                "0.30.0",
                                            ),
                                        ),
                                    },
                                ),
                            },
                        ],
                        dropped_attributes_count: 0,
                        entity_refs: [],
                    },
                ),
                scope_spans: [
                    ScopeSpans {
                        scope: Some(
                            InstrumentationScope {
                                name: "logfire",
                                version: "",
                                attributes: [],
                                dropped_attributes_count: 0,
                            },
                        ),
                        spans: [
                            Span {
                                trace_id: [
                                    0,
                                    0,
                                    0,
                                    0,
                                    0,
                                    0,
                                    0,
                                    0,
                                    0,
                                    0,
                                    0,
                                    0,
                                    0,
                                    0,
                                    0,
                                    240,
                                ],
                                span_id: [
                                    0,
                                    0,
                                    0,
                                    0,
                                    0,
                                    0,
                                    0,
                                    240,
                                ],
                                trace_state: "",
                                parent_span_id: [],
                                flags: 1,
                                name: "json_test_span",
                                kind: Internal,
                                start_time_unix_nano: 0,
                                end_time_unix_nano: 1000000000,
                                attributes: [
                                    KeyValue {
                                        key: "busy_ns",
                                        value: Some(
                                            AnyValue {
                                                value: Some(
                                                    IntValue(
                                                        0,
                                                    ),
                                                ),
                                            },
                                        ),
                                    },
                                    KeyValue {
                                        key: "code.filepath",
                                        value: Some(
                                            AnyValue {
                                                value: Some(
                                                    StringValue(
                                                        "tests/test_http_sink.rs",
                                                    ),
                                                ),
                                            },
                                        ),
                                    },
                                    KeyValue {
                                        key: "code.lineno",
                                        value: Some(
                                            AnyValue {
                                                value: Some(
                                                    IntValue(
                                                        370,
                                                    ),
                                                ),
                                            },
                                        ),
                                    },
                                    KeyValue {
                                        key: "code.namespace",
                                        value: Some(
                                            AnyValue {
                                                value: Some(
                                                    StringValue(
                                                        "test_http_sink",
                                                    ),
                                                ),
                                            },
                                        ),
                                    },
                                    KeyValue {
                                        key: "idle_ns",
                                        value: Some(
                                            AnyValue {
                                                value: Some(
                                                    IntValue(
                                                        0,
                                                    ),
                                                ),
                                            },
                                        ),
                                    },
                                    KeyValue {
                                        key: "logfire.json_schema",
                                        value: Some(
                                            AnyValue {
                                                value: Some(
                                                    StringValue(
                                                        "{\"type\":\"object\",\"properties\":{}}",
                                                    ),
                                                ),
                                            },
                                        ),
                                    },
                                    KeyValue {
                                        key: "logfire.level_num",
                                        value: Some(
                                            AnyValue {
                                                value: Some(
                                                    IntValue(
                                                        9,
                                                    ),
                                                ),
                                            },
                                        ),
                                    },
                                    KeyValue {
                                        key: "logfire.msg",
                                        value: Some(
                                            AnyValue {
                                                value: Some(
                                                    StringValue(
                                                        "json_test_span",
                                                    ),
                                                ),
                                            },
                                        ),
                                    },
                                    KeyValue {
                                        key: "logfire.span_type",
                                        value: Some(
                                            AnyValue {
                                                value: Some(
                                                    StringValue(
                                                        "span",
                                                    ),
                                                ),
                                            },
                                        ),
                                    },
                                    KeyValue {
                                        key: "thread.id",
                                        value: Some(
                                            AnyValue {
                                                value: Some(
                                                    IntValue(
                                                        0,
                                                    ),
                                                ),
                                            },
                                        ),
                                    },
                                    KeyValue {
                                        key: "thread.name",
                                        value: Some(
                                            AnyValue {
                                                value: Some(
                                                    StringValue(
                                                        "test_http_json_export",
                                                    ),
                                                ),
                                            },
                                        ),
                                    },
                                ],
                                dropped_attributes_count: 0,
                                events: [],
                                dropped_events_count: 0,
                                links: [],
                                dropped_links_count: 0,
                                status: Some(
                                    Status {
                                        message: "",
                                        code: Unset,
                                    },
                                ),
                            },
                        ],
                        schema_url: "",
                    },
                ],
                schema_url: "",
            },
        ],
    }
    "#);
}

/// Mutex to avoid concurrent mutation of env vars.
static ENV_MUTEX: std::sync::Mutex<()> = std::sync::Mutex::new(());