use crate::sync::{RwLock, RwLockReadGuard};
use std::{
fmt::{self, Debug},
fs::{self, File, OpenOptions},
io::{self, Write},
path::Path,
sync::atomic::{AtomicUsize, Ordering},
};
use time::{format_description, Duration, OffsetDateTime, Time};
pub struct RollingFileAppender {
state: Inner,
writer: RwLock<File>,
#[cfg(test)]
now: Box<dyn Fn() -> OffsetDateTime + Send + Sync>,
}
#[derive(Debug)]
pub struct RollingWriter<'a>(RwLockReadGuard<'a, File>);
#[derive(Debug)]
struct Inner {
log_directory: String,
log_filename_prefix: String,
rotation: Rotation,
next_date: AtomicUsize,
}
impl RollingFileAppender {
pub fn new(
rotation: Rotation,
directory: impl AsRef<Path>,
file_name_prefix: impl AsRef<Path>,
) -> RollingFileAppender {
let now = OffsetDateTime::now_utc();
let (state, writer) = Inner::new(now, rotation, directory, file_name_prefix);
Self {
state,
writer,
#[cfg(test)]
now: Box::new(OffsetDateTime::now_utc),
}
}
#[inline]
fn now(&self) -> OffsetDateTime {
#[cfg(test)]
return (self.now)();
#[cfg(not(test))]
OffsetDateTime::now_utc()
}
}
impl io::Write for RollingFileAppender {
fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
let now = self.now();
let writer = self.writer.get_mut();
if let Some(current_time) = self.state.should_rollover(now) {
let _did_cas = self.state.advance_date(now, current_time);
debug_assert!(_did_cas, "if we have &mut access to the appender, no other thread can have advanced the timestamp...");
self.state.refresh_writer(now, writer);
}
writer.write(buf)
}
fn flush(&mut self) -> io::Result<()> {
self.writer.get_mut().flush()
}
}
impl<'a> tracing_subscriber::fmt::writer::MakeWriter<'a> for RollingFileAppender {
type Writer = RollingWriter<'a>;
fn make_writer(&'a self) -> Self::Writer {
let now = self.now();
if let Some(current_time) = self.state.should_rollover(now) {
if self.state.advance_date(now, current_time) {
self.state.refresh_writer(now, &mut *self.writer.write());
}
}
RollingWriter(self.writer.read())
}
}
impl fmt::Debug for RollingFileAppender {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("RollingFileAppender")
.field("state", &self.state)
.field("writer", &self.writer)
.finish()
}
}
pub fn minutely(
directory: impl AsRef<Path>,
file_name_prefix: impl AsRef<Path>,
) -> RollingFileAppender {
RollingFileAppender::new(Rotation::MINUTELY, directory, file_name_prefix)
}
pub fn hourly(
directory: impl AsRef<Path>,
file_name_prefix: impl AsRef<Path>,
) -> RollingFileAppender {
RollingFileAppender::new(Rotation::HOURLY, directory, file_name_prefix)
}
pub fn daily(
directory: impl AsRef<Path>,
file_name_prefix: impl AsRef<Path>,
) -> RollingFileAppender {
RollingFileAppender::new(Rotation::DAILY, directory, file_name_prefix)
}
pub fn never(directory: impl AsRef<Path>, file_name: impl AsRef<Path>) -> RollingFileAppender {
RollingFileAppender::new(Rotation::NEVER, directory, file_name)
}
#[derive(Clone, Eq, PartialEq, Debug)]
pub struct Rotation(RotationKind);
#[derive(Clone, Eq, PartialEq, Debug)]
enum RotationKind {
Minutely,
Hourly,
Daily,
Never,
}
impl Rotation {
pub const MINUTELY: Self = Self(RotationKind::Minutely);
pub const HOURLY: Self = Self(RotationKind::Hourly);
pub const DAILY: Self = Self(RotationKind::Daily);
pub const NEVER: Self = Self(RotationKind::Never);
pub(crate) fn next_date(&self, current_date: &OffsetDateTime) -> Option<OffsetDateTime> {
let unrounded_next_date = match *self {
Rotation::MINUTELY => *current_date + Duration::minutes(1),
Rotation::HOURLY => *current_date + Duration::hours(1),
Rotation::DAILY => *current_date + Duration::days(1),
Rotation::NEVER => return None,
};
Some(self.round_date(&unrounded_next_date))
}
pub(crate) fn round_date(&self, date: &OffsetDateTime) -> OffsetDateTime {
match *self {
Rotation::MINUTELY => {
let time = Time::from_hms(date.hour(), date.minute(), 0)
.expect("Invalid time; this is a bug in tracing-appender");
date.replace_time(time)
}
Rotation::HOURLY => {
let time = Time::from_hms(date.hour(), 0, 0)
.expect("Invalid time; this is a bug in tracing-appender");
date.replace_time(time)
}
Rotation::DAILY => {
let time = Time::from_hms(0, 0, 0)
.expect("Invalid time; this is a bug in tracing-appender");
date.replace_time(time)
}
Rotation::NEVER => {
unreachable!("Rotation::NEVER is impossible to round.")
}
}
}
pub(crate) fn join_date(&self, filename: &str, date: &OffsetDateTime) -> String {
match *self {
Rotation::MINUTELY => {
let format = format_description::parse("[year]-[month]-[day]-[hour]-[minute]")
.expect("Unable to create a formatter; this is a bug in tracing-appender");
let date = date
.format(&format)
.expect("Unable to format OffsetDateTime; this is a bug in tracing-appender");
format!("{}.{}", filename, date)
}
Rotation::HOURLY => {
let format = format_description::parse("[year]-[month]-[day]-[hour]")
.expect("Unable to create a formatter; this is a bug in tracing-appender");
let date = date
.format(&format)
.expect("Unable to format OffsetDateTime; this is a bug in tracing-appender");
format!("{}.{}", filename, date)
}
Rotation::DAILY => {
let format = format_description::parse("[year]-[month]-[day]")
.expect("Unable to create a formatter; this is a bug in tracing-appender");
let date = date
.format(&format)
.expect("Unable to format OffsetDateTime; this is a bug in tracing-appender");
format!("{}.{}", filename, date)
}
Rotation::NEVER => filename.to_string(),
}
}
}
impl io::Write for RollingWriter<'_> {
fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
(&*self.0).write(buf)
}
fn flush(&mut self) -> io::Result<()> {
(&*self.0).flush()
}
}
impl Inner {
fn new(
now: OffsetDateTime,
rotation: Rotation,
directory: impl AsRef<Path>,
file_name_prefix: impl AsRef<Path>,
) -> (Self, RwLock<File>) {
let log_directory = directory.as_ref().to_str().unwrap();
let log_filename_prefix = file_name_prefix.as_ref().to_str().unwrap();
let filename = rotation.join_date(log_filename_prefix, &now);
let next_date = rotation.next_date(&now);
let writer = RwLock::new(
create_writer(log_directory, &filename).expect("failed to create appender"),
);
let inner = Inner {
log_directory: log_directory.to_string(),
log_filename_prefix: log_filename_prefix.to_string(),
next_date: AtomicUsize::new(
next_date
.map(|date| date.unix_timestamp() as usize)
.unwrap_or(0),
),
rotation,
};
(inner, writer)
}
fn refresh_writer(&self, now: OffsetDateTime, file: &mut File) {
let filename = self.rotation.join_date(&self.log_filename_prefix, &now);
match create_writer(&self.log_directory, &filename) {
Ok(new_file) => {
if let Err(err) = file.flush() {
eprintln!("Couldn't flush previous writer: {}", err);
}
*file = new_file;
}
Err(err) => eprintln!("Couldn't create writer for logs: {}", err),
}
}
fn should_rollover(&self, date: OffsetDateTime) -> Option<usize> {
let next_date = self.next_date.load(Ordering::Acquire);
if next_date == 0 {
return None;
}
if date.unix_timestamp() as usize >= next_date {
return Some(next_date);
}
None
}
fn advance_date(&self, now: OffsetDateTime, current: usize) -> bool {
let next_date = self
.rotation
.next_date(&now)
.map(|date| date.unix_timestamp() as usize)
.unwrap_or(0);
self.next_date
.compare_exchange(current, next_date, Ordering::AcqRel, Ordering::Acquire)
.is_ok()
}
}
fn create_writer(directory: &str, filename: &str) -> io::Result<File> {
let path = Path::new(directory).join(filename);
let mut open_options = OpenOptions::new();
open_options.append(true).create(true);
let new_file = open_options.open(path.as_path());
if new_file.is_err() {
if let Some(parent) = path.parent() {
fs::create_dir_all(parent)?;
return open_options.open(path);
}
}
new_file
}
#[cfg(test)]
mod test {
use super::*;
use std::fs;
use std::io::Write;
fn find_str_in_log(dir_path: &Path, expected_value: &str) -> bool {
let dir_contents = fs::read_dir(dir_path).expect("Failed to read directory");
for entry in dir_contents {
let path = entry.expect("Expected dir entry").path();
let file = fs::read_to_string(&path).expect("Failed to read file");
println!("path={}\nfile={:?}", path.display(), file);
if file.as_str() == expected_value {
return true;
}
}
false
}
fn write_to_log(appender: &mut RollingFileAppender, msg: &str) {
appender
.write_all(msg.as_bytes())
.expect("Failed to write to appender");
appender.flush().expect("Failed to flush!");
}
fn test_appender(rotation: Rotation, file_prefix: &str) {
let directory = tempfile::tempdir().expect("failed to create tempdir");
let mut appender = RollingFileAppender::new(rotation, directory.path(), file_prefix);
let expected_value = "Hello";
write_to_log(&mut appender, expected_value);
assert!(find_str_in_log(directory.path(), expected_value));
directory
.close()
.expect("Failed to explicitly close TempDir. TempDir should delete once out of scope.")
}
#[test]
fn write_minutely_log() {
test_appender(Rotation::HOURLY, "minutely.log");
}
#[test]
fn write_hourly_log() {
test_appender(Rotation::HOURLY, "hourly.log");
}
#[test]
fn write_daily_log() {
test_appender(Rotation::DAILY, "daily.log");
}
#[test]
fn write_never_log() {
test_appender(Rotation::NEVER, "never.log");
}
#[test]
fn test_rotations() {
let now = OffsetDateTime::now_utc();
let next = Rotation::MINUTELY.next_date(&now).unwrap();
assert_eq!((now + Duration::MINUTE).minute(), next.minute());
let now = OffsetDateTime::now_utc();
let next = Rotation::HOURLY.next_date(&now).unwrap();
assert_eq!((now + Duration::HOUR).hour(), next.hour());
let now = OffsetDateTime::now_utc();
let next = Rotation::DAILY.next_date(&now).unwrap();
assert_eq!((now + Duration::DAY).day(), next.day());
let now = OffsetDateTime::now_utc();
let next = Rotation::NEVER.next_date(&now);
assert!(next.is_none());
}
#[test]
#[should_panic(
expected = "internal error: entered unreachable code: Rotation::NEVER is impossible to round."
)]
fn test_never_date_rounding() {
let now = OffsetDateTime::now_utc();
let _ = Rotation::NEVER.round_date(&now);
}
#[test]
fn test_path_concatination() {
let format = format_description::parse(
"[year]-[month]-[day] [hour]:[minute]:[second] [offset_hour \
sign:mandatory]:[offset_minute]:[offset_second]",
)
.unwrap();
let now = OffsetDateTime::parse("2020-02-01 10:01:00 +00:00:00", &format).unwrap();
let path = Rotation::MINUTELY.join_date("app.log", &now);
assert_eq!("app.log.2020-02-01-10-01", path);
let path = Rotation::HOURLY.join_date("app.log", &now);
assert_eq!("app.log.2020-02-01-10", path);
let path = Rotation::DAILY.join_date("app.log", &now);
assert_eq!("app.log.2020-02-01", path);
let path = Rotation::NEVER.join_date("app.log", &now);
assert_eq!("app.log", path);
}
#[test]
fn test_make_writer() {
use std::sync::{Arc, Mutex};
use tracing_subscriber::prelude::*;
let format = format_description::parse(
"[year]-[month]-[day] [hour]:[minute]:[second] [offset_hour \
sign:mandatory]:[offset_minute]:[offset_second]",
)
.unwrap();
let now = OffsetDateTime::parse("2020-02-01 10:01:00 +00:00:00", &format).unwrap();
let directory = tempfile::tempdir().expect("failed to create tempdir");
let (state, writer) =
Inner::new(now, Rotation::HOURLY, directory.path(), "test_make_writer");
let clock = Arc::new(Mutex::new(now));
let now = {
let clock = clock.clone();
Box::new(move || *clock.lock().unwrap())
};
let appender = RollingFileAppender { state, writer, now };
let default = tracing_subscriber::fmt()
.without_time()
.with_level(false)
.with_target(false)
.with_max_level(tracing_subscriber::filter::LevelFilter::TRACE)
.with_writer(appender)
.finish()
.set_default();
tracing::info!("file 1");
(*clock.lock().unwrap()) += Duration::seconds(1);
tracing::info!("file 1");
(*clock.lock().unwrap()) += Duration::hours(1);
tracing::info!("file 2");
(*clock.lock().unwrap()) += Duration::seconds(1);
tracing::info!("file 2");
drop(default);
let dir_contents = fs::read_dir(directory.path()).expect("Failed to read directory");
println!("dir={:?}", dir_contents);
for entry in dir_contents {
println!("entry={:?}", entry);
let path = entry.expect("Expected dir entry").path();
let file = fs::read_to_string(&path).expect("Failed to read file");
println!("path={}\nfile={:?}", path.display(), file);
match path
.extension()
.expect("found a file without a date!")
.to_str()
.expect("extension should be UTF8")
{
"2020-02-01-10" => {
assert_eq!("file 1\nfile 1\n", file);
}
"2020-02-01-11" => {
assert_eq!("file 2\nfile 2\n", file);
}
x => panic!("unexpected date {}", x),
}
}
}
}