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
//! 网络 Sink
//!
//! 此模块实现通过网络发送日志的 sink,支持 TCP 和 UDP 协议。

use crate::config::{NetworkConfig, NetworkProtocol};
use crate::core::event::QuantumLogEvent;
use crate::error::{QuantumLogError, Result};
use crate::sinks::traits::{ExclusiveSink, QuantumSink, SinkError};
use async_trait::async_trait;
use std::net::SocketAddr;
use std::sync::Arc;
use tokio::io::{AsyncWriteExt, BufWriter};
use tokio::net::{TcpStream, UdpSocket};
use tokio::sync::{mpsc, oneshot, Mutex};
use tokio::task::JoinHandle;
use tokio::time::{timeout, Duration};
use tracing::Level;

/// 网络 Sink
#[derive(Debug)]
pub struct NetworkSink {
    /// 配置
    config: NetworkConfig,
    /// 事件发送器
    sender: Option<mpsc::Sender<SinkMessage>>,
    /// 处理器句柄
    processor_handle: Option<JoinHandle<()>>,
}

/// Sink 消息
enum SinkMessage {
    /// 日志事件
    Event(Box<QuantumLogEvent>),
    /// 关闭信号
    Shutdown(oneshot::Sender<Result<()>>),
}

/// 网络连接
enum NetworkConnection {
    /// TCP 连接
    Tcp(Arc<Mutex<BufWriter<TcpStream>>>),
    /// UDP 套接字
    Udp(Arc<UdpSocket>, SocketAddr),
}

/// 网络 Sink 处理器
struct NetworkSinkProcessor {
    /// 配置
    config: NetworkConfig,
    /// 事件接收器
    receiver: mpsc::Receiver<SinkMessage>,
    /// 网络连接
    connection: Option<NetworkConnection>,
    /// 重连计数器
    reconnect_count: usize,
    /// 级别过滤器
    level_filter: Option<Level>,
}

impl NetworkSink {
    /// 创建新的网络 sink
    pub fn new(config: NetworkConfig) -> Self {
        Self {
            config,
            sender: None,
            processor_handle: None,
        }
    }

    /// 设置级别过滤器
    pub fn with_level_filter(self, _level: Level) -> Self {
        // 注意:这里我们需要在配置中添加级别过滤器字段
        // 暂时存储在内部,实际实现时需要修改配置结构
        self
    }

    /// 启动 sink
    pub async fn start(&mut self) -> Result<()> {
        if self.sender.is_some() {
            return Err(QuantumLogError::ConfigError(
                "Sink already started".to_string(),
            ));
        }

        let buffer_size = 1000; // 固定缓冲区大小

        let (sender, receiver) = mpsc::channel(buffer_size);

        let processor = NetworkSinkProcessor::new(self.config.clone(), receiver).await?;
        let handle = tokio::spawn(async move {
            if let Err(e) = processor.run().await {
                tracing::error!("NetworkSink processor error: {}", e);
            }
        });

        self.sender = Some(sender);
        self.processor_handle = Some(handle);

        Ok(())
    }

    /// 发送事件
    pub async fn send_event_internal(&self, event: QuantumLogEvent) -> Result<()> {
        if let Some(sender) = &self.sender {
            let message = SinkMessage::Event(Box::new(event));

            // 使用阻塞策略发送事件
            sender.send(message).await.map_err(|_| {
                QuantumLogError::SinkError("Failed to send event to NetworkSink".to_string())
            })?;
        } else {
            return Err(QuantumLogError::SinkError(
                "NetworkSink not started".to_string(),
            ));
        }
        Ok(())
    }

    /// 关闭 sink
    pub async fn shutdown(mut self) -> Result<()> {
        if let Some(sender) = self.sender.take() {
            let (tx, rx) = oneshot::channel();

            // 发送关闭信号
            if sender.send(SinkMessage::Shutdown(tx)).await.is_err() {
                return Err(QuantumLogError::SinkError(
                    "Failed to send shutdown signal".to_string(),
                ));
            }

            // 等待关闭完成
            match rx.await {
                Ok(result) => result?,
                Err(_) => {
                    return Err(QuantumLogError::SinkError(
                        "Shutdown signal lost".to_string(),
                    ))
                }
            }
        }

        // 等待处理器完成
        if let Some(handle) = self.processor_handle.take() {
            if let Err(e) = handle.await {
                tracing::error!("Error waiting for NetworkSink processor: {}", e);
            }
        }

        Ok(())
    }

    /// 检查是否正在运行
    pub fn is_running(&self) -> bool {
        self.sender.is_some()
    }

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

impl NetworkSinkProcessor {
    /// 创建新的处理器
    async fn new(config: NetworkConfig, receiver: mpsc::Receiver<SinkMessage>) -> Result<Self> {
        let mut processor = Self {
            config,
            receiver,
            connection: None,
            reconnect_count: 0,
            level_filter: None,
        };

        // 尝试建立初始连接
        if let Err(e) = processor.connect().await {
            tracing::warn!("Failed to establish initial network connection: {}", e);
        }

        Ok(processor)
    }

