gearbox 3.0.0

Excessive tooling for Rust, boosting productivity and operations
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

use crate::log::fmt::formatter::LogFormatter;
use crate::log::fmt::get_exec_name;
use crate::log::fmt::log_value::LogValue;
use crate::log::fmt::storage::Storage;
use alloc::{string::String, vec::Vec};
use core::fmt;
use core::marker::PhantomData;
use core::result::Result;
use hashbrown::HashMap;
use std::io::Write;
use tracing::span::Attributes;
use tracing::{Event, Id, Subscriber};
use tracing_subscriber::fmt::MakeWriter;
use tracing_subscriber::layer::Context;
use tracing_subscriber::Layer;
#[allow(unused)]
const TRACING_COMMON: &'static str = "tracing-log.";
#[allow(unused)]
const TRACING_OVERWRITES: &'static str = "tracing-log.overwrites.";

pub enum Error {}

pub struct LogLayer<W: for<'a> MakeWriter<'a> + 'static, F: LogFormatter + Default> {
    make_writer: W,
    version: Option<i32>,
    hostname: Option<String>,
    application: Option<String>,
    proc_id: Option<u32>,
    phantom: PhantomData<F>,
}

impl<W: for<'a> MakeWriter<'a> + 'static, F: LogFormatter + Default> LogLayer<W, F> {
    pub fn new(name: Option<String>, make_writer: W, _: F) -> Self {
        Self::with_default_fields(name, make_writer, HashMap::new())
    }

    pub fn with_default_fields(
        name: Option<String>,
        make_writer: W,
        _default_fields: HashMap<String, LogValue>,
    ) -> Self {
        #[cfg(all(any(unix, windows), feature = "std"))]
        let hostname = Option::from(
            crate::net::hostname::gethostname()
                .to_string_lossy()
                .into_owned(),
        );

        #[cfg(all(not(any(unix, windows)), feature = "std"))]
        let hostname = None;

        Self {
            make_writer,
            version: Option::from(1),
            proc_id: Option::from(crate::common::process::id()),
            hostname,
            application: name.or_else(|| get_exec_name()),
            phantom: Default::default(),
        }
    }

    pub fn emit(&self, mut buffer: Vec<u8>) -> Result<(), std::io::Error> {
        buffer.write_all(b"\n")?;
        self.make_writer.make_writer().write_all(&buffer)
    }

    pub fn version(&self) -> &Option<i32> {
        &self.version
    }

    pub fn proc_id(&self) -> &Option<u32> {
        &self.proc_id
    }

    pub fn hostname(&self) -> &Option<String> {
        &self.hostname
    }

    pub fn application(&self) -> &Option<String> {
        &self.application
    }
}

impl<S, W, F> Layer<S> for LogLayer<W, F>
where
    S: Subscriber + for<'a> tracing_subscriber::registry::LookupSpan<'a>,
    W: for<'a> MakeWriter<'a> + 'static,
    F: LogFormatter + Default + 'static,
{
    fn on_event(&self, event: &Event<'_>, ctx: Context<'_, S>) {
        // Creating the SPAN from context.
        let current_span = ctx.lookup_current();

        // Event Visitor and storage initialization.
        let mut event_visitor = Storage::default();
        event.record(&mut event_visitor);

        let mut entry = F::from_log_layer(self);

        let _ = self.emit(
            entry
                .format_event(&current_span, event, &event_visitor)
                .into_bytes(),
        );
    }

    fn on_new_span(&self, _attrs: &Attributes, id: &Id, ctx: Context<'_, S>) {
        let span = ctx.span(id).expect("Span not found, this is a bug");
        let mut entry = F::from_log_layer(self);
        let _ = self.emit(entry.format_span(&span, Type::EnterSpan).into_bytes());
    }

    fn on_close(&self, id: Id, ctx: Context<'_, S>) {
        let span = ctx.span(&id).expect("Span not found, this is a bug");
        let mut entry = F::from_log_layer(self);
        let _ = self.emit(entry.format_span(&span, Type::ExitSpan).into_bytes());
    }
}

/// The type of record we are dealing with: entering a span, exiting a span, an event.
#[derive(Clone, Debug)]
pub enum Type {
    EnterSpan,
    ExitSpan,
    Event,
}

impl fmt::Display for Type {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let repr = match self {
            Type::EnterSpan => "START",
            Type::ExitSpan => "ENDED",
            Type::Event => "EVENT",
        };
        write!(f, "{}", repr)
    }
}