rust-loguru 0.1.18

A flexible and extensible logging library for Rust. Similar functionality as python's loguru package.
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
use std::sync::Arc;
use std::sync::atomic::{AtomicBool, AtomicUsize, Ordering};
use std::thread::{self, JoinHandle};
use std::time::Duration;

use crossbeam_channel::{bounded, Receiver, Sender};
use parking_lot::RwLock;

use crate::level::LogLevel;
use crate::record::Record;
use crate::handler::{Handler, HandlerRef, HandlerError};
use crate::formatters::Formatter;
use crate::handler::HandlerFilter;

const DEFAULT_BATCH_SIZE: usize = 32;
const DEFAULT_FLUSH_INTERVAL: Duration = Duration::from_millis(100);

/// Async logging command type
#[derive(Debug)]
pub enum AsyncCommand {
    /// Log a record
    Log(Record),
    /// Flush all handlers
    Flush,
    /// Shut down the async logger
    Shutdown,
}

/// Handle to the async logger
#[derive(Clone, Debug)]
pub struct AsyncLoggerHandle {
    /// Channel for sending commands to the async logger
    sender: Sender<AsyncCommand>,
    /// Flag indicating whether the async logger is running
    running: Arc<AtomicBool>,
    /// Number of queued records
    queued_records: Arc<AtomicUsize>,
}

impl AsyncLoggerHandle {
    /// Log a record
    pub fn log(&self, record: Record) -> bool {
        if !self.running.load(Ordering::Relaxed) {
            return false;
        }

        match self.sender.try_send(AsyncCommand::Log(record)) {
            Ok(_) => {
                self.queued_records.fetch_add(1, Ordering::Relaxed);
                true
            }
            Err(_) => false,
        }
    }

    /// Flush all handlers
    pub fn flush(&self) -> bool {
        if !self.running.load(Ordering::Relaxed) {
            return false;
        }

        self.sender.try_send(AsyncCommand::Flush).is_ok()
    }

    /// Shut down the async logger
    pub fn shutdown(&self) {
        if !self.running.load(Ordering::Relaxed) {
            return;
        }

        // Send shutdown command and update running flag
        let _ = self.sender.send(AsyncCommand::Shutdown);
        self.running.store(false, Ordering::Relaxed);
    }

    /// Get the number of queued records
    pub fn queued_records(&self) -> usize {
        self.queued_records.load(Ordering::Relaxed)
    }
}

impl Drop for AsyncLoggerHandle {
    fn drop(&mut self) {
        self.shutdown();
    }
}

/// Builder for the async logger
pub struct AsyncLoggerBuilder {
    /// Queue size
    queue_size: usize,
    /// Handler registry
    handlers: Vec<HandlerRef>,
    /// Log level
    level: LogLevel,
    /// Number of worker threads
    workers: usize,
    /// Batch size for processing records
    batch_size: usize,
    /// Flush interval
    flush_interval: Duration,
}

impl AsyncLoggerBuilder {
    /// Create a new async logger builder
    pub fn new() -> Self {
        Self {
            queue_size: 10000,
            handlers: Vec::new(),
            level: LogLevel::Info,
            workers: 1,
            batch_size: DEFAULT_BATCH_SIZE,
            flush_interval: DEFAULT_FLUSH_INTERVAL,
        }
    }

    /// Set the queue size
    pub fn with_queue_size(mut self, queue_size: usize) -> Self {
        self.queue_size = queue_size;
        self
    }

    /// Set the handlers
    pub fn with_handlers(mut self, handlers: Vec<HandlerRef>) -> Self {
        self.handlers = handlers;
        self
    }

    /// Set the log level
    pub fn with_level(mut self, level: LogLevel) -> Self {
        self.level = level;
        self
    }

    /// Set the number of worker threads
    pub fn with_workers(mut self, workers: usize) -> Self {
        self.workers = workers;
        self
    }

    /// Set the batch size
    pub fn with_batch_size(mut self, batch_size: usize) -> Self {
        self.batch_size = batch_size;
        self
    }

