refactor: refactor to `spdlog-rs` instead of `tracing` #538

NotEvenANeko · 2025-09-05T07:17:07Z

Refactor tracing to spdlog-rs for logging.

This closes #486 .

eatradish · 2025-09-05T07:21:55Z

Initially it looks good, but what I'm wondering is whether we should just replace the tracing family directly with spdlog instead of optional?

NotEvenANeko · 2025-09-05T07:24:32Z

Yeah we should replace tracing with spdlog, current codes is just convenient for debugging. I'll delete the tracing codes after spdlog parts are good to go.

SpriteOvO

Just a brief look and most of it seems to be fine. I'll probably merge SpriteOvO/spdlog-rs#93 in the next couple days. In the meantime, you can try removing the use of tracing from oma entirely.

SpriteOvO · 2025-09-06T23:06:59Z

src/main.rs

+    let rotating_sink = if let Ok(log_file) = &log_file {
+        Some(
+            AsyncPoolSink::builder()
+                .sink(Arc::new(
+                    RotatingFileSink::builder()
+                        .base_path(&log_file)
+                        .formatter(formatter.clone())
+                        .rotation_policy(RotationPolicy::Hourly)
+                        .build()
+                        .unwrap(),
+                ))
+                .overflow_policy(spdlog::sink::OverflowPolicy::DropIncoming)
+                .build()
+                .unwrap(),
+        )
+    } else {
+        None
+    };


The RotatingFileSink should not rotate hourly as oma did not do so. Could try RotationPolicy::FileSize(u64::MAX) and set max_files(config.save_log_count()).

Fixed, file size is set to 10MB.

SpriteOvO · 2025-09-09T20:25:00Z

src/main.rs

+            .join("oma")
+    };
+
+    let log_file = create_log_file(&log_dir);


Creating variants for filenames has been done internally by spdlog-rs, so oma no longer needs to create names manually.

SpriteOvO · 2025-09-17T04:04:24Z

FYI, SpriteOvO/spdlog-rs#93 is merged.

NotEvenANeko · 2025-09-17T04:52:13Z

I'll work on this PR tomorrow.

NotEvenANeko · 2025-09-19T07:58:43Z

spdlog-rs is set to main-dev branch now.

SpriteOvO · 2025-09-21T16:34:28Z

oma-console/src/print.rs

+///     StdStreamSink::builder().formatter(Box::new(OmaLayer::default())).build().unwrap()
+/// )).build().unwrap();


It is preferred that unwrap() not be used inside an example, and some of the error handling components be hidden if they make the example too difficult to follow.

Quote from https://doc.rust-lang.org/rustdoc/write-documentation/what-to-include.html?highlight=unwrap#examples

SpriteOvO · 2025-09-21T16:39:47Z

oma-console/src/print.rs

+            dest.write_str(&console::strip_ansi_codes(record.payload()))?;
+        }
+
+        dest.write_char('\n')?;


Also, we should write out the key-values of the record here.

Where we place the KV data? Just append it to the end of the log? 🤔

And it looks messy if we output the KV data in stdout.

oma/oma-console/src/print.rs

Lines 210 to 269 in 24424a1

let mut visitor = OmaRecorder(BTreeMap::new());

event.record(&mut visitor);

for (k, v) in visitor.0 {

if k == "message" {

if self.with_ansi {

self.writer.writeln(&prefix, &v).ok();

} else {

self.writer

.writeln(&prefix, &console::strip_ansi_codes(&v))

.ok();

}

}

}

}

}

/// OmaRecorder

/// `OmaRecorder` is used for recording oma-style logs.

///

/// # Example:

/// ```ignore

/// let mut visitor = OmaRecorder(BTreeMap::new());

/// event.record(&mut visitor);

/// for (k, v) in visitor.0 {

/// if k == "message" {

/// self.writer.writeln(&prefix, &v).ok();

/// }

/// }

/// ```

struct OmaRecorder<'a>(BTreeMap<&'a str, String>);

impl tracing::field::Visit for OmaRecorder<'_> {

fn record_f64(&mut self, field: &Field, value: f64) {

self.0.insert(field.name(), value.to_string());

}

fn record_i64(&mut self, field: &Field, value: i64) {

self.0.insert(field.name(), value.to_string());

}

fn record_u64(&mut self, field: &Field, value: u64) {

self.0.insert(field.name(), value.to_string());

}

fn record_bool(&mut self, field: &Field, value: bool) {

self.0.insert(field.name(), value.to_string());

}

fn record_str(&mut self, field: &Field, value: &str) {

self.0.insert(field.name(), value.to_string());

}

fn record_error(&mut self, field: &Field, value: &(dyn std::error::Error + 'static)) {

self.0.insert(field.name(), format!("{value:#?}"));

}

fn record_debug(&mut self, field: &Field, value: &dyn std::fmt::Debug) {

self.0.insert(field.name(), format!("{value:#?}"));

}

}

Since before this PR, oma is already used OmaRecorder to write KV to the end of a log record, I think keeping the behavior should be fine.

Some dep crates may completely use KV to recording variables instead of formatting into the payload.

