tracing-better-stack 0.1.0

A tracing-subscriber layer for Better Stack (Logtail) logging
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
// Base integration tests that work regardless of serialization format

mod common;

use common::BETTER_STACK_ACCEPTED_STATUS;

use futures::executor::block_on;
use std::sync::Arc;
use std::time::Duration;
use tokio::sync::mpsc;
use tracing::{debug, error, info, trace, warn};
use tracing_better_stack::{BetterStackConfig, BetterStackLayer};
use tracing_subscriber::prelude::*;
use wiremock::matchers::{bearer_token, method, path};
use wiremock::{Mock, MockServer, Request, ResponseTemplate};

/// HTTP status code for internal server error, used in tests to simulate failures
const HTTP_INTERNAL_SERVER_ERROR: u16 = 500;

#[tokio::test]
async fn test_basic_logging() {
    let mock_server = MockServer::start().await;

    Mock::given(method("POST"))
        .and(path("/"))
        .and(bearer_token("test-token"))
        .respond_with(ResponseTemplate::new(BETTER_STACK_ACCEPTED_STATUS))
        .expect(1)
        .mount(&mock_server)
        .await;

    let layer = BetterStackLayer::new(
        BetterStackConfig::builder(common::mock_host(&mock_server), "test-token")
            .batch_size(3)
            .batch_timeout(Duration::from_millis(100))
            .build(),
    );

    let subscriber = tracing_subscriber::registry().with(layer);

    tracing::subscriber::with_default(subscriber, || {
        info!("Test message 1");
        warn!("Test message 2");
        error!("Test message 3");
    });

    // Wait for batch to be sent
    tokio::time::sleep(Duration::from_millis(200)).await;

    // Verify the mock was called
    mock_server.verify().await;
}

#[tokio::test]
async fn test_batching_behavior() {
    let mock_server = MockServer::start().await;
    let (tx, mut rx) = mpsc::channel::<()>(10);
    let tx = Arc::new(tx);

    // Track each batch sent
    let tx_clone = tx.clone();
    Mock::given(method("POST"))
        .and(path("/"))
        .and(bearer_token("test-token"))
        .respond_with(move |_req: &Request| {
            let tx = tx_clone.clone();
            tokio::spawn(async move {
                let _ = tx.send(()).await;
            });
            ResponseTemplate::new(BETTER_STACK_ACCEPTED_STATUS)
        })
        .expect(2) // Exactly 2 batches expected
        .mount(&mock_server)
        .await;

    let layer = BetterStackLayer::new(
        BetterStackConfig::builder(common::mock_host(&mock_server), "test-token")
            .batch_size(2)
            .batch_timeout(Duration::from_millis(5000)) // Long timeout to avoid timeout-based batching
            .build(),
    );

    let subscriber = tracing_subscriber::registry().with(layer);

    let _guard = tracing::subscriber::set_default(subscriber);

    // First batch (size limit reached)
    info!("Message 1");
    info!("Message 2");

    // Wait for first batch confirmation
    tokio::time::timeout(Duration::from_millis(500), rx.recv())
        .await
        .expect("First batch timeout")
        .expect("First batch not received");

    // Second batch (size limit reached)
    info!("Message 3");
    info!("Message 4");

    // Wait for second batch confirmation
    tokio::time::timeout(Duration::from_millis(500), rx.recv())
        .await
        .expect("Second batch timeout")
        .expect("Second batch not received");

    mock_server.verify().await;
}

#[tokio::test]
async fn test_timeout_batching() {
    let mock_server = MockServer::start().await;

    // Expect 1 batch sent after timeout
    Mock::given(method("POST"))
        .and(path("/"))
        .and(bearer_token("test-token"))
        .respond_with(ResponseTemplate::new(BETTER_STACK_ACCEPTED_STATUS))
        .expect(1)
        .mount(&mock_server)
        .await;

    let layer = BetterStackLayer::new(
        BetterStackConfig::builder(common::mock_host(&mock_server), "test-token")
            .batch_size(100) // Large batch size
            .batch_timeout(Duration::from_millis(200))
            .build(),
    );

    let subscriber = tracing_subscriber::registry().with(layer);

    tracing::subscriber::with_default(subscriber, || {
        info!("Single message");
    });

    // Wait for timeout to trigger batch send
    tokio::time::sleep(Duration::from_millis(400)).await;

    mock_server.verify().await;
}

#[tokio::test]
async fn test_retry_on_failure() {
    let mock_server = MockServer::start().await;

    // All 3 attempts fail (initial + 2 retries with max_retries=2)
    Mock::given(method("POST"))
        .and(path("/"))
        .and(bearer_token("test-token"))
        .respond_with(ResponseTemplate::new(HTTP_INTERNAL_SERVER_ERROR))
        .expect(3) // Initial attempt + 2 retries
        .mount(&mock_server)
        .await;

    let layer = BetterStackLayer::new(
        BetterStackConfig::builder(common::mock_host(&mock_server), "test-token")
            .batch_size(1)
            .max_retries(2)
            .initial_retry_delay(Duration::from_millis(50))
            .build(),
    );

    let subscriber = tracing_subscriber::registry().with(layer);

    tracing::subscriber::with_default(subscriber, || {
        info!("Test message");
    });

    // Wait for retries to complete (initial + 50ms + 100ms delays + buffer)
    tokio::time::sleep(Duration::from_millis(300)).await;

    // Verify exactly 3 attempts were made
    mock_server.verify().await;
}