    /// Set the flush interval
    pub fn with_flush_interval(mut self, flush_interval: Duration) -> Self {
        self.flush_interval = flush_interval;
        self
    }

    /// Build the async logger
    pub fn build(self) -> AsyncLoggerHandle {
        // Create a channel for sending commands to the worker thread
        let (sender, receiver) = bounded(self.queue_size);

        // Create a running flag and queued records counter
        let running = Arc::new(AtomicBool::new(true));
        let queued_records = Arc::new(AtomicUsize::new(0));

        // Spawn the worker threads
        let mut workers = Vec::with_capacity(self.workers);
        for _ in 0..self.workers {
            let worker = AsyncWorker::new(
                receiver.clone(),
                self.handlers.clone(),
                self.level,
                running.clone(),
                queued_records.clone(),
                self.batch_size,
                self.flush_interval,
            );
            workers.push(worker.spawn());
        }

        // Create the async logger handle
        AsyncLoggerHandle {
            sender,
            running,
            queued_records,
        }
    }
}

/// Worker thread for processing async log records
struct AsyncWorker {
    /// Channel for receiving commands
    receiver: Receiver<AsyncCommand>,
    /// Handler registry
    handlers: Vec<HandlerRef>,
    /// Log level
    level: LogLevel,
    /// Running flag
    running: Arc<AtomicBool>,
    /// Queued records counter
    queued_records: Arc<AtomicUsize>,
    /// Batch size
    batch_size: usize,
    /// Flush interval
    flush_interval: Duration,
}

impl AsyncWorker {
    /// Create a new worker
    fn new(
        receiver: Receiver<AsyncCommand>,
        handlers: Vec<HandlerRef>,
        level: LogLevel,
        running: Arc<AtomicBool>,
        queued_records: Arc<AtomicUsize>,
        batch_size: usize,
        flush_interval: Duration,
    ) -> Self {
        Self {
            receiver,
            handlers,
            level,
            running,
            queued_records,
            batch_size,
            flush_interval,
        }
    }

    /// Spawn the worker thread
    fn spawn(self) -> JoinHandle<()> {
        thread::spawn(move || self.run())
    }

    /// Run the worker loop
    fn run(mut self) {
        // Preallocate batch buffer
        let mut batch = Vec::with_capacity(self.batch_size);
        let mut last_flush = std::time::Instant::now();

        while self.running.load(Ordering::Relaxed) {
            match self.receiver.recv_timeout(self.flush_interval) {
                Ok(AsyncCommand::Log(record)) => {
                    batch.push(record);
                    self.queued_records.fetch_sub(1, Ordering::Relaxed);

                    // Process batch if full
                    if batch.len() >= self.batch_size {
                        self.process_batch(&mut batch);
                        last_flush = std::time::Instant::now();
                    }
                }
                Ok(AsyncCommand::Flush) => {
                    self.process_batch(&mut batch);
                    self.flush_handlers();
                    last_flush = std::time::Instant::now();
                }
                Ok(AsyncCommand::Shutdown) => {
                    self.process_batch(&mut batch);
                    self.flush_handlers();
                    break;
                }
                Err(_) => {
                    // Check if we need to flush based on time
                    if !batch.is_empty() && last_flush.elapsed() >= self.flush_interval {
                        self.process_batch(&mut batch);
                        last_flush = std::time::Instant::now();
                    }
                }
            }
        }
    }

    /// Process a batch of records
    fn process_batch(&self, batch: &mut Vec<Record>) {
        if batch.is_empty() {
            return;
        }

        // Process records through handlers
        for handler in &self.handlers {
            let guard = handler.read();
            if guard.is_enabled() && self.level >= guard.level() {
                let _ = guard.handle_batch(batch);
            }
        }

        batch.clear();
    }

