Skip to content
Logging implementation for Rust
Branch: master
Clone or download
Latest commit b782a88 Mar 13, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
rfcs An RFC for structured logging (#296) Mar 10, 2019
src
test_max_level_features Move max_level_features project out of tests to avoid warning Feb 2, 2019
tests Format with rustfmt 2019-02-14 Mar 10, 2019
.gitignore Add env_logger Jan 27, 2015
.travis.yml
CHANGELOG.md
Cargo.toml Update Cargo.toml Mar 12, 2019
LICENSE-APACHE Add licenses Dec 13, 2014
LICENSE-MIT
README.md README: Add `console_log` implementation for WebAssembly Jan 14, 2019
appveyor.yml Rename the use_std feature to std Oct 13, 2017

README.md

log

A Rust library providing a lightweight logging facade.

Build Status Build status Latest version Documentation License

A logging facade provides a single logging API that abstracts over the actual logging implementation. Libraries can use the logging API provided by this crate, and the consumer of those libraries can choose the logging implementation that is most suitable for its use case.

Minimum supported rustc

1.16.0+

This version is explicitly tested in CI and may be bumped in any release as needed. Maintaining compatibility with older compilers is a priority though, so the bar for bumping the minimum supported version is set very high. Any changes to the supported minimum version will be called out in the release notes.

Usage

In libraries

Libraries should link only to the log crate, and use the provided macros to log whatever information will be useful to downstream consumers:

[dependencies]
log = "0.4"
#[macro_use]
extern crate log;

pub fn shave_the_yak(yak: &mut Yak) {
    trace!("Commencing yak shaving");

    loop {
        match find_a_razor() {
            Ok(razor) => {
                info!("Razor located: {}", razor);
                yak.shave(razor);
                break;
            }
            Err(err) => {
                warn!("Unable to locate a razor: {}, retrying", err);
            }
        }
    }
}

If you use Rust 2018 (by setting edition = 2018 in your Cargo.toml), you can use instead the following code to import the crate macros:

use log::{info, trace, warn};

pub fn shave_the_yak(yak: &mut Yak) {
    // …
}

In executables

In order to produce log output, executables have to use a logger implementation compatible with the facade. There are many available implementations to chose from, here are some of the most popular ones:

Executables should choose a logger implementation and initialize it early in the runtime of the program. Logger implementations will typically include a function to do this. Any log messages generated before the logger is initialized will be ignored.

The executable itself may use the log crate to log as well.

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.