AppFlowy/rust-lib/flowy-log/src/lib.rs

151 lines
4.8 KiB
Rust
Raw Normal View History

2021-09-13 05:05:46 +00:00
mod layer;
2021-07-03 06:14:10 +00:00
use log::LevelFilter;
use std::path::Path;
2021-07-05 13:23:13 +00:00
use tracing::subscriber::set_global_default;
2021-09-13 05:05:46 +00:00
use crate::layer::*;
2021-11-03 07:28:34 +00:00
use lazy_static::lazy_static;
use std::sync::RwLock;
use tracing_appender::{non_blocking::WorkerGuard, rolling::RollingFileAppender};
2021-09-13 07:51:13 +00:00
use tracing_bunyan_formatter::JsonStorageLayer;
2021-06-29 05:45:32 +00:00
use tracing_log::LogTracer;
2021-11-03 07:37:38 +00:00
use tracing_subscriber::{field::MakeExt, fmt::format, layer::SubscriberExt, EnvFilter};
2021-11-03 07:28:34 +00:00
lazy_static! {
static ref LOG_GUARD: RwLock<Option<WorkerGuard>> = RwLock::new(None);
}
2021-07-03 06:14:10 +00:00
2021-08-19 06:08:24 +00:00
pub struct Builder {
2021-07-03 06:14:10 +00:00
name: String,
env_filter: String,
2021-11-03 07:28:34 +00:00
file_appender: Option<RollingFileAppender>,
2021-07-03 06:14:10 +00:00
}
2021-08-19 06:08:24 +00:00
impl Builder {
pub fn new(name: &str) -> Self {
Builder {
2021-07-03 06:14:10 +00:00
name: name.to_owned(),
env_filter: "Info".to_owned(),
2021-11-03 07:28:34 +00:00
file_appender: None,
2021-07-03 06:14:10 +00:00
}
}
pub fn env_filter(mut self, env_filter: &str) -> Self {
self.env_filter = env_filter.to_owned();
self
}
2021-11-03 07:28:34 +00:00
pub fn local(mut self, directory: impl AsRef<Path>) -> Self {
2021-08-19 06:08:24 +00:00
let directory = directory.as_ref().to_str().unwrap().to_owned();
let local_file_name = format!("{}.log", &self.name);
2021-11-03 07:28:34 +00:00
self.file_appender = Some(tracing_appender::rolling::hourly(directory, local_file_name));
2021-08-19 06:08:24 +00:00
self
}
2021-07-03 06:14:10 +00:00
pub fn build(self) -> std::result::Result<(), String> {
let env_filter = EnvFilter::new(self.env_filter);
2021-11-03 07:28:34 +00:00
let file_appender = self.file_appender.unwrap();
let (non_blocking, guard) = tracing_appender::non_blocking(file_appender);
let formatting_layer = FlowyFormattingLayer::new(std::io::stdout);
let formatter =
// Construct a custom formatter for `Debug` fields
format::debug_fn(|writer, field, value| write!(writer, "{}: {:?}", field, value))
// Use the `tracing_subscriber::MakeFmtExt` trait to wrap the
// formatter so that a delimiter is added between fields.
.delimited(", ");
2021-07-03 06:14:10 +00:00
2021-07-05 13:23:13 +00:00
let subscriber = tracing_subscriber::fmt()
2021-09-13 05:05:46 +00:00
// .with_span_events(FmtSpan::NEW | FmtSpan::CLOSE)
2021-11-03 07:28:34 +00:00
// .without_time()
.with_ansi(false)
2021-09-14 08:22:44 +00:00
.with_target(false)
2021-07-03 06:14:10 +00:00
.with_max_level(tracing::Level::TRACE)
2021-07-03 13:40:13 +00:00
.with_writer(std::io::stderr)
2021-11-03 07:28:34 +00:00
.fmt_fields(formatter)
// .with_thread_ids(true)
.with_writer(non_blocking)
.json()
2021-07-03 06:14:10 +00:00
.compact()
.finish()
2021-11-03 07:28:34 +00:00
.with(env_filter).with(JsonStorageLayer).with(formatting_layer);
2021-07-03 13:40:13 +00:00
2021-09-13 05:05:46 +00:00
// if cfg!(feature = "use_bunyan") {
// let formatting_layer = BunyanFormattingLayer::new(self.name.clone(),
// std::io::stdout); let _ =
// set_global_default(subscriber.with(JsonStorageLayer).with(formatting_layer)).
// map_err(|e| format!("{:?}", e))?; } else {
// let _ = set_global_default(subscriber).map_err(|e| format!("{:?}", e))?;
// }
2021-11-03 07:28:34 +00:00
let _ = set_global_default(subscriber).map_err(|e| format!("{:?}", e))?;
2021-07-03 06:14:10 +00:00
let _ = LogTracer::builder()
.with_max_level(LevelFilter::Trace)
.init()
.map_err(|e| format!("{:?}", e))
.unwrap();
2021-07-03 13:40:13 +00:00
2021-11-03 07:28:34 +00:00
*LOG_GUARD.write().unwrap() = Some(guard);
2021-07-03 06:14:10 +00:00
Ok(())
}
}
2021-06-29 05:45:32 +00:00
#[cfg(test)]
mod tests {
use super::*;
2021-07-03 06:14:10 +00:00
#[derive(Debug)]
struct Position {
x: f32,
y: f32,
}
2021-08-19 06:08:24 +00:00
// run cargo test --features="use_bunyan" or cargo test
2021-06-29 05:45:32 +00:00
#[test]
fn test_log() {
2021-11-03 07:28:34 +00:00
let _ = Builder::new("flowy").local(".").env_filter("debug").build().unwrap();
tracing::info!("😁 tracing::info call");
log::debug!("😁 log::debug call");
2021-07-03 06:14:10 +00:00
2021-11-03 07:28:34 +00:00
say("hello world");
}
2021-07-03 06:14:10 +00:00
2021-11-03 07:28:34 +00:00
#[test]
fn test_log2() {
let env_filter = EnvFilter::new("Debug");
let file_appender = tracing_appender::rolling::daily(".", "flowy_log_test");
let (non_blocking, _guard) = tracing_appender::non_blocking(file_appender);
2021-08-19 06:08:24 +00:00
2021-11-03 07:28:34 +00:00
let subscriber = tracing_subscriber::fmt()
.with_target(false)
.with_max_level(tracing::Level::TRACE)
.with_writer(std::io::stderr)
.with_thread_ids(true)
.with_writer(non_blocking)
.json()
.compact()
.finish()
.with(env_filter);
let formatting_layer = FlowyFormattingLayer::new(std::io::stdout);
let _ = set_global_default(subscriber.with(JsonStorageLayer).with(formatting_layer))
.map_err(|e| format!("{:?}", e))
.unwrap();
let _ = LogTracer::builder()
.with_max_level(LevelFilter::Trace)
.init()
.map_err(|e| format!("{:?}", e))
.unwrap();
tracing::info!("😁");
2021-08-19 06:08:24 +00:00
}
#[tracing::instrument(name = "say")]
fn say(s: &str) {
2021-11-03 07:37:38 +00:00
tracing::info!("{}", s);
2021-06-29 05:45:32 +00:00
}
}