    /// Flush all handlers
    fn flush_handlers(&self) {
        for handler in &self.handlers {
            let guard = handler.read();
            if guard.is_enabled() {
                let _ = guard.flush();
            }
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::time::Duration;
    use crate::handler::Handler;
    use crate::formatters::Formatter;
    use crate::handler::HandlerFilter;
    
    #[derive(Debug)]
    struct TestHandler {
        records: RwLock<Vec<Record>>,
        enabled: bool,
        level: LogLevel,
        formatter: Formatter,
    }
    
    impl Handler for TestHandler {
        fn handle(&self, record: &Record) -> Result<(), HandlerError> {
            self.records.write().push(record.clone());
            Ok(())
        }
        
        fn handle_batch(&self, records: &[Record]) -> Result<(), HandlerError> {
            let mut guard = self.records.write();
            guard.extend_from_slice(records);
            Ok(())
        }
        
        fn is_enabled(&self) -> bool {
            self.enabled
        }

        fn level(&self) -> LogLevel {
            self.level
        }

        fn set_level(&mut self, level: LogLevel) {
            self.level = level;
        }

        fn set_enabled(&mut self, enabled: bool) {
            self.enabled = enabled;
        }

        fn formatter(&self) -> &Formatter {
            &self.formatter
        }

        fn set_formatter(&mut self, formatter: Formatter) {
            self.formatter = formatter;
        }

        fn set_filter(&mut self, _filter: Option<HandlerFilter>) {
            // Not used in test
        }

        fn filter(&self) -> Option<&HandlerFilter> {
            None
        }
    }
    
    #[test]
    fn test_async_logger_basic() {
        let handler = Arc::new(TestHandler {
            records: RwLock::new(Vec::new()),
            enabled: true,
            level: LogLevel::Info,
            formatter: Formatter::default(),
        });
        
        let logger = AsyncLogger::new(
            LogLevel::Info,
            vec![Arc::new(RwLock::new(handler.clone()))],
            100,
            2
        );
        
        // Send some records
        for i in 0..10 {
            let record = Record::new(
                LogLevel::Info,
                format!("test message {}", i),
                None,
                None,
                None,
            );
            assert!(logger.log(record));
        }
        
        // Give time for processing
        thread::sleep(Duration::from_millis(200));
        
        // Verify records were processed
        let records = handler.records.read();
        assert_eq!(records.len(), 10);
    }
    
    #[test]
    fn test_async_logger_level_filtering() {
        let handler = Arc::new(TestHandler {
            records: RwLock::new(Vec::new()),
            enabled: true,
            level: LogLevel::Info,
            formatter: Formatter::default(),
        });
        
        let logger = AsyncLogger::new(
            LogLevel::Info,
            vec![Arc::new(RwLock::new(handler.clone()))],
            100,
            2
        );
        
        // Send records with different levels
        let debug_record = Record::new(
            LogLevel::Debug,
            "debug message",
            None,
            None,
            None,
        );
        let info_record = Record::new(
            LogLevel::Info,
            "info message",
            None,
            None,
            None,
        );
        
        assert!(!logger.log(debug_record)); // Should be filtered
        assert!(logger.log(info_record));   // Should pass
        
        thread::sleep(Duration::from_millis(200));
        
        let records = handler.records.read();
        assert_eq!(records.len(), 1);
        assert_eq!(records[0].level(), LogLevel::Info);
    }
    
    #[test]
    fn test_async_logger_shutdown() {
        let handler = Arc::new(TestHandler {
            records: RwLock::new(Vec::new()),
            enabled: true,
            level: LogLevel::Info,
            formatter: Formatter::default(),
        });
        
        let logger = AsyncLogger::new(
            LogLevel::Info,
            vec![Arc::new(RwLock::new(handler.clone()))],
            100,
            2
        );
        
        // Send some records
        for i in 0..5 {
            let record = Record::new(
                LogLevel::Info,
                format!("test message {}", i),
                None,
                None,
                None,
            );
            logger.log(record);
        }
        
        // Shutdown logger
        logger.shutdown();
        
        // Give time for final processing
        thread::sleep(Duration::from_millis(200));
        
        let records = handler.records.read();
        assert_eq!(records.len(), 5);
    }
}