eyes-subscriber 0.4.1

Tracing subscriber for sending traces to Eyes (eyes.coreyja.com)
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
use std::sync::atomic::{AtomicU64, Ordering};
use std::sync::Arc;
use std::time::Duration;

use async_trait::async_trait;
use chrono::Utc;
use tokio::sync::{mpsc, oneshot};
use tokio::time::Instant;

use crate::EventData;

#[async_trait]
pub(crate) trait Transport: Send + Sync + 'static {
    async fn connect(&mut self) -> Result<(), TransportError>;
    async fn send(&mut self, event: EventData) -> Result<(), TransportError>;
    async fn close(&mut self) -> Result<(), TransportError>;
}

#[derive(Debug, thiserror::Error)]
pub enum TransportError {
    #[error("Connection error: {0}")]
    Connection(String),
    #[error("Send error: {0}")]
    Send(String),
    #[error("Configuration error: {0}")]
    Configuration(String),
}

/// Tuning knobs for the transport loop. Injectable so tests can avoid real sleeps.
pub(crate) struct TransportLoopConfig {
    /// Delays between retry attempts after a failed send.
    pub retry_backoff: Vec<Duration>,
    /// Total retry time allowed during shutdown flush so shutdown never hangs.
    pub shutdown_retry_budget: Duration,
    /// How often to check the drop counter and emit a backpressure warning event.
    pub flush_interval: Duration,
}

impl Default for TransportLoopConfig {
    fn default() -> Self {
        Self {
            retry_backoff: vec![
                Duration::from_millis(100),
                Duration::from_secs(1),
                Duration::from_secs(5),
            ],
            shutdown_retry_budget: Duration::from_secs(3),
            flush_interval: Duration::from_secs(5),
        }
    }
}

/// Send an event, retrying with backoff on failure. A deadline (used during
/// shutdown) caps the total time spent sleeping between attempts.
async fn send_with_retry(
    transport: &mut dyn Transport,
    event: &EventData,
    backoff: &[Duration],
    deadline: Option<Instant>,
) -> Result<(), TransportError> {
    let mut last_err = match transport.send(event.clone()).await {
        Ok(()) => return Ok(()),
        Err(e) => e,
    };

    for delay in backoff {
        let delay = match deadline {
            Some(deadline) => {
                let remaining = deadline.saturating_duration_since(Instant::now());
                if remaining.is_zero() {
                    return Err(last_err);
                }
                (*delay).min(remaining)
            }
            None => *delay,
        };
        tokio::time::sleep(delay).await;

        match transport.send(event.clone()).await {
            Ok(()) => return Ok(()),
            Err(e) => last_err = e,
        }
    }

    Err(last_err)
}

fn dropped_events_warning(dropped_count: u64) -> EventData {
    EventData {
        event_type: "event".to_string(),
        event_data: serde_json::json!({
            "level": "WARN",
            "target": "eyes_subscriber",
            "fields": {
                "message": "events dropped by eyes-subscriber backpressure",
                "dropped_count": dropped_count,
            },
        }),
        event_timestamp: Utc::now(),
    }
}

/// If any events were dropped, emit a synthetic warning event and reset the
/// counter. On failure the count is restored so it gets reported later.
async fn report_dropped_events(
    transport: &mut dyn Transport,
    dropped: &AtomicU64,
    backoff: &[Duration],
    deadline: Option<Instant>,
) {
    let count = dropped.swap(0, Ordering::Relaxed);
    if count == 0 {
        return;
    }

    if let Err(e) =
        send_with_retry(transport, &dropped_events_warning(count), backoff, deadline).await
    {
        eprintln!("Failed to report {} dropped events: {}", count, e);
        dropped.fetch_add(count, Ordering::Relaxed);
    }
}

