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
use std::{
    collections::BTreeMap,
    sync::{Mutex, Once},
};

use lazy_static::lazy_static;
use log::{Metadata, Record};
use serde::{Deserialize, Serialize};

pub(crate) static LOGGER_INIT: Once = Once::new();
pub(crate) const LOG_MAX_LEVEL: log::LevelFilter = log::LevelFilter::Trace;
pub(crate) const LOGGER_EXPECT: &str = "Logger should be set";

/// log lines are written to StdOut
pub(crate) static TERMINAL_LOGGER: TerminalLogger = TerminalLogger;

pub struct BufferedLogger {
    queue: Mutex<BTreeMap<String, LogLineItem>>,
}

impl log::Log for BufferedLogger {
    fn enabled(&self, metadata: &Metadata) -> bool {
        metadata
            .target()
            .starts_with("casperlabs_engine_shared::logging")
            && metadata.level() <= log::Level::Trace
    }

    fn log(&self, record: &Record) {
        let metadata = record.metadata();

        // self.enabled caused 'unresolved ref' error
        if Self::enabled(&self, metadata) {
            let line = format!("{}", record.args());
            if let Some(log_line_item) = LogLineItem::from_log_line(&line) {
                self.push(log_line_item);
            }
        }
    }

    fn flush(&self) {
        self.reset();
    }
}

pub fn get_buffered_logger() -> BufferedLogger {
    BufferedLogger {
        queue: Mutex::new(BTreeMap::new()),
    }
}

lazy_static! {
    /// log lines buffered internally instead of being output.
    /// log lines can be retrieved via LogBufferProvider
    pub static ref BUFFERED_LOGGER: BufferedLogger = get_buffered_logger();
}

pub struct TerminalLogger;

impl log::Log for TerminalLogger {
    fn enabled(&self, metadata: &Metadata) -> bool {
        metadata
            .target()
            .starts_with("casperlabs_engine_shared::logging")
            && metadata.level() <= log::Level::Trace
    }

    fn log(&self, record: &Record) {
        let metadata = record.metadata();

        // self.enabled caused 'unresolved ref' error
        if Self::enabled(&self, metadata) {
            println!("{}", record.args());
        }
    }

    fn flush(&self) {}
}

pub trait LogBufferProvider {
    fn push(&self, line: LogLineItem);
    fn extract(&self, message_id: &str) -> Option<LogLineItem>;
    fn extract_correlated(&self, correlation_id: &str) -> Option<Vec<LogLineItem>>;
    fn drain(&self) -> Vec<LogLineItem>;
    fn reset(&self);
}

impl LogBufferProvider for BufferedLogger {
    // add item to buffer
    fn push(&self, line: LogLineItem) {
        let key = line.message_id.clone();
        let value = line;

        if let Ok(mut guard) = self.queue.lock() {
            guard.insert(key, value);
        };
    }

    // remove and return item from buffer by matching message_id
    fn extract(&self, message_id: &str) -> Option<LogLineItem> {
        if let Ok(mut guard) = self.queue.lock() {
            if !guard.contains_key(message_id) {
                return None;
            }

            return guard.remove(message_id);
        }

        None
    }

    // remove and return all items with matching correlation_id
    fn extract_correlated(&self, correlation_id: &str) -> Option<Vec<LogLineItem>> {
        const CORRELATION_ID_KEY: &str = "correlation_id";
        let mut result: Vec<LogLineItem> = vec![];
        if let Ok(mut guard) = self.queue.lock() {
            let keys: Vec<_> = guard.keys().cloned().collect();

            for key in keys {
                if let Some(value) = guard.get(&key) {
                    if value.properties.contains_key(CORRELATION_ID_KEY) {
                        if let Some(c) = value.properties.get(CORRELATION_ID_KEY) {
                            if c == correlation_id {
                                if let Some(value) = guard.remove(&key) {
                                    result.push(value)
                                }
                            }
                        }
                    }
                }
            }

            return Some(result);
        }
        None
    }