#[tokio::test]
async fn test_retry_with_eventual_success() {
    let mock_server = MockServer::start().await;
    let attempt_count = Arc::new(tokio::sync::Mutex::new(0));
    let attempt_count_clone = attempt_count.clone();

    // Fail twice, then succeed
    Mock::given(method("POST"))
        .and(path("/"))
        .and(bearer_token("test-token"))
        .respond_with(move |_req: &Request| {
            let count = attempt_count_clone.clone();
            // Using blocking lock to avoid runtime issues
            let mut c = block_on(count.lock());
            *c += 1;
            if *c <= 2 {
                ResponseTemplate::new(HTTP_INTERNAL_SERVER_ERROR)
            } else {
                ResponseTemplate::new(BETTER_STACK_ACCEPTED_STATUS)
            }
        })
        .expect(3) // 2 failures + 1 success
        .mount(&mock_server)
        .await;

    let layer = BetterStackLayer::new(
        BetterStackConfig::builder(common::mock_host(&mock_server), "test-token")
            .batch_size(1)
            .max_retries(3)
            .initial_retry_delay(Duration::from_millis(50))
            .build(),
    );

    let subscriber = tracing_subscriber::registry().with(layer);

    tracing::subscriber::with_default(subscriber, || {
        info!("Test message that eventually succeeds");
    });

    // Wait for retries to complete
    tokio::time::sleep(Duration::from_millis(300)).await;

    mock_server.verify().await;
    let final_count = *attempt_count.lock().await;
    assert_eq!(final_count, 3, "Should have made exactly 3 attempts");
}

#[tokio::test]
async fn test_concurrent_logging() {
    let mock_server = MockServer::start().await;

    // Expect multiple batches from concurrent threads
    Mock::given(method("POST"))
        .and(path("/"))
        .and(bearer_token("test-token"))
        .respond_with(ResponseTemplate::new(BETTER_STACK_ACCEPTED_STATUS))
        .expect(3..) // At least 3 batches (25 logs with batch size 10)
        .mount(&mock_server)
        .await;

    let layer = BetterStackLayer::new(
        BetterStackConfig::builder(common::mock_host(&mock_server), "test-token")
            .batch_size(10)
            .batch_timeout(Duration::from_millis(100))
            .build(),
    );

    let _subscriber = tracing::subscriber::set_default(tracing_subscriber::registry().with(layer));

    // Spawn multiple concurrent logging tasks
    let handles: Vec<_> = (0..5)
        .map(|thread_id| {
            tokio::spawn(async move {
                for i in 0..5 {
                    info!(thread = thread_id, iter = i, "Concurrent log");
                    tokio::time::sleep(Duration::from_micros(100)).await;
                }
            })
        })
        .collect();

    // Wait for all tasks to complete
    for handle in handles {
        handle.await.unwrap();
    }

    // Wait for batches to be sent
    tokio::time::sleep(Duration::from_millis(200)).await;

    mock_server.verify().await;
}

#[tokio::test]
async fn test_graceful_shutdown() {
    let mock_server = MockServer::start().await;
    let (shutdown_tx, mut shutdown_rx) = mpsc::channel::<()>(1);

    Mock::given(method("POST"))
        .and(path("/"))
        .and(bearer_token("test-token"))
        .respond_with(move |_req: &Request| {
            let tx = shutdown_tx.clone();
            tokio::spawn(async move {
                let _ = tx.send(()).await;
            });
            ResponseTemplate::new(BETTER_STACK_ACCEPTED_STATUS)
        })
        .expect(1)
        .mount(&mock_server)
        .await;

    {
        let layer = BetterStackLayer::new(
            BetterStackConfig::builder(common::mock_host(&mock_server), "test-token")
                .batch_size(10) // Large batch to ensure timeout doesn't trigger
                .batch_timeout(Duration::from_secs(10))
                .build(),
        );

        let subscriber = tracing_subscriber::registry().with(layer);

        tracing::subscriber::with_default(subscriber, || {
            info!("Log before shutdown");
            warn!("This should be sent on drop");
        });

        // Layer drops here, should trigger flush
    }

    // Wait for shutdown flush
    tokio::time::timeout(Duration::from_millis(500), shutdown_rx.recv())
        .await
        .expect("Shutdown flush timeout")
        .expect("Shutdown batch not received");

    mock_server.verify().await;
}