    /// 建立网络连接
    async fn connect(&mut self) -> Result<()> {
        let address = format!("{}:{}", self.config.host, self.config.port);
        let socket_addr: SocketAddr = address.parse().map_err(|e| {
            QuantumLogError::NetworkError(format!("Invalid address {}: {}", address, e))
        })?;

        match self.config.protocol {
            NetworkProtocol::Tcp => {
                let stream = timeout(
                    Duration::from_millis(self.config.timeout_ms.unwrap_or(30000)),
                    TcpStream::connect(socket_addr),
                )
                .await
                .map_err(|_| QuantumLogError::NetworkError("Connection timeout".to_string()))?
                .map_err(|e| {
                    QuantumLogError::NetworkError(format!("TCP connection failed: {}", e))
                })?;

                let writer = BufWriter::new(stream);
                self.connection = Some(NetworkConnection::Tcp(Arc::new(Mutex::new(writer))));

                tracing::info!("TCP connection established to {}", address);
            }
            NetworkProtocol::Udp => {
                let socket = UdpSocket::bind("0.0.0.0:0").await.map_err(|e| {
                    QuantumLogError::NetworkError(format!("UDP socket bind failed: {}", e))
                })?;

                self.connection = Some(NetworkConnection::Udp(Arc::new(socket), socket_addr));

                tracing::info!("UDP socket created for {}", address);
            }
            NetworkProtocol::Http => {
                // HTTP协议支持待实现
                todo!("HTTP protocol support not yet implemented")
            }
        }

        self.reconnect_count = 0;
        Ok(())
    }

    /// 重连
    async fn reconnect(&mut self) -> Result<()> {
        // 检查最大重试次数(固定为5次)
        if self.reconnect_count >= 5 {
            return Err(QuantumLogError::NetworkError(
                "Max reconnection attempts (5) exceeded".to_string(),
            ));
        }

        self.reconnect_count += 1;

        // 等待重连间隔
        tokio::time::sleep(Duration::from_secs(5)).await;

        tracing::info!("Attempting reconnection #{}", self.reconnect_count);
        self.connect().await
    }

