quantum_log 0.3.0

High-performance asynchronous logging framework based on tracing ecosystem
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
650
651
652
//! 控制台输出 Sink 实现
//!
//! 提供将日志事件输出到标准输出或标准错误的功能,支持彩色输出和级别过滤。

use crate::config::StdoutConfig;
use crate::core::event::QuantumLogEvent;
use crate::error::{QuantumLogError, Result};
use crate::sinks::traits::{QuantumSink, SinkError, StackableSink};
use async_trait::async_trait;

use std::io::{self, Write};
use std::sync::{Arc, Mutex};
use tokio::sync::{mpsc, oneshot};
use tokio::task::JoinHandle;
use tracing::Level;

/// 控制台 Sink 消息类型
#[derive(Debug)]
enum SinkMessage {
    /// 日志事件
    Event(Box<QuantumLogEvent>),
    /// 关闭信号
    Shutdown(oneshot::Sender<Result<()>>),
}

/// 控制台输出 Sink
///
/// 支持将日志事件输出到标准输出或标准错误,提供彩色输出和级别过滤功能。
#[derive(Debug)]
pub struct ConsoleSink {
    config: StdoutConfig,
    sender: Arc<Mutex<Option<mpsc::UnboundedSender<SinkMessage>>>>,
    handle: Arc<Mutex<Option<JoinHandle<Result<()>>>>>,
}

impl ConsoleSink {
    /// 创建新的控制台 Sink
    pub fn new(config: StdoutConfig) -> Self {
        Self {
            config,
            sender: Arc::new(Mutex::new(None)),
            handle: Arc::new(Mutex::new(None)),
        }
    }

    /// 设置级别过滤器
    pub fn with_level_filter(mut self, level: Level) -> Self {
        self.config.level = Some(level.to_string().to_lowercase());
        self
    }

    /// 启动 Sink
    pub async fn start(&mut self) -> Result<()> {
        if self.is_running() {
            return Err(QuantumLogError::ConfigError(
                "ConsoleSink is already running".to_string(),
            ));
        }

        let (sender, receiver) = mpsc::unbounded_channel();
        let processor = ConsoleSinkProcessor::new(self.config.clone(), receiver)?;

        let handle = tokio::spawn(async move { processor.run().await });

        {
            let mut sender_guard = self.sender.lock().unwrap();
            *sender_guard = Some(sender);
        }
        {
            let mut handle_guard = self.handle.lock().unwrap();
            *handle_guard = Some(handle);
        }

        tracing::info!("ConsoleSink started");
        Ok(())
    }

    /// 发送事件(阻塞)
    pub async fn send_event_internal(&self, event: QuantumLogEvent) -> Result<()> {
        let sender_opt = {
            let sender_guard = self.sender.lock().unwrap();
            sender_guard.as_ref().cloned()
        };
        if let Some(sender) = sender_opt {
            sender
                .send(SinkMessage::Event(Box::new(event)))
                .map_err(|_| {
                    QuantumLogError::ChannelError("Failed to send event to ConsoleSink".to_string())
                })?;
            Ok(())
        } else {
            Err(QuantumLogError::ConfigError(
                "ConsoleSink is not running".to_string(),
            ))
        }
    }

    /// 尝试发送事件(非阻塞)
    pub fn try_send_event(&self, event: QuantumLogEvent) -> Result<()> {
        let sender_opt = {
            let sender_guard = self.sender.lock().unwrap();
            sender_guard.as_ref().cloned()
        };
        if let Some(sender) = sender_opt {
            sender
                .send(SinkMessage::Event(Box::new(event)))
                .map_err(|_| {
                    QuantumLogError::ChannelError("Failed to send event to ConsoleSink".to_string())
                })?;
            Ok(())
        } else {
            Err(QuantumLogError::ConfigError(
                "ConsoleSink is not running".to_string(),
            ))
        }
    }

    /// 关闭 Sink
    pub async fn shutdown(&self) -> Result<()> {
        let sender = {
            let mut sender_guard = self.sender.lock().unwrap();
            sender_guard.take()
        };

        if let Some(sender) = sender {
            let (response_sender, response_receiver) = oneshot::channel();

            // 发送关闭信号
            sender
                .send(SinkMessage::Shutdown(response_sender))
                .map_err(|_| {
                    QuantumLogError::ChannelError("Failed to send shutdown signal".to_string())
                })?;

            // 等待处理器完成
            let result = response_receiver.await.map_err(|_| {
                QuantumLogError::ChannelError("Failed to receive shutdown response".to_string())
            })?;

            // 等待任务完成
            let handle = {
                let mut handle_guard = self.handle.lock().unwrap();
                handle_guard.take()
            };

            if let Some(handle) = handle {
                let _ = handle.await;
            }

            tracing::info!("ConsoleSink shutdown completed");
            result
        } else {
            Ok(())
        }
    }