#[tokio::test]
async fn test_configuration_validation() {
    // Test various configurations
    // Empty host is allowed but will fail at runtime when trying to send
    let config = BetterStackConfig::builder("", "token")
        .batch_size(1)
        .build();
    assert!(config.ingesting_host.is_empty());

    // Empty token is allowed but will fail at runtime with auth error
    let config = BetterStackConfig::builder("host", "").build();
    assert!(config.source_token.is_empty());

    // Test with valid values
    let config = BetterStackConfig::builder("host", "token")
        .batch_size(1)
        .max_retries(0)
        .build();

    // Verify batch_size is at least 1
    assert!(config.batch_size >= 1, "Batch size should be at least 1");
}

#[tokio::test]
async fn test_large_payload_handling() {
    let mock_server = MockServer::start().await;

    Mock::given(method("POST"))
        .and(path("/"))
        .and(bearer_token("test-token"))
        .respond_with(ResponseTemplate::new(BETTER_STACK_ACCEPTED_STATUS))
        .expect(1)
        .mount(&mock_server)
        .await;

    let layer = BetterStackLayer::new(
        BetterStackConfig::builder(common::mock_host(&mock_server), "test-token")
            .batch_size(5)
            .batch_timeout(Duration::from_millis(100))
            .build(),
    );

    let subscriber = tracing_subscriber::registry().with(layer);

    tracing::subscriber::with_default(subscriber, || {
        // Create a very large message
        let large_string = "x".repeat(10000);
        info!(large_field = %large_string, "Large message");

        // Multiple messages with large fields
        for i in 0..4 {
            let data = format!("data_{}", "y".repeat(1000));
            warn!(id = i, data = %data, "Large field message");
        }
    });

    // Wait for batch to be sent
    tokio::time::sleep(Duration::from_millis(200)).await;

    mock_server.verify().await;
}

#[tokio::test]
async fn test_different_log_levels() {
    let mock_server = MockServer::start().await;

    Mock::given(method("POST"))
        .and(path("/"))
        .and(bearer_token("test-token"))
        .respond_with(ResponseTemplate::new(BETTER_STACK_ACCEPTED_STATUS))
        .expect(1)
        .mount(&mock_server)
        .await;

    let layer = BetterStackLayer::new(
        BetterStackConfig::builder(common::mock_host(&mock_server), "test-token")
            .batch_size(5)
            .batch_timeout(Duration::from_millis(100))
            .build(),
    );

    let subscriber = tracing_subscriber::registry().with(layer);

    tracing::subscriber::with_default(subscriber, || {
        trace!("Trace level message");
        debug!("Debug level message");
        info!("Info level message");
        warn!("Warning level message");
        error!("Error level message");
    });

    // Wait for batch to be sent
    tokio::time::sleep(Duration::from_millis(200)).await;

    mock_server.verify().await;
}

#[tokio::test]
async fn test_message_ordering_preservation() {
    let mock_server = MockServer::start().await;
    let captured_bodies = Arc::new(tokio::sync::Mutex::new(Vec::new()));
    let body_matcher = common::BodyCaptureMatcher {
        captured: captured_bodies.clone(),
    };

    Mock::given(method("POST"))
        .and(path("/"))
        .and(bearer_token("test-token"))
        .and(body_matcher)
        .respond_with(ResponseTemplate::new(BETTER_STACK_ACCEPTED_STATUS))
        .expect(1)
        .mount(&mock_server)
        .await;

    let layer = BetterStackLayer::new(
        BetterStackConfig::builder(common::mock_host(&mock_server), "test-token")
            .batch_size(10)
            .batch_timeout(Duration::from_millis(100))
            .build(),
    );

    let subscriber = tracing_subscriber::registry().with(layer);

    tracing::subscriber::with_default(subscriber, || {
        for i in 0..10 {
            info!(seq = i, "Ordered message {}", i);
        }
    });

    // Wait for batch to be sent
    tokio::time::sleep(Duration::from_millis(200)).await;

    mock_server.verify().await;

    // Verify message ordering is preserved
    let bodies = captured_bodies.lock().await;
    assert_eq!(bodies.len(), 1, "Should have captured one batch");

    // Parse the body based on feature flag
    #[cfg(feature = "json")]
    {
        let body = &bodies[0];
        let json: serde_json::Value =
            serde_json::from_slice(body).expect("Body should be valid JSON");
        let batch_array = json.as_array().unwrap();

        for (i, log) in batch_array.iter().enumerate() {
            assert_eq!(log["fields"]["seq"], i as i64);
            assert_eq!(log["message"], format!("Ordered message {}", i));
        }
    }

    #[cfg(feature = "message_pack")]
    {
        let body = &bodies[0];
        let value: serde_json::Value =
            rmp_serde::from_slice(body).expect("Body should be valid MessagePack");
        let batch_array = value.as_array().unwrap();

        for (i, log) in batch_array.iter().enumerate() {
            assert_eq!(log["fields"]["seq"], i as i64);
            assert_eq!(log["message"], format!("Ordered message {}", i));
        }
    }
}