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
//! [Bunyan](https://www.npmjs.com/package/bunyan) formatting for `slog-rs`
//!
//! ```
//! #[macro_use]
//! extern crate slog;
//! extern crate slog_bunyan;
//!
//! use slog::Drain;
//! use std::sync::Mutex;
//!
//! fn main() {
//!     let root = slog::Logger::root(
//!                 Mutex::new(
//!                     slog_bunyan::default(
//!                         std::io::stderr()
//!                     )
//!                 ).fuse(),
//!                 o!("build-id" => "8dfljdf")
//!     );
//! }
//! ```
#![warn(missing_docs)]

#[macro_use]
extern crate slog;
extern crate chrono;
extern crate hostname;
extern crate slog_json;

use slog::{FnValue, Level, Record};

use std::io;

const DEFAULT_NAME: &str = "slog-rs";

fn get_hostname() -> String {
    match hostname::get() {
        Ok(h) => h.to_string_lossy().into_owned(),
        Err(_) => "n/a".to_string(),
    }
}

enum BunyanLevel {
    Fatal = 60,
    Error = 50,
    Warn = 40,
    Info = 30,
    Debug = 20,
    Trace = 10,
}

impl From<Level> for BunyanLevel {
    fn from(l: Level) -> Self {
        match l {
            Level::Critical => BunyanLevel::Fatal,
            Level::Error => BunyanLevel::Error,
            Level::Warning => BunyanLevel::Warn,
            Level::Info => BunyanLevel::Info,
            Level::Debug => BunyanLevel::Debug,
            Level::Trace => BunyanLevel::Trace,
        }
    }
}

fn new_with_ts_fn<F, W>(name: &'static str, io: W, ts_f: F) -> slog_json::JsonBuilder<W>
where
    F: Fn(&Record) -> String + Send + Sync + std::panic::RefUnwindSafe + 'static,
    W: io::Write,
{
    slog_json::Json::new(io).add_key_value(o!(
        "pid" => ::std::process::id(),
        "hostname" => get_hostname(),
        "time" => FnValue(ts_f),
        "level" => FnValue(|rinfo : &Record| {
            BunyanLevel::from(rinfo.level()) as i8
        }),
        "name" => name,
        "v" => 0usize,
        "msg" => FnValue(|rinfo : &Record| {
            rinfo.msg().to_string()
        })
    ))
}

/// Create `slog_json::FormatBuilder` with bunyan key-values
pub fn new<W>(io: W) -> slog_json::JsonBuilder<W>
where
    W: io::Write,
{
    with_name(DEFAULT_NAME, io)
}

/// Create `slog_json::Format` with bunyan key-values
pub fn default<W>(io: W) -> slog_json::Json<W>
where
    W: io::Write,
{
    with_name(DEFAULT_NAME, io).build()
}

/// Create `slog_json::FormatBuilder` with keys for the bunyan [core
/// fields](https://www.npmjs.com/package/bunyan#core-fields). The
/// value of the `name` parameter is used to populate the bunyan `name` field.
pub fn with_name<W>(name: &'static str, io: W) -> slog_json::JsonBuilder<W>
where
    W: io::Write,
{
    new_with_ts_fn(name, io, |_: &Record| chrono::Local::now().to_rfc3339())
}

#[cfg(test)]
mod test {
    use super::get_hostname;
    use super::new_with_ts_fn;
    use super::DEFAULT_NAME;
    use chrono::{TimeZone, Utc};
    use slog::{Drain, Level, Logger};
    use slog::{Record, RecordLocation, RecordStatic};
    use std::io;
    use std::sync::{Arc, Mutex};

    struct V(Arc<Mutex<Vec<u8>>>);

    impl io::Write for V {
        fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
            self.0.lock().unwrap().write(buf)
        }
        fn flush(&mut self) -> io::Result<()> {
            self.0.lock().unwrap().flush()
        }
    }

    #[test]
    fn trivial() {
        let v = Arc::new(Mutex::new(vec![]));
        {
            let v = V(v.clone());
            let drain = new_with_ts_fn(DEFAULT_NAME, v, |_: &Record| {
                Utc.ymd(2014, 7, 8).and_hms(9, 10, 11).to_rfc3339()
            })
            .build();

            let rs = RecordStatic {
                level: Level::Info,
                location: &RecordLocation {
                    file: "filepath",
                    line: 11192,
                    column: 0,
                    function: "",
                    module: "modulepath",
                },
                tag: "target",
            };

            let log = Logger::root(Mutex::new(drain).fuse(), o!());
            log.log(&Record::new(&rs, &format_args!("message"), b!()));
        }

        assert_eq!(
            String::from_utf8_lossy(&(*(*v).lock().unwrap())),
            "{".to_string()
                + "\"msg\":\"message\","
                + "\"v\":0,"
                + "\"name\":\"slog-rs\","
                + "\"level\":30,"
                + "\"time\":\"2014-07-08T09:10:11+00:00\","
                + "\"hostname\":\""
                + &get_hostname()
                + "\","
                + "\"pid\":"
                + &::std::process::id().to_string()
                + "}\n"
        );
    }

    #[test]
    fn custom_name_field() {
        let v = Arc::new(Mutex::new(vec![]));
        {
            let v = V(v.clone());
            let name = "test-name-123";
            let drain = new_with_ts_fn(name, v, |_: &Record| {
                Utc.ymd(2014, 7, 8).and_hms(9, 10, 11).to_rfc3339()
            })
            .build();

            let rs = RecordStatic {
                level: Level::Info,
                location: &RecordLocation {
                    file: "filepath",
                    line: 11192,
                    column: 0,
                    function: "",
                    module: "modulepath",
                },
                tag: "target",
            };

            let log = Logger::root(Mutex::new(drain).fuse(), o!());
            log.log(&Record::new(&rs, &format_args!("message"), b!()));
        }

        assert_eq!(
            String::from_utf8_lossy(&(*(*v).lock().unwrap())),
            "{".to_string()
                + "\"msg\":\"message\","
                + "\"v\":0,"
                + "\"name\":\"test-name-123\","
                + "\"level\":30,"
                + "\"time\":\"2014-07-08T09:10:11+00:00\","
                + "\"hostname\":\""
                + &get_hostname()
                + "\","
                + "\"pid\":"
                + &::std::process::id().to_string()
                + "}\n"
        );
    }
}