    /// 检查 Sink 是否正在运行
    pub fn is_running(&self) -> bool {
        let sender_guard = self.sender.lock().unwrap();
        let handle_guard = self.handle.lock().unwrap();
        sender_guard.is_some() && handle_guard.is_some()
    }

    /// 获取配置
    pub fn config(&self) -> &StdoutConfig {
        &self.config
    }
}

/// 控制台 Sink 处理器
#[derive(Debug)]
struct ConsoleSinkProcessor {
    config: StdoutConfig,
    receiver: mpsc::UnboundedReceiver<SinkMessage>,
    level_filter: Option<Level>,
}

impl ConsoleSinkProcessor {
    /// 创建新的处理器
    fn new(config: StdoutConfig, receiver: mpsc::UnboundedReceiver<SinkMessage>) -> Result<Self> {
        // 解析级别过滤器
        let level_filter = if let Some(ref level_str) = config.level {
            Some(level_str.parse::<Level>().map_err(|_| {
                QuantumLogError::ConfigError(format!("Invalid log level: {}", level_str))
            })?)
        } else {
            None
        };

        Ok(Self {
            config,
            receiver,
            level_filter,
        })
    }

    /// 运行处理器
    async fn run(mut self) -> Result<()> {
        while let Some(message) = self.receiver.recv().await {
            match message {
                SinkMessage::Event(event) => {
                    if let Err(e) = self.handle_event(*event) {
                        tracing::error!("Error handling event in ConsoleSink: {}", e);
                    }
                }
                SinkMessage::Shutdown(response) => {
                    let result = self.shutdown();
                    let _ = response.send(result);
                    break;
                }
            }
        }
        Ok(())
    }

    /// 处理事件
    fn handle_event(&self, event: QuantumLogEvent) -> Result<()> {
        // 检查级别过滤
        if let Some(ref filter_level) = self.level_filter {
            let event_level = event.level.parse::<Level>().map_err(|_| {
                QuantumLogError::ConfigError(format!("Invalid log level: {}", event.level))
            })?;

            if event_level < *filter_level {
                return Ok(());
            }
        }

        // 格式化事件
        let formatted = self.format_event(&event)?;

        // 输出到控制台
        if self.should_use_stderr(&event) {
            let mut stderr = io::stderr();
            stderr
                .write_all(formatted.as_bytes())
                .map_err(|e| QuantumLogError::IoError { source: e })?;
            stderr
                .write_all(b"\n")
                .map_err(|e| QuantumLogError::IoError { source: e })?;
            stderr
                .flush()
                .map_err(|e| QuantumLogError::IoError { source: e })?;
        } else {
            let mut stdout = io::stdout();
            stdout
                .write_all(formatted.as_bytes())
                .map_err(|e| QuantumLogError::IoError { source: e })?;
            stdout
                .write_all(b"\n")
                .map_err(|e| QuantumLogError::IoError { source: e })?;
            stdout
                .flush()
                .map_err(|e| QuantumLogError::IoError { source: e })?;
        }

        Ok(())
    }

    /// 判断是否应该使用标准错误输出
    fn should_use_stderr(&self, event: &QuantumLogEvent) -> bool {
        // 错误和警告级别默认使用 stderr
        matches!(event.level.as_str(), "error" | "warn")
    }

    /// 格式化事件
    fn format_event(&self, event: &QuantumLogEvent) -> Result<String> {
        match &self.config.format {
            crate::config::OutputFormat::Text => {
                if self.config.color_enabled.unwrap_or(true) {
                    Ok(self.format_colored_text(event))
                } else {
                    Ok(event.to_formatted_string("full"))
                }
            }
            crate::config::OutputFormat::Json => event
                .to_json()
                .map_err(|e| QuantumLogError::SerializationError { source: e }),
            crate::config::OutputFormat::Csv => {
                let csv_row = event.to_csv_row();
                Ok(csv_row.join(","))
            }
        }
    }

    /// 格式化彩色文本
    fn format_colored_text(&self, event: &QuantumLogEvent) -> String {
        let level_color = match event.level.as_str() {
            "error" => "\x1b[31m", // 红色
            "warn" => "\x1b[33m",  // 黄色
            "info" => "\x1b[32m",  // 绿色
            "debug" => "\x1b[36m", // 青色
            "trace" => "\x1b[37m", // 白色
            _ => "\x1b[0m",        // 默认
        };

        let reset = "\x1b[0m";

        format!(
            "{}{:>5}{} {} [{}] {}",
            level_color,
            event.level.to_uppercase(),
            reset,
            event.timestamp.format("%Y-%m-%d %H:%M:%S%.3f"),
            event.target,
            event.message
        )
    }

