qevent 0.5.0

qlog implementation
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

use std::io;

use tokio::{
    io::{AsyncWrite, AsyncWriteExt},
    sync::mpsc,
};

use super::QlogFileSeq;
use crate::{Event, telemetry::ExportEvent};

pub struct IoExpoter(mpsc::UnboundedSender<Event>);

impl IoExpoter {
    pub fn new<O>(qlog_file_seq: QlogFileSeq, mut output: O) -> Self
    where
        O: AsyncWrite + Unpin + Send + 'static,
    {
        let (tx, mut rx) = mpsc::unbounded_channel();
        tokio::spawn(async move {
            let task = async {
                const RS: u8 = 0x1E;

                output.write_u8(RS).await?;
                let qlog_file_seq = serde_json::to_string(&qlog_file_seq).unwrap();
                output.write_all(qlog_file_seq.as_bytes()).await?;
                output.write_u8(b'\n').await?;

                while let Some(event) = rx.recv().await {
                    let event = match super::Event::try_from(event) {
                        Ok(event) => serde_json::to_string(&event).unwrap(),
                        Err(_unsuppert) => continue,
                    };
                    output.write_u8(RS).await?;
                    output.write_all(event.as_bytes()).await?;
                    output.write_u8(b'\n').await?;
                }

                io::Result::Ok(())
            };
            if let Err(error) = task.await {
                tracing::error!(
                    target: "qlog",
                    ?error,
                    ?qlog_file_seq,
                    "Failed to write qlog, subsequent qlogs in this exporter will be ignored."
                );
            }
        });
        Self(tx)
    }
}

impl ExportEvent for IoExpoter {
    fn emit(&self, event: Event) {
        _ = self.0.send(event);
    }
}

#[cfg(test)]
mod tests {
    use std::sync::Arc;

    use super::*;
    use crate::{
        legacy::TraceSeq,
        quic::connectivity::ServerListening,
        telemetry::{Instrument, Span},
    };

    #[tokio::test]
    async fn io_exporter() {
        let exporter = IoExpoter::new(
            crate::build!(QlogFileSeq {
                title: "io exporter example",
                trace: TraceSeq {}
            }),
            tokio::io::stdout(),
        );

        let meaningless_field = 112233u64;
        crate::span!(Arc::new(exporter), meaningless_field).in_scope(|| {
            crate::event!(ServerListening {
                ip_v4: "127.0.0.1".to_owned(),
                port_v4: 443u16
            });

            tokio::spawn(
                async move {
                    assert_eq!(Span::current().load::<String>("path_id"), "new path");
                    assert_eq!(Span::current().load::<u64>("meaningless_field"), 112233u64);
                    // do something
                }
                .instrument(crate::span!(@current, path_id = String::from("new path"))),
            );
        });

        tokio::task::yield_now().await;
    }
}