log4rs

log4rs is a highly configurable logging framework modeled after Java's Logback and log4j libraries.

Warning

If you are using the file rotation in your configuration there is a known substantial performance issue so listen up! By default the gzip feature is enabled and when rolling files it will zip log archives automatically. This is a problem when the log archives are large as the zip happens in the main thread and will halt the process while the zip is completed. Be advised that the gzip feature will be removed from default features as of 1.0.

The methods to mitigate this are as follows.

1. Use the background_rotation feature which spawns an os thread to do the compression.
2. Disable the gzip feature with --no-default-features.
3. Ensure the archives are small enough that the compression time is acceptable.

For more information see the PR that added background_rotation.

Quick Start

log4rs.yaml:

refresh_rate: 30 seconds
appenders:
  stdout:
    kind: console
  requests:
    kind: file
    path: "log/requests.log"
    encoder:
      pattern: "{d} - {m}{n}"
root:
  level: warn
  appenders:
    - stdout
loggers:
  app::backend::db:
    level: info
  app::requests:
    level: info
    appenders:
      - requests
    additive: false

lib.rs:

use log::{error, info, warn};
use log4rs;

fn main() {
    log4rs::init_file("config/log4rs.yaml", Default::default()).unwrap();

    info!("booting up");

    // ...
}

Rust Version Requirements

Since version 0.10.0 the minimum version for rust is 1.38.0 and is verified via CI. 1.38.0 is required for windows due to the backtrace crate. 1.34.0 may work for unix environments although it is not officially supported.

Building for Dev

• Run the tests: cargo test --all-features
• Run the tests for windows with cross: cross test --target x86_64-pc-windows-gn
• Run the tests for all individual features: ./test.sh
• Run the tests for all individual features for windows with cross: ./test.sh win

License

Licensed under either of

• Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you shall be dual licensed as above, without any additional terms or conditions.