argmin/core/observers/
slog_logger.rs

// Copyright 2018-2020 argmin developers
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://apache.org/licenses/LICENSE-2.0> or the MIT license <LICENSE-MIT or
// http://opensource.org/licenses/MIT>, at your option. This file may not be
// copied, modified, or distributed except according to those terms.

//! # Loggers based on the `slog` crate

use crate::core::{ArgminKV, ArgminOp, Error, IterState, Observe};
use slog;
use slog::{info, o, Drain, Record, Serializer, KV};
use slog_async;
use slog_async::OverflowStrategy;
use slog_json;
use slog_term;
use std::fs::OpenOptions;
use std::sync::Mutex;

/// A logger based on `slog`
#[derive(Clone)]
pub struct ArgminSlogLogger {
    /// the logger
    logger: slog::Logger,
}

impl ArgminSlogLogger {
    /// Log to the terminal in a blocking way
    pub fn term() -> Self {
        ArgminSlogLogger::term_internal(OverflowStrategy::Block)
    }

    /// Log to the terminal in a non-blocking way (in case of overflow, messages are dropped)
    pub fn term_noblock() -> Self {
        ArgminSlogLogger::term_internal(OverflowStrategy::Drop)
    }

    /// Actual implementation of the logging to the terminal
    fn term_internal(overflow_strategy: OverflowStrategy) -> Self {
        let decorator = slog_term::TermDecorator::new().build();
        let drain = slog_term::FullFormat::new(decorator)
            .use_original_order()
            .build()
            .fuse();
        let drain = slog_async::Async::new(drain)
            .overflow_strategy(overflow_strategy)
            .build()
            .fuse();
        ArgminSlogLogger {
            logger: slog::Logger::root(drain, o!()),
        }
    }

    /// Log JSON to a file in a blocking way
    ///
    /// If `truncate` is set to `true`, the content of existing log files at `file` will be
    /// cleared.
    pub fn file(file: &str, truncate: bool) -> Result<Self, Error> {
        ArgminSlogLogger::file_internal(file, OverflowStrategy::Block, truncate)
    }

    /// Log JSON to a file in a non-blocking way (in case of overflow, messages are dropped)
    ///
    /// If `truncate` is set to `true`, the content of existing log files at `file` will be
    /// cleared.
    pub fn file_noblock(file: &str, truncate: bool) -> Result<Self, Error> {
        ArgminSlogLogger::file_internal(file, OverflowStrategy::Drop, truncate)
    }

    /// Actual implementaiton of logging JSON to file
    fn file_internal(
        file: &str,
        overflow_strategy: OverflowStrategy,
        truncate: bool,
    ) -> Result<Self, Error> {
        // Logging to file
        let file = OpenOptions::new()
            .create(true)
            .write(true)
            .truncate(truncate)
            .open(file)?;
        let drain = Mutex::new(slog_json::Json::new(file).build()).map(slog::Fuse);
        let drain = slog_async::Async::new(drain)
            .overflow_strategy(overflow_strategy)
            .build()
            .fuse();
        Ok(ArgminSlogLogger {
            logger: slog::Logger::root(drain, o!()),
        })
    }
}

/// This type is necessary in order to be able to implement `slog::KV` on `ArgminKV`
pub struct ArgminSlogKV {
    /// Key value store
    pub kv: Vec<(&'static str, String)>,
}

impl KV for ArgminSlogKV {
    fn serialize(&self, _record: &Record, serializer: &mut dyn Serializer) -> slog::Result {
        for idx in self.kv.clone().iter().rev() {
            serializer.emit_str(idx.0, &idx.1.to_string())?;
        }
        Ok(())
    }
}

impl<O: ArgminOp> KV for IterState<O> {
    fn serialize(&self, _record: &Record, serializer: &mut dyn Serializer) -> slog::Result {
        serializer.emit_str(
            "modify_func_count",
            &self.get_modify_func_count().to_string(),
        )?;
        serializer.emit_str(
            "hessian_func_count",
            &self.get_hessian_func_count().to_string(),
        )?;
        serializer.emit_str(
            "jacobian_func_count",
            &self.get_jacobian_func_count().to_string(),
        )?;
        serializer.emit_str("grad_func_count", &self.get_grad_func_count().to_string())?;
        serializer.emit_str("cost_func_count", &self.get_cost_func_count().to_string())?;
        serializer.emit_str("best_cost", &self.get_best_cost().to_string())?;
        serializer.emit_str("cost", &self.get_cost().to_string())?;
        serializer.emit_str("iter", &self.get_iter().to_string())?;
        Ok(())
    }
}

impl<'a> From<&'a ArgminKV> for ArgminSlogKV {
    fn from(i: &'a ArgminKV) -> ArgminSlogKV {
        ArgminSlogKV { kv: i.kv.clone() }
    }
}

impl<O: ArgminOp> Observe<O> for ArgminSlogLogger {
    /// Log general info
    fn observe_init(&self, msg: &str, kv: &ArgminKV) -> Result<(), Error> {
        info!(self.logger, "{}", msg; ArgminSlogKV::from(kv));
        Ok(())
    }

    /// This should be used to log iteration data only (because this is what may be saved in a CSV
    /// file or a database)
    fn observe_iter(&mut self, state: &IterState<O>, kv: &ArgminKV) -> Result<(), Error> {
        info!(self.logger, ""; state, ArgminSlogKV::from(kv));
        Ok(())
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    send_sync_test!(argmin_slog_loggerv, ArgminSlogLogger);
}
argmin/core/observers/slog_logger.rs

argmin/core/observers/
slog_logger.rs