~~Oops, seems I understand it incorrectly, oma only cares value with "message" as the key.~~

~~My bad, let's just keep the old behavior. You can use KeyValues::get method to get value with "message" as the key.~~

EDIT: NVM, tracing uses "message" KV to store payload, the current code works the same as before already, so looks good to me.

I'll leave the original implementation here, which is not to print KV

The with_kv field is added to formatter but unused if we need to print KV later.

SpriteOvO · 2025-09-21T16:45:06Z

src/main.rs

+// FIXME: `spdlog::error` is conflict with `mod error`
+use spdlog::{
+    Level, LevelFilter, Logger, debug, default_logger, error as error2, info, set_default_logger,


Yes, this is definitely a mistake in spdlog-rs, I haven't figure out the right way to fix it. For now, we can import the error! macro from spdlog::prelude::error.

use spdlog:prelude:error has the same issue

Hmm, so it's not a conflict between spdlog::error mod and spdlog::error! macro? So, if not, then it's probably should not consider as a mistake from spdlog-rs.

Okay, let's just keep the alias here. I'll suggest another name error as err.

SpriteOvO · 2025-09-21T16:48:33Z

src/main.rs

+    .to_string_lossy()
+    .to_string();


Hmm, since spdlog-rs accepts a path type instead of a string type, I think we should place the conversion to the end of the function.

SpriteOvO · 2025-09-21T16:51:25Z

src/main.rs

+        let level_filter = LevelFilter::MoreSevereEqual(Level::Info);

-    if !debug && !dry_run {
-        let no_i18n_embd: EnvFilter = "i18n_embed=off,info".parse().unwrap();


Looks like we have not setup the log crate proxy in this PR. The logs from log crate will only be available after we set it up via spdlog::init_log_crate_proxy().

And we really should migrate env filters, but spdlog-rs currently does not support filter logs from log crate, we will probably support this feature in the next minor release.

For now, is it acceptable for not migrate this at the moment? @eatradish

Looks like we have not setup the log crate proxy in this PR. The logs from log crate will only be available after we set it up via spdlog::init_log_crate_proxy().

And we really should migrate env filters, but spdlog-rs currently does not support filter logs from log crate, we will probably support this feature in the next minor release.

For now, is it acceptable for not migrate this at the moment? @eatradish

Yes, but subsequent releases may include this feature as a breaking

init_log_crate_proxy() added.

SpriteOvO · 2025-10-02T20:33:37Z

FYI, we have just released spdlog-rs v0.5.0. You could target the dependency spdlog-rs in this PR to the crates.io registry now.

NotEvenANeko · 2025-10-02T21:37:42Z

Updated to v0.5.0

NotEvenANeko · 2025-10-05T17:39:39Z

Doc tests should be fixed now

NotEvenANeko · 2025-10-13T10:38:25Z

Ok I think clippy check is passed now...

src/main.rs

SpriteOvO

Basically LGTM, @eatradish is there anything you are still concerned about?

eatradish · 2025-10-15T10:06:16Z

Basically LGTM, @eatradish is there anything you are still concerned about?

LGTM, I'll test the functionality tomorrow

eatradish · 2025-10-16T08:21:48Z

80col limit feature is broken

SpriteOvO · 2025-11-01T17:23:25Z

oma-console/src/print.rs

-                        .writeln(&prefix, &console::strip_ansi_codes(&v))
-                        .ok();
+                    time
                }


Looks like the 80col limit feature was implemented in oma_console::Writer, the original Writer directly writes to the IO handle stdout or stderr, probably we should implement one that writes to a string buf for spdlog-rs.

@NotEvenANeko Could you make time to have a look at it and try to fix?

NotEvenANeko · 2025-11-07T20:27:58Z

I'm so sorry for AFK for 3 weeks, I'm busy at study recently so I don't have much time for this, really sorry for this :(

I'm continue this PR now.

After reviewing the code I think that if we can migrate console.rs/src/writer.rs to spdlog-rs? Since the Writer directly use console crate to print the log.

We can migrate all the Writer functions and behavior to OmaFormatter and remove Writer.

Will it be a good idea? 🤔

SpriteOvO · 2025-11-08T06:18:28Z

@NotEvenANeko

We can migrate all the Writer functions and behavior to OmaFormatter and remove Writer.

Will it be a good idea? 🤔

I think putting the behavior "writing to console" into a formatter is not an ideal design. Why don't we just replace the field term: Term in Writer with buf: String, then return it from the formatter?

NotEvenANeko · 2025-11-13T23:00:16Z

Not the print to console behavior, I mean that we can move the formatting part into OmaFormatter, and the printing part is obviously moved to StdStreamSink. However we may need information against terminal, I think we can make an OmaStdoutFormatter to handle terminal-related formatting instead of leaving these parts mixed together in Writer.

SpriteOvO reviewed Sep 9, 2025

View reviewed changes

NotEvenANeko force-pushed the refactor/spdlog branch from 3ef6995 to 95052c9 Compare September 19, 2025 08:13

SpriteOvO reviewed Sep 21, 2025

View reviewed changes

NotEvenANeko force-pushed the refactor/spdlog branch from 95052c9 to c0266fb Compare October 2, 2025 21:35

NotEvenANeko force-pushed the refactor/spdlog branch 4 times, most recently from 125bbbf to ecaf9a1 Compare October 5, 2025 17:39

NotEvenANeko added 8 commits October 13, 2025 18:19

refactor: refactor to spdlog-rs instead of tracing

75a980a

refactor: remove tracing codes

b3d89b5

refactor: update rotation policy for logger

ce8b7fb

chore: upgrade to spdlog-rs 0.5.0

9167eef

refactor: add log proxy, and with_kv field to OmaFormatter

7fe3627

refactor: simplify init_logger return type

373f231

fix: fix doc tests

1e5316a

fix: fix clippy

55e6fc9

NotEvenANeko force-pushed the refactor/spdlog branch from ecaf9a1 to 55e6fc9 Compare October 13, 2025 10:37

eatradish requested changes Oct 14, 2025

View reviewed changes

src/main.rs Outdated Show resolved Hide resolved

refactor: rename error2 to log_error

4384553

SpriteOvO approved these changes Oct 15, 2025

View reviewed changes

SpriteOvO reviewed Nov 1, 2025

View reviewed changes

TimXiedada approved these changes Nov 11, 2025

View reviewed changes

		/// StdStreamSink::builder().formatter(Box::new(OmaLayer::default())).build().unwrap()
		/// )).build().unwrap();

	let mut visitor = OmaRecorder(BTreeMap::new());
	event.record(&mut visitor);

	for (k, v) in visitor.0 {
	if k == "message" {
	if self.with_ansi {
	self.writer.writeln(&prefix, &v).ok();
	} else {
	self.writer
	.writeln(&prefix, &console::strip_ansi_codes(&v))
	.ok();
	}
	}
	}
	}
	}
	/// OmaRecorder
	/// `OmaRecorder` is used for recording oma-style logs.
	///
	/// # Example:
	/// ```ignore
	/// let mut visitor = OmaRecorder(BTreeMap::new());
	/// event.record(&mut visitor);
	/// for (k, v) in visitor.0 {
	/// if k == "message" {
	/// self.writer.writeln(&prefix, &v).ok();
	/// }
	/// }
	/// ```
	struct OmaRecorder<'a>(BTreeMap<&'a str, String>);

	impl tracing::field::Visit for OmaRecorder<'_> {
	fn record_f64(&mut self, field: &Field, value: f64) {
	self.0.insert(field.name(), value.to_string());
	}

	fn record_i64(&mut self, field: &Field, value: i64) {
	self.0.insert(field.name(), value.to_string());
	}

	fn record_u64(&mut self, field: &Field, value: u64) {
	self.0.insert(field.name(), value.to_string());
	}

	fn record_bool(&mut self, field: &Field, value: bool) {
	self.0.insert(field.name(), value.to_string());
	}

	fn record_str(&mut self, field: &Field, value: &str) {
	self.0.insert(field.name(), value.to_string());
	}

	fn record_error(&mut self, field: &Field, value: &(dyn std::error::Error + 'static)) {
	self.0.insert(field.name(), format!("{value:#?}"));
	}

	fn record_debug(&mut self, field: &Field, value: &dyn std::fmt::Debug) {
	self.0.insert(field.name(), format!("{value:#?}"));
	}
	}

