v0.5.0

[SpriteOvO]

Highlights / New Features

• Structured logging supports. (issue [Feature Request] Structured logging (KV) support #70, PR Support structured logging (KV) #77)
• A new named optional parameter kv is accepted in logging macros for recording with structured key-value pairs.

  info!("program started", kv: { pid = std::process::id() });

• A new pattern placeholder {kv} is added to pattern macros for writing out structured key-value pairs.

  pattern!("{datetime} {^{level}} {payload} {{ {kv} }}{eol}")

• Access key-value pairs in records via a new method Record::key_values.
• The named optional parameters in logging macros are allowed to be placed in arbitrary order.

  info!(logger: my_app, kv: { a = 1 }, "1 + a = {}", 2); // OK
  info!(logger: my_app, "1 + a = {}", 2, kv: { a = 1 }); // OK
  info!("1 + a = {}", 2, logger: my_app, kv: { a = 1 }); // OK
  info!(kv: { a = 1 }, "1 + a = {}", 2, logger: my_app); // OK
  info!(logger: my_app, "1 + a = {}", kv: { a = 1 }, 2); // Error

• MSRV (minimum supported Rust version) is bumped to v1.66.1.
• A new sink AndroidSink allows writing out logs to Android NDK log framework. (issue [Feature Request] AndroidSink #96, PR Implement AndroidSink #97)
• JournaldSink passes an additional TID field to journald.
• Allow configuring the capacity of BufWriter for file sinks via new methods {FileSinkBuilder,RotatingFileSinkBuilder}::capacity.
• Allow passing a runtime level value to log! macro.
• Use a semantically non-zero type for ThreadPoolBuilder, InvalidArgumentError::ThreadPoolCapacity is marked as deprecated. (thanks @tisonkun, refactor: use a semantically nonzero type #94).
• Some implicit dependencies are no longer exposed as public enabled feature gates.
• Replace spin locks with std locks (Replace spin locks with std locks or parking_lot locks #92).
• Add an error variant Downstream(Box<dyn std::error::Error> for downstream crates.
• Mark swap_default_logger function as #[must_use].
• Fix runtime_pattern! macro requiring explicit spdlog-internal dependency.
• Benchmarking code is excluded from crates.io releases to reduce package size.
• Fix typo in documentation. (thanks @felixonmars, Fix typo in spdlog/src/logger.rs #100)

Migrating from v0.4

v0.5 made some breaking changes for better interaction of downstream crates with spdlog-rs.

• Methods Sink::{level_filter,set_level_filter,set_formatter,set_error_handler} are moved to a new trait SinkPropAccess, and trait Sink inherits it. (issue [Feature Request] Decouple Sink trait #71, PR Decouple Sink trait #93)
  If you are implementing your own sink, you may want to define a field with type SinkProp within your sink and then implement the new trait GetSinkProp for your sink. This will make your sink automatically get trait SinkPropAccess implemented.
• For methods {set_,}formatter in Logger and sink builders, an Into<Foramtter> is now accepted instead of a Box<dyn Formatter>.
• ErrorHandler is no longer used with Option, to represent an empty ErrorHandler, use ErrorHandler::default(). This allows downstream crates to be able to call the internal default error handler. (Improve error API for downstream crate implementors #86)
• ThreadPoolBuilder::capacity now accepts a NonZeroUsize instead of a usize.

---

This discussion was created from the release v0.5.0.