env_logger

Implements a logger that can be configured via environment variables.

Usage

In libraries

env_logger makes sense when used in executables (binary projects). Libraries should use the log crate instead.

In executables

It must be added along with log to the project dependencies:

toml [dependencies] log = "0.4.0" env_logger = "0.6.2"

env_logger must be initialized as early as possible in the project. After it's initialized, you can use the log macros to do actual logging.

```rust

[macro_use]

extern crate log; extern crate env_logger;

fn main() { env_logger::init();

info!("starting up");

// ...

} ```

Then when running the executable, specify a value for the RUST_LOG environment variable that corresponds with the log messages you want to show.

bash $ RUST_LOG=info ./main [2018-11-03T06:09:06Z INFO default] starting up

env_logger can be configured in other ways besides an environment variable. See the examples for more approaches.

In tests

Tests can use the env_logger crate to see log messages generated during that test:

```toml [dependencies] log = "0.4.0"

[dev-dependencies] env_logger = "0.6.2" ```

```rust

[macro_use]

extern crate log;

fn addone(num: i32) -> i32 { info!("addone called with {}", num); num + 1 }

[cfg(test)]

mod tests { use super::*; extern crate env_logger;

fn init() {
    let _ = env_logger::builder().is_test(true).try_init();
}

#[test]
fn it_adds_one() {
    init();

    info!("can log from the test too");
    assert_eq!(3, add_one(2));
}

#[test]
fn it_handles_negative_numbers() {
    init();

    info!("logging from another test");
    assert_eq!(-7, add_one(-8));
}

} ```

Assuming the module under test is called my_lib, running the tests with the RUST_LOG filtering to info messages from this module looks like:

```bash $ RUSTLOG=mylib=info cargo test Running target/debug/my_lib-...

running 2 tests [INFO mylib::tests] logging from another test [INFO mylib] addone called with -8 test tests::ithandlesnegativenumbers ... ok [INFO mylib::tests] can log from the test too [INFO mylib] addone called with 2 test tests::itadds_one ... ok

test result: ok. 2 passed; 0 failed; 0 ignored; 0 measured ```

Note that env_logger::try_init() needs to be called in each test in which you want to enable logging. Additionally, the default behavior of tests to run in parallel means that logging output may be interleaved with test output. Either run tests in a single thread by specifying RUST_TEST_THREADS=1 or by running one test by specifying its name as an argument to the test binaries as directed by the cargo test help docs:

```bash $ RUSTLOG=mylib=info cargo test itaddsone Running target/debug/my_lib-...

running 1 test [INFO mylib::tests] can log from the test too [INFO mylib] addone called with 2 test tests::itadds_one ... ok

test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured ```

Configuring log target

By default, env_logger logs to stderr. If you want to log to stdout instead, you can use the Builder to change the log target:

```rust use std::env; use env_logger::{Builder, Target};

let mut builder = Builder::fromdefaultenv(); builder.target(Target::Stdout);

builder.init(); ```

Stability of the default format

The default format won't optimise for long-term stability, and explicitly makes no guarantees about the stability of its output across major, minor or patch version bumps during 0.x.

If you want to capture or interpret the output of env_logger programmatically then you should use a custom format.