refactor: refactor to spdlog-rs instead of tracing #538

Are you sure you want to change the base?

refactor: refactor to spdlog-rs instead of tracing #538

Uh oh!

Conversation

NotEvenANeko commented Sep 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

eatradish commented Sep 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

NotEvenANeko commented Sep 5, 2025

Uh oh!

SpriteOvO left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

SpriteOvO commented Sep 17, 2025

Uh oh!

NotEvenANeko commented Sep 17, 2025

Uh oh!

NotEvenANeko commented Sep 19, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

SpriteOvO Oct 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

SpriteOvO Oct 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

SpriteOvO Oct 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

SpriteOvO commented Oct 2, 2025

Uh oh!

NotEvenANeko commented Oct 2, 2025

Uh oh!

NotEvenANeko commented Oct 5, 2025

Uh oh!

NotEvenANeko commented Oct 13, 2025

Uh oh!

Uh oh!

SpriteOvO left a comment

Choose a reason for hiding this comment

Uh oh!

eatradish commented Oct 15, 2025

Uh oh!

refactor: refactor to `spdlog-rs` instead of `tracing` #538

refactor: refactor to `spdlog-rs` instead of `tracing` #538

NotEvenANeko commented Sep 5, 2025 •

edited

Loading

eatradish commented Sep 5, 2025 •

edited

Loading

SpriteOvO Oct 2, 2025 •

edited

Loading

SpriteOvO Oct 2, 2025 •

edited

Loading

SpriteOvO Oct 2, 2025 •

edited

Loading

SpriteOvO Nov 1, 2025 •

edited

Loading

SpriteOvO commented Nov 8, 2025 •

edited

Loading