    // remove and return all items in buffer
    fn drain(&self) -> Vec<LogLineItem> {
        let mut result: Vec<LogLineItem> = vec![];

        if let Ok(mut guard) = self.queue.lock() {
            let keys: Vec<_> = guard.keys().cloned().collect();
            for key in keys {
                if let Some(value) = guard.remove(&key) {
                    result.push(value)
                }
            }

            guard.clear();
        };

        result
    }

    // empty the buffer
    fn reset(&self) {
        if let Ok(mut guard) = self.queue.lock() {
            guard.clear();
        };
    }
}

/// container for LogLineItem data
#[derive(Clone, Debug, Default, Hash, PartialEq, Serialize, Deserialize)]
pub struct LogLineItem {
    pub timestamp: String,
    pub process_id: i64,
    pub process_name: String,
    pub host_name: String,
    pub log_level: String,
    pub priority: i64,
    pub message_type: String,
    pub message_type_version: String,
    pub message_id: String,
    pub description: String,
    pub properties: BTreeMap<String, String>,
}

impl LogLineItem {
    pub fn from_log_line(line: &str) -> Option<LogLineItem> {
        if let Some(idx) = line.find("payload=") {
            let start = idx + 8;
            let end = line.len();
            let slice = &line[start..end];
            if let Ok(log_line_item) = serde_json::from_str::<LogLineItem>(slice) {
                Some(log_line_item)
            } else {
                None
            }
        } else {
            None
        }
    }
}

/// set terminal logger as application logger
pub fn initialize_terminal_logger() {
    LOGGER_INIT.call_once(|| {
        log::set_logger(&TERMINAL_LOGGER).expect(LOGGER_EXPECT);
        log::set_max_level(LOG_MAX_LEVEL);
    });
}

/// set buffered logger as application logger
pub fn initialize_buffered_logger() {
    LOGGER_INIT.call_once(|| {
        log::set_logger(&*BUFFERED_LOGGER).expect(LOGGER_EXPECT);
        log::set_max_level(LOG_MAX_LEVEL);
    });
}

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

    use crate::{
        logging::{
            log_level, log_message,
            log_settings::{
                get_log_settings_provider, set_log_settings_provider, LogLevelFilter, LogSettings,
            },
        },
        utils::jsonify,
    };

    use super::*;

    const PROC_NAME: &str = "ee-shared-lib-logger-tests";

    fn get_log_settings(process_name: &str) -> LogSettings {
        let log_level_filter = LogLevelFilter::ERROR;

        LogSettings::new(process_name, log_level_filter)
    }

    lazy_static! {
        static ref LOG_SETTINGS_TESTS: LogSettings = get_log_settings(PROC_NAME);
    }

    #[test]
    #[ignore]
    fn should_log_structured_message() {
        let message_id: Arc<Mutex<Option<String>>> = Arc::new(Mutex::new(None));

        let message_handle = message_id.clone();

        let handle = thread::spawn(move || {
            initialize_buffered_logger();

            set_log_settings_provider(&*LOG_SETTINGS_TESTS);

            let log_settings_provider = get_log_settings_provider();

            let message_template = String::from("{correlation_id} {test-code}");

            let mut properties: BTreeMap<String, String> = BTreeMap::new();

            properties.insert("test-code".to_string(), "abc".to_string());

            let log_message = log_message::LogMessage::new_props(
                log_settings_provider,
                log_level::LogLevel::Fatal,
                message_template,
                properties,
            );

            if let Ok(mut guard) = message_handle.lock() {
                *guard = Some(log_message.message_id.value());
            }

            let json = jsonify(&log_message, false);

            log::log!(
                log_message.log_level.into(),
                "{timestamp} {loglevel} {priority} {hostname} {facility} payload={payload}",
                timestamp = log_message.timestamp,
                loglevel = log_message.log_level.to_uppercase(),
                priority = log_message.priority.value(),
                hostname = log_message.host_name.value(),
                facility = log_message.process_name.value(),
                payload = json
            );
        });

        let _r = handle.join();

        if let Ok(guard) = Arc::clone(&message_id).lock() {
            assert!(guard.is_some(), "should not be None");

            let key = guard.clone().unwrap();

            let item = BUFFERED_LOGGER
                .extract(&key)
                .expect("expected item by message id)");

            assert_eq!(item.log_level, "Fatal", "expected Fatal")
        }
    }
}