    /// 关闭处理器
    fn shutdown(&self) -> Result<()> {
        // 刷新输出流
        let _ = io::stdout().flush();
        let _ = io::stderr().flush();

        tracing::info!("ConsoleSink shutdown completed");
        Ok(())
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::config::OutputFormat;
    use crate::core::event::ContextInfo;
    use tracing::Level;

    fn create_test_event(level: Level, message: &str) -> QuantumLogEvent {
        static CALLSITE: tracing::callsite::DefaultCallsite =
            tracing::callsite::DefaultCallsite::new(&tracing::Metadata::new(
                "test",
                "quantum_log::console::test",
                Level::INFO,
                Some(file!()),
                Some(line!()),
                Some(module_path!()),
                tracing::field::FieldSet::new(&[], tracing::callsite::Identifier(&CALLSITE)),
                tracing::metadata::Kind::EVENT,
            ));
        let metadata = tracing::Metadata::new(
            "test",
            "test_target",
            level,
            Some("test.rs"),
            Some(42),
            Some("test_module"),
            tracing::field::FieldSet::new(&[], tracing::callsite::Identifier(&CALLSITE)),
            tracing::metadata::Kind::EVENT,
        );

        QuantumLogEvent::new(
            level,
            message.to_string(),
            &metadata,
            std::collections::HashMap::new(),
            ContextInfo::default(),
        )
    }

    #[tokio::test]
    async fn test_console_sink_creation() {
        let config = StdoutConfig {
            enabled: true,
            level: None,
            colored: true,
            format: OutputFormat::Text,
            color_enabled: Some(true),
            level_colors: None,
        };

        let sink = ConsoleSink::new(config);
        assert!(!sink.is_running());
    }

    #[tokio::test]
    async fn test_console_sink_start_stop() {
        let config = StdoutConfig {
            enabled: true,
            level: None,
            format: OutputFormat::Text,
            color_enabled: Some(false),
            level_colors: None,
            colored: false,
        };

        let mut sink = ConsoleSink::new(config);

        // 启动
        let result = sink.start().await;
        assert!(result.is_ok());
        assert!(sink.is_running());

        // 关闭
        let result = sink.shutdown().await;
        assert!(result.is_ok());
        assert!(!sink.is_running());
    }

    #[tokio::test]
    async fn test_console_sink_send_event() {
        let config = StdoutConfig {
            enabled: true,
            level: None,
            format: OutputFormat::Text,
            color_enabled: Some(false),
            level_colors: None,
            colored: false,
        };

        let mut sink = ConsoleSink::new(config);
        sink.start().await.unwrap();

        // 发送事件
        let event = create_test_event(Level::INFO, "Test console message");
        let result = sink.send_event(event).await;
        assert!(result.is_ok());

        // 等待一下让事件被处理
        tokio::time::sleep(tokio::time::Duration::from_millis(10)).await;

        sink.shutdown().await.unwrap();
    }

    #[tokio::test]
    async fn test_console_sink_try_send_event() {
        let config = StdoutConfig {
            enabled: true,
            level: None,
            format: OutputFormat::Text,
            color_enabled: Some(false),
            level_colors: None,
            colored: false,
        };

        let mut sink = ConsoleSink::new(config);
        sink.start().await.unwrap();

        // 尝试发送事件
        let event = create_test_event(Level::INFO, "Test console message");
        let result = sink.try_send_event(event);
        assert!(result.is_ok());

        // 等待一下让事件被处理
        tokio::time::sleep(tokio::time::Duration::from_millis(10)).await;

        sink.shutdown().await.unwrap();
    }

    #[tokio::test]
    async fn test_console_sink_level_filter() {
        let config = StdoutConfig {
            enabled: true,
            level: Some("warn".to_string()),
            colored: false,
            format: OutputFormat::Text,
            color_enabled: Some(false),
            level_colors: None,
        };

        let mut sink = ConsoleSink::new(config);
        sink.start().await.unwrap();

        // 发送低级别事件(应该被过滤)
        let debug_event = create_test_event(Level::DEBUG, "Debug message");
        let result = sink.send_event(debug_event).await;
        assert!(result.is_ok());

        // 发送高级别事件(应该被处理)
        let error_event = create_test_event(Level::ERROR, "Error message");
        let result = sink.send_event(error_event).await;
        assert!(result.is_ok());

        // 等待一下让事件被处理
        tokio::time::sleep(tokio::time::Duration::from_millis(10)).await;

        sink.shutdown().await.unwrap();
    }

    #[tokio::test]
    async fn test_console_sink_colored_output() {
        let config = StdoutConfig {
            enabled: true,
            level: None,
            colored: true,
            format: OutputFormat::Text,
            color_enabled: Some(true),
            level_colors: None,
        };

        let mut sink = ConsoleSink::new(config);
        sink.start().await.unwrap();

        // 发送不同级别的事件
        let events = vec![
            create_test_event(Level::ERROR, "Error message"),
            create_test_event(Level::WARN, "Warning message"),
            create_test_event(Level::INFO, "Info message"),
            create_test_event(Level::DEBUG, "Debug message"),
            create_test_event(Level::TRACE, "Trace message"),
        ];

        for event in events {
            let result = sink.send_event(event).await;
            assert!(result.is_ok());
        }

        // 等待一下让事件被处理
        tokio::time::sleep(tokio::time::Duration::from_millis(50)).await;

        sink.shutdown().await.unwrap();
    }

    #[tokio::test]
    async fn test_console_sink_json_format() {
        let config = StdoutConfig {
            enabled: true,
            level: None,
            colored: false,
            format: OutputFormat::Json,
            color_enabled: Some(false),
            level_colors: None,
        };

        let mut sink = ConsoleSink::new(config);
        sink.start().await.unwrap();

        // 发送事件
        let event = create_test_event(Level::INFO, "Test JSON message");
        let result = sink.send_event(event).await;
        assert!(result.is_ok());

        // 等待一下让事件被处理
        tokio::time::sleep(tokio::time::Duration::from_millis(10)).await;

        sink.shutdown().await.unwrap();
    }

    #[test]
    fn test_console_sink_config() {
        let config = StdoutConfig {
            enabled: true,
            level: Some("info".to_string()),
            colored: true,
            format: OutputFormat::Json,
            color_enabled: Some(true),
            level_colors: None,
        };

        let sink = ConsoleSink::new(config.clone());

        // 检查配置
        assert_eq!(sink.config().enabled, config.enabled);
        assert_eq!(sink.config().level, config.level);
        assert_eq!(sink.config().colored, config.colored);
        assert_eq!(sink.config().format, config.format);
        assert_eq!(sink.config().color_enabled, config.color_enabled);
    }
}

// 实现新的统一 Sink trait
#[async_trait]
impl QuantumSink for ConsoleSink {
    type Config = StdoutConfig;
    type Error = SinkError;