    /// 运行处理器
    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).await {
                        tracing::error!("Error handling event in NetworkSink: {}", e);

                        // 如果是网络错误,尝试重连
                        if matches!(e, QuantumLogError::NetworkError(_)) {
                            if let Err(reconnect_err) = self.reconnect().await {
                                tracing::error!("Reconnection failed: {}", reconnect_err);
                            }
                        }
                    }
                }
                SinkMessage::Shutdown(response) => {
                    let result = self.shutdown().await;
                    let _ = response.send(result);
                    break;
                }
            }
        }
        Ok(())
    }

    /// 处理事件
    async fn handle_event(&mut 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(());
            }
        }

        // 检查连接状态
        if self.connection.is_none() {
            self.connect().await?;
        }

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

        // 发送数据
        match &self.connection {
            Some(NetworkConnection::Tcp(writer_arc)) => {
                let mut writer = writer_arc.lock().await;
                writer.write_all(data).await.map_err(|e| {
                    QuantumLogError::NetworkError(format!("TCP write failed: {}", e))
                })?;
                writer.write_all(b"\n").await.map_err(|e| {
                    QuantumLogError::NetworkError(format!("TCP write failed: {}", e))
                })?;

                writer.flush().await.map_err(|e| {
                    QuantumLogError::NetworkError(format!("TCP flush failed: {}", e))
                })?;
            }
            Some(NetworkConnection::Udp(socket, addr)) => {
                socket.send_to(data, addr).await.map_err(|e| {
                    QuantumLogError::NetworkError(format!("UDP send failed: {}", e))
                })?;
            }
            None => {
                return Err(QuantumLogError::NetworkError(
                    "No active connection".to_string(),
                ));
            }
        }

        Ok(())
    }

    /// 格式化事件
    fn format_event(&self, event: &QuantumLogEvent) -> Result<String> {
        match self.config.format {
            crate::config::OutputFormat::Text => 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(","))
            }
        }
    }

    /// 关闭处理器
    async fn shutdown(&mut self) -> Result<()> {
        // 刷新连接
        if let Some(NetworkConnection::Tcp(writer_arc)) = &self.connection {
            let mut writer = writer_arc.lock().await;
            if let Err(e) = writer.flush().await {
                tracing::error!("Error flushing TCP connection: {}", e);
            }
        }

        self.connection = None;
        tracing::info!("NetworkSink shutdown completed");

        Ok(())
    }
}

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

    use tokio::net::{TcpListener, UdpSocket};
    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::network::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_network_sink_creation() {
        let config = NetworkConfig {
            enabled: true,
            level: None,
            host: "127.0.0.1".to_string(),
            port: 8080,
            protocol: NetworkProtocol::Tcp,
            format: OutputFormat::Text,
            buffer_size: 8192,
            timeout_ms: Some(30000),
        };

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

    #[tokio::test]
    async fn test_tcp_network_sink() {
        // 启动测试 TCP 服务器
        let listener = TcpListener::bind("127.0.0.1:0").await.unwrap();
        let addr = listener.local_addr().unwrap();

        // 在后台接受连接
        let server_handle = tokio::spawn(async move {
            if let Ok((stream, _)) = listener.accept().await {
                let mut buffer = [0; 1024];
                let _ = stream.readable().await;
                let _ = stream.try_read(&mut buffer);
            }
        });

        let config = NetworkConfig {
            enabled: true,
            level: None,
            host: addr.ip().to_string(),
            port: addr.port(),
            protocol: NetworkProtocol::Tcp,
            format: OutputFormat::Text,
            buffer_size: 8192,
            timeout_ms: Some(5000),
        };

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

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

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

        // 等待一下
        tokio::time::sleep(tokio::time::Duration::from_millis(100)).await;

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

        // 等待服务器完成
        let _ = server_handle.await;
    }

    #[tokio::test]
    async fn test_udp_network_sink() {
        // 启动测试 UDP 服务器
        let server_socket = UdpSocket::bind("127.0.0.1:0").await.unwrap();
        let addr = server_socket.local_addr().unwrap();

        // 在后台接收数据
        let server_handle = tokio::spawn(async move {
            let mut buffer = [0; 1024];
            let _ = server_socket.recv(&mut buffer).await;
        });

        let config = NetworkConfig {
            enabled: true,
            level: None,
            host: addr.ip().to_string(),
            port: addr.port(),
            protocol: NetworkProtocol::Udp,
            format: OutputFormat::Text,
            buffer_size: 8192,
            timeout_ms: Some(5000),
        };

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

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

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

        // 等待一下
        tokio::time::sleep(tokio::time::Duration::from_millis(100)).await;

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

        // 等待服务器完成
        let _ = server_handle.await;
    }

    #[tokio::test]
    async fn test_network_sink_backpressure_drop() {
        let config = NetworkConfig {
            enabled: true,
            level: None,
            host: "127.0.0.1".to_string(),
            port: 9999, // 不存在的端口
            protocol: NetworkProtocol::Tcp,
            format: OutputFormat::Text,
            buffer_size: 8192,
            timeout_ms: Some(1000),
        };

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

        // 发送事件(应该被丢弃,因为连接失败)
        let event = create_test_event(Level::INFO, "Test message");
        let result = sink.send_event(event).await;
        assert!(result.is_ok()); // send_event 本身不会失败,但事件可能被丢弃

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

    #[tokio::test]
    async fn test_network_sink_json_format() {
        let config = NetworkConfig {
            enabled: true,
            level: None,
            host: "127.0.0.1".to_string(),
            port: 8080,
            protocol: NetworkProtocol::Tcp,
            format: OutputFormat::Json,
            buffer_size: 8192,
            timeout_ms: Some(30000),
        };

        let sink = NetworkSink::new(config);

        // 检查配置
        assert_eq!(sink.config().format, OutputFormat::Json);
        assert_eq!(sink.config().protocol, NetworkProtocol::Tcp);
    }
}

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

    async fn send_event(&self, event: QuantumLogEvent) -> std::result::Result<(), Self::Error> {
        self.send_event_internal(event).await.map_err(|e| match e {
            QuantumLogError::ChannelError(msg) => SinkError::Generic(msg),
            QuantumLogError::ConfigError(msg) => SinkError::Config(msg),
            QuantumLogError::IoError { source } => SinkError::Io(source),
            QuantumLogError::NetworkError(msg) => SinkError::Network(msg),
            _ => SinkError::Generic(e.to_string()),
        })
    }

    async fn shutdown(&self) -> std::result::Result<(), Self::Error> {
        // 注意:这里需要可变引用,但trait要求不可变引用
        // 在实际使用中,可能需要使用内部可变性或重新设计
        Err(SinkError::Generic(
            "NetworkSink shutdown requires mutable reference".to_string(),
        ))
    }

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

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

    fn stats(&self) -> String {
        format!(
            "NetworkSink: running={}, protocol={:?}, target={}:{}",
            self.is_running(),
            self.config.protocol,
            self.config.host,
            self.config.port
        )
    }

    fn metadata(&self) -> crate::sinks::traits::SinkMetadata {
        crate::sinks::traits::SinkMetadata {
            name: "network".to_string(),
            sink_type: crate::sinks::traits::SinkType::Exclusive,
            enabled: self.is_running(),
            description: Some(format!(
                "Network sink using {:?} protocol to {}:{}",
                self.config.protocol, self.config.host, self.config.port
            )),
        }
    }
}

// 标记为独占型 sink
impl ExclusiveSink for NetworkSink {}