/// Drain any remaining queued events under a single shared deadline so
/// shutdown never hangs on a dead transport.
async fn shutdown_flush(
    transport: &mut dyn Transport,
    receiver: &mut mpsc::Receiver<EventData>,
    dropped: &AtomicU64,
    config: &TransportLoopConfig,
    deadline: Instant,
    pending: Option<EventData>,
) {
    let mut next = pending;
    loop {
        let event = match next.take() {
            Some(event) => event,
            None => match receiver.try_recv() {
                Ok(event) => event,
                Err(_) => break,
            },
        };
        if let Err(e) =
            send_with_retry(transport, &event, &config.retry_backoff, Some(deadline)).await
        {
            eprintln!("Failed to send event during shutdown, dropping: {}", e);
            dropped.fetch_add(1, Ordering::Relaxed);
        }
    }
}

pub(crate) async fn run_transport_loop(
    mut transport: Box<dyn Transport>,
    mut receiver: mpsc::Receiver<EventData>,
    mut shutdown_rx: oneshot::Receiver<()>,
    completion_tx: oneshot::Sender<()>,
    dropped: Arc<AtomicU64>,
    config: TransportLoopConfig,
) {
    if let Err(e) = transport.connect().await {
        eprintln!("Failed to connect transport: {}", e);
        let _ = completion_tx.send(());
        return;
    }

    let mut flush_interval = tokio::time::interval(config.flush_interval);
    flush_interval.set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);
    // Skip the immediate first tick so a fresh loop doesn't report right away.
    flush_interval.tick().await;

    // One retry budget shared by the shutdown flush and the final drop report,
    // so total shutdown time stays bounded.
    let mut shutdown_deadline: Option<Instant> = None;

    // Dropping the EyesShutdownHandle without calling shutdown() closes the
    // oneshot with a RecvError. That must NOT stop the loop: apps commonly
    // call setup_tracing as a bare statement and drop the handle immediately,
    // and telemetry should keep flowing for the process lifetime. Only an
    // explicit shutdown() (Ok) triggers the drain-and-exit path. The guard
    // also keeps the completed oneshot from being polled again (which panics).
    let mut shutdown_signal_done = false;

    loop {
        tokio::select! {
            event = receiver.recv() => {
                let Some(event) = event else {
                    // All senders dropped; nothing left to receive.
                    break;
                };
                // Race the (potentially sleeping) retry against shutdown so a
                // dead transport can't delay shutdown by a full backoff cycle.
                let result = tokio::select! {
                    result = send_with_retry(
                        transport.as_mut(),
                        &event,
                        &config.retry_backoff,
                        None,
                    ) => Some(result),
                    res = &mut shutdown_rx, if !shutdown_signal_done => {
                        shutdown_signal_done = true;
                        match res {
                            Ok(()) => None,
                            // Handle dropped mid-send: not a shutdown. The
                            // in-flight send was cancelled; send this event
                            // again (worst case a duplicate, never a loss).
                            Err(_) => Some(send_with_retry(
                                transport.as_mut(),
                                &event,
                                &config.retry_backoff,
                                None,
                            ).await),
                        }
                    }
                };
                match result {
                    Some(Ok(())) => {}
                    Some(Err(e)) => {
                        eprintln!("Failed to send event after retries, dropping: {}", e);
                        dropped.fetch_add(1, Ordering::Relaxed);
                    }
                    None => {
                        // Shutdown arrived mid-retry: give this event and the
                        // rest of the queue one capped flush, then stop.
                        let deadline = Instant::now() + config.shutdown_retry_budget;
                        shutdown_deadline = Some(deadline);
                        shutdown_flush(
                            transport.as_mut(),
                            &mut receiver,
                            &dropped,
                            &config,
                            deadline,
                            Some(event),
                        )
                        .await;
                        break;
                    }
                }
            }
            _ = flush_interval.tick() => {
                // Single attempt, no backoff sleeps: if the transport is still
                // down the count is restored and reported on a later cycle
                // instead of stalling the loop.
                report_dropped_events(transport.as_mut(), &dropped, &[], None).await;
            }
            res = &mut shutdown_rx, if !shutdown_signal_done => {
                shutdown_signal_done = true;
                // A dropped handle (Err) is not a shutdown: keep shipping
                // until the event channel itself closes.
                if res.is_ok() {
                    let deadline = Instant::now() + config.shutdown_retry_budget;
                    shutdown_deadline = Some(deadline);
                    shutdown_flush(
                        transport.as_mut(),
                        &mut receiver,
                        &dropped,
                        &config,
                        deadline,
                        None,
                    )
                    .await;
                    break;
                }
            }
        }
    }

    // Final chance to report any drops before closing.
    let deadline =
        shutdown_deadline.unwrap_or_else(|| Instant::now() + config.shutdown_retry_budget);
    report_dropped_events(
        transport.as_mut(),
        &dropped,
        &config.retry_backoff,
        Some(deadline),
    )
    .await;

    if let Err(e) = transport.close().await {
        eprintln!("Failed to close transport: {}", e);
    }

    let _ = completion_tx.send(());
}

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

    fn test_event(event_type: &str) -> EventData {
        EventData {
            event_type: event_type.to_string(),
            event_data: serde_json::json!({}),
            event_timestamp: Utc::now(),
        }
    }

    fn fast_config() -> TransportLoopConfig {
        TransportLoopConfig {
            retry_backoff: vec![
                Duration::from_millis(1),
                Duration::from_millis(1),
                Duration::from_millis(1),
            ],
            shutdown_retry_budget: Duration::from_millis(50),
            flush_interval: Duration::from_millis(10),
        }
    }

    /// Mock transport that records sent events and fails the first
    /// `failures_remaining` send attempts.
    struct MockTransport {
        sent: Arc<Mutex<Vec<EventData>>>,
        attempts: Arc<AtomicU64>,
        failures_remaining: Arc<AtomicU64>,
    }

    impl MockTransport {
        fn new(failures: u64) -> Self {
            Self {
                sent: Arc::new(Mutex::new(Vec::new())),
                attempts: Arc::new(AtomicU64::new(0)),
                failures_remaining: Arc::new(AtomicU64::new(failures)),
            }
        }

        fn handles(&self) -> (Arc<Mutex<Vec<EventData>>>, Arc<AtomicU64>) {
            (self.sent.clone(), self.attempts.clone())
        }
    }

    #[async_trait]
    impl Transport for MockTransport {
        async fn connect(&mut self) -> Result<(), TransportError> {
            Ok(())
        }

        async fn send(&mut self, event: EventData) -> Result<(), TransportError> {
            self.attempts.fetch_add(1, Ordering::Relaxed);
            let remaining = self.failures_remaining.load(Ordering::Relaxed);
            if remaining > 0 {
                self.failures_remaining
                    .store(remaining - 1, Ordering::Relaxed);
                return Err(TransportError::Send("mock failure".to_string()));
            }
            self.sent.lock().unwrap().push(event);
            Ok(())
        }

        async fn close(&mut self) -> Result<(), TransportError> {
            Ok(())
        }
    }

    #[tokio::test]
    async fn test_send_with_retry_recovers_from_transient_failure() {
        let mut transport = MockTransport::new(2);
        let (sent, attempts) = transport.handles();
        let backoff = [Duration::from_millis(1); 3];

        let result = send_with_retry(&mut transport, &test_event("event"), &backoff, None).await;

        assert!(result.is_ok());
        assert_eq!(attempts.load(Ordering::Relaxed), 3);
        assert_eq!(sent.lock().unwrap().len(), 1);
    }

    #[tokio::test]
    async fn test_retry_then_drop_on_persistent_failure() {
        let mut transport = MockTransport::new(u64::MAX);
        let (sent, attempts) = transport.handles();
        let backoff = [Duration::from_millis(1); 3];

        let result = send_with_retry(&mut transport, &test_event("event"), &backoff, None).await;

        assert!(result.is_err());
        // Initial attempt plus one retry per backoff step.
        assert_eq!(attempts.load(Ordering::Relaxed), 4);
        assert!(sent.lock().unwrap().is_empty());
    }

    #[tokio::test]
    async fn test_transport_loop_counts_drops_on_persistent_failure() {
        let transport = MockTransport::new(u64::MAX);
        let (sent, _) = transport.handles();

        let (sender, receiver) = mpsc::channel(16);
        let (_shutdown_tx, shutdown_rx) = oneshot::channel();
        let (completion_tx, completion_rx) = oneshot::channel();
        let dropped = Arc::new(AtomicU64::new(0));

        let loop_handle = tokio::spawn(run_transport_loop(
            Box::new(transport),
            receiver,
            shutdown_rx,
            completion_tx,
            dropped.clone(),
            fast_config(),
        ));

        sender.try_send(test_event("event")).unwrap();
        drop(sender);

        loop_handle.await.unwrap();
        completion_rx.await.unwrap();

        assert_eq!(dropped.load(Ordering::Relaxed), 1);
        assert!(sent.lock().unwrap().is_empty());
    }

    #[tokio::test]
    async fn test_drop_counter_emits_synthetic_event_on_recovery() {
        let transport = MockTransport::new(0);
        let (sent, _) = transport.handles();

        let (sender, receiver) = mpsc::channel(16);
        let (shutdown_tx, shutdown_rx) = oneshot::channel();
        let (completion_tx, completion_rx) = oneshot::channel();
        let dropped = Arc::new(AtomicU64::new(7));

        let loop_handle = tokio::spawn(run_transport_loop(
            Box::new(transport),
            receiver,
            shutdown_rx,
            completion_tx,
            dropped.clone(),
            fast_config(),
        ));

        // Wait for at least one flush cycle to report the drops.
        tokio::time::sleep(Duration::from_millis(50)).await;

        assert_eq!(dropped.load(Ordering::Relaxed), 0);
        {
            let sent = sent.lock().unwrap();
            assert_eq!(sent.len(), 1);
            let event = &sent[0];
            assert_eq!(event.event_type, "event");
            assert_eq!(event.event_data["level"], "WARN");
            assert_eq!(event.event_data["target"], "eyes_subscriber");
            assert_eq!(
                event.event_data["fields"]["message"],
                "events dropped by eyes-subscriber backpressure"
            );
            assert_eq!(event.event_data["fields"]["dropped_count"], 7);
        }

        let _ = shutdown_tx.send(());
        loop_handle.await.unwrap();
        completion_rx.await.unwrap();

        // Counter stays reset and no duplicate report is emitted at shutdown.
        assert_eq!(dropped.load(Ordering::Relaxed), 0);
        assert_eq!(sent.lock().unwrap().len(), 1);

        drop(sender);
    }

    #[tokio::test]
    async fn test_failed_drop_report_restores_counter() {
        let transport = MockTransport::new(u64::MAX);
        let (sent, _) = transport.handles();

        let (sender, receiver) = mpsc::channel(16);
        let (shutdown_tx, shutdown_rx) = oneshot::channel();
        let (completion_tx, completion_rx) = oneshot::channel();
        let dropped = Arc::new(AtomicU64::new(5));

        let loop_handle = tokio::spawn(run_transport_loop(
            Box::new(transport),
            receiver,
            shutdown_rx,
            completion_tx,
            dropped.clone(),
            fast_config(),
        ));

        // Let a few flush cycles fail to report against the dead transport.
        tokio::time::sleep(Duration::from_millis(50)).await;

        let _ = shutdown_tx.send(());
        loop_handle.await.unwrap();
        completion_rx.await.unwrap();

        // The count is never lost: every failed report restores it.
        assert_eq!(dropped.load(Ordering::Relaxed), 5);
        assert!(sent.lock().unwrap().is_empty());

        drop(sender);
    }

    #[tokio::test]
    async fn test_shutdown_flush_respects_retry_budget() {
        let transport = MockTransport::new(u64::MAX);

        let (sender, receiver) = mpsc::channel(16);
        let (shutdown_tx, shutdown_rx) = oneshot::channel();
        let (completion_tx, completion_rx) = oneshot::channel();
        let dropped = Arc::new(AtomicU64::new(0));

        let mut config = fast_config();
        // Long backoff that must be capped by the shutdown budget.
        config.retry_backoff = vec![Duration::from_secs(60)];
        config.shutdown_retry_budget = Duration::from_millis(20);

        let loop_handle = tokio::spawn(run_transport_loop(
            Box::new(transport),
            receiver,
            shutdown_rx,
            completion_tx,
            dropped.clone(),
            config,
        ));

        for _ in 0..3 {
            sender.try_send(test_event("event")).unwrap();
        }
        let _ = shutdown_tx.send(());

        let start = std::time::Instant::now();
        loop_handle.await.unwrap();
        completion_rx.await.unwrap();

        assert!(
            start.elapsed() < Duration::from_secs(5),
            "shutdown flush should not hang on a dead transport"
        );
        assert_eq!(dropped.load(Ordering::Relaxed), 3);
    }

    #[tokio::test]
    async fn test_shutdown_cancels_in_flight_retry() {
        let transport = MockTransport::new(u64::MAX);

        let (sender, receiver) = mpsc::channel(16);
        let (shutdown_tx, shutdown_rx) = oneshot::channel();
        let (completion_tx, completion_rx) = oneshot::channel();
        let dropped = Arc::new(AtomicU64::new(0));

        let mut config = fast_config();
        // Without cancellation, the in-flight retry would sleep for 60s.
        config.retry_backoff = vec![Duration::from_secs(60)];
        config.shutdown_retry_budget = Duration::from_millis(20);

        let loop_handle = tokio::spawn(run_transport_loop(
            Box::new(transport),
            receiver,
            shutdown_rx,
            completion_tx,
            dropped.clone(),
            config,
        ));

        sender.try_send(test_event("event")).unwrap();
        // Give the loop time to start the send and enter the retry sleep.
        tokio::time::sleep(Duration::from_millis(10)).await;
        let _ = shutdown_tx.send(());

        let start = std::time::Instant::now();
        loop_handle.await.unwrap();
        completion_rx.await.unwrap();

        assert!(
            start.elapsed() < Duration::from_secs(5),
            "shutdown should cancel an in-flight retry instead of waiting out the backoff"
        );
        assert_eq!(dropped.load(Ordering::Relaxed), 1);
    }
    #[tokio::test]
    async fn test_dropped_handle_does_not_stop_the_loop() {
        let transport = MockTransport::new(0);
        let (sent, _) = transport.handles();

        let (sender, receiver) = mpsc::channel(16);
        let (shutdown_tx, shutdown_rx) = oneshot::channel();
        let (completion_tx, completion_rx) = oneshot::channel();

        let loop_handle = tokio::spawn(run_transport_loop(
            Box::new(transport),
            receiver,
            shutdown_rx,
            completion_tx,
            Arc::new(AtomicU64::new(0)),
            fast_config(),
        ));

        // Simulate `setup_tracing(..);` as a bare statement: the handle's
        // sender is dropped without ever calling shutdown().
        drop(shutdown_tx);
        tokio::time::sleep(Duration::from_millis(20)).await;

        // Events enqueued AFTER the handle drop must still be delivered.
        sender.send(test_event("after_drop_1")).await.unwrap();
        sender.send(test_event("after_drop_2")).await.unwrap();
        tokio::time::sleep(Duration::from_millis(50)).await;

        assert_eq!(
            sent.lock().unwrap().len(),
            2,
            "events after handle drop must still be delivered"
        );

        // The loop still exits cleanly once the event channel closes.
        drop(sender);
        completion_rx.await.expect("loop should complete");
        loop_handle.await.unwrap();
    }
}