#log #logging #console #wasm #web_sys

console_log

A logging facility that routes Rust log messages to the browser’s console

4 releases

0.2.0 Apr 21, 2020
0.1.2 Jan 1, 2019
0.1.1 Jan 1, 2019
0.1.0 Jan 1, 2019

#21 in WebAssembly

Download history 5614/week @ 2020-06-06 7757/week @ 2020-06-13 6225/week @ 2020-06-20 6486/week @ 2020-06-27 6086/week @ 2020-07-04 6671/week @ 2020-07-11 7169/week @ 2020-07-18 6147/week @ 2020-07-25 5631/week @ 2020-08-01 5636/week @ 2020-08-08 5150/week @ 2020-08-15 5470/week @ 2020-08-22 5907/week @ 2020-08-29 6467/week @ 2020-09-05 8260/week @ 2020-09-12 6787/week @ 2020-09-19

27,031 downloads per month
Used in 33 crates (26 directly)

MIT/Apache

30KB
107 lines

console_log Crates.io

A logger that routes messages to the browser's console.

Usage

use log::Level;
fn main() {
    console_log::init_with_level(Level::Debug);

    info!("It works!");

    // ...
}

Details

Rust's log levels map to the browser's console log in the following way.

Rust Web Console
trace!() console.debug()
debug!() console.log()
info!() console.info()
warn!() console.warn()
error!() console.error()

Colors

The "color" feature adds styling to the log messages.

Cargo.toml

console_log = { version = "0.2", features = ["color"] }

The styled log messages will be rendered as follows:

Styled log messages

Code Size

Twiggy reports this library adding about 180Kb to the size of a minimal wasm binary in a debug build. If you want to avoid this, mark the library as optional and conditionally initialize it in your code for non-release builds.

Cargo.toml

[dependencies]
cfg_if = "0.1"
log = "0.4"
console_log = { version = "0.2", optional = true }

[features]
default = ["console_log"]

lib.rs

use wasm_bindgen::prelude::*;
use cfg_if::cfg_if;

cfg_if! {
    if #[cfg(feature = "console_log")] {
        fn init_log() {
            use log::Level;
            console_log::init_with_level(Level::Trace).expect("error initializing log");
        }
    } else {
        fn init_log() {}
    }
}

#[wasm_bindgen]
pub fn main() {
    init_log();
    // ...
}

Limitations

The file and line number information associated with the log messages reports locations from the shims generated by wasm-bindgen, not the location of the logger call.

License

This project is licensed under either of

at your option.

Contributing

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this project by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

See Also

Dependencies

~8MB
~160K SLoC