    async fn send_event(&self, event: QuantumLogEvent) -> std::result::Result<(), Self::Error> {
        // 使用默认的 Block 背压策略,显式调用 StackableSink trait 方法避免与同名固有方法冲突
        <ConsoleSink as StackableSink>::send_event_internal(
            self,
            &event,
            crate::config::BackpressureStrategy::Block,
        )
        .await
    }

    async fn shutdown(&self) -> std::result::Result<(), Self::Error> {
        // 显式调用固有方法以避免与当前 trait 方法名冲突而导致递归
        ConsoleSink::shutdown(self).await.map_err(|e| match e {
            QuantumLogError::ChannelError(msg) => SinkError::Generic(msg),
            QuantumLogError::ConfigError(msg) => SinkError::Config(msg),
            QuantumLogError::IoError { source } => SinkError::Io(source),
            _ => SinkError::Generic(e.to_string()),
        })
    }

    async fn is_healthy(&self) -> bool {
        self.is_running()
    }

    fn name(&self) -> &'static str {
        "console"
    }

    fn stats(&self) -> String {
        format!(
            "ConsoleSink: running={}, config={:?}",
            self.is_running(),
            self.config
        )
    }

    fn metadata(&self) -> crate::sinks::traits::SinkMetadata {
        crate::sinks::traits::SinkMetadata {
            name: "console".to_string(),
            sink_type: crate::sinks::traits::SinkType::Stackable,
            enabled: self.is_running(),
            description: Some(format!("Console sink with config: {:?}", self.config)),
        }
    }
}

// 标记为可叠加型 sink 并实现 send_event_internal
#[async_trait]
impl StackableSink for ConsoleSink {
    async fn send_event_internal(
        &self,
        event: &QuantumLogEvent,
        strategy: crate::config::BackpressureStrategy,
    ) -> crate::sinks::traits::SinkResult<()> {
        use crate::diagnostics::get_diagnostics_instance;
        use tokio::time::{timeout, Duration};

        let diagnostics = get_diagnostics_instance();

        // 构建内部事件
        let internal_event = event.clone();

        // 根据背压策略处理事件发送
        let send_fut = self.send_event_internal(internal_event);
        let result = match strategy {
            crate::config::BackpressureStrategy::Block => send_fut.await,
            crate::config::BackpressureStrategy::Drop => {
                match timeout(Duration::from_millis(100), send_fut).await {
                    Ok(res) => res,
                    Err(_) => return Err(crate::sinks::traits::SinkError::Backpressure),
                }
            }
        };

        match result {
            Ok(()) => {
                if let Some(d) = diagnostics {
                    d.increment_events_processed();
                }
                Ok(())
            }
            Err(e) => Err(crate::sinks::traits::SinkError::Generic(e.to_string())),
        }
    }
}

// ... existing code ...