Google Git
Sign in
android / platform / external / rust / crates / log / 2912560fe9d6f5b8219e9984a620aed68a9c4543
commit2912560fe9d6f5b8219e9984a620aed68a9c4543[log] [tgz]
authorMarcin Radomski <[email protected]>Fri Aug 25 14:57:40 2023 +0000
committerAutomerger Merge Worker <[email protected]>Fri Aug 25 14:57:40 2023 +0000
treebc821a5b1a090001abcdc07eb801ec9ddc199f5a
parent11b0450712535f60691e70fcc1b7ad535989b41c [diff]
parenta5c0b79fcb0186c16917720bc39ae04c921a0f81 [diff]
Enable default-initializing liblog_rust to write to logcat on Android am: 28e0c72e03 am: 1af5e04469 am: 6e31631e59 am: 5be91b79c0 am: a5c0b79fcb

Original change: https://android-review.googlesource.com/c/platform/external/rust/crates/log/+/2717613

Change-Id: I1c3b3cc10dcf044e64005b5cbb12306db7c05dfb
Signed-off-by: Automerger Merge Worker <[email protected]>
tree: bc821a5b1a090001abcdc07eb801ec9ddc199f5a
  1. .github/
  2. benches/
  3. patches/
  4. src/
  5. LICENSE ⇨ LICENSE-APACHE
  6. .cargo_vcs_info.json
  7. .gitignore
  8. Android.bp
  9. build.rs
  10. Cargo.toml
  11. Cargo.toml.orig
  12. cargo2android.json
  13. CHANGELOG.md
  14. CleanSpec.mk
  15. LICENSE-APACHE
  16. LICENSE-MIT
  17. METADATA
  18. MODULE_LICENSE_APACHE2
  19. OWNERS
  20. README.md
  21. TEST_MAPPING
  22. triagebot.toml
README.md

log

A Rust library providing a lightweight logging facade.

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.31.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"

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

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);
            }
        }
    }
}

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 choose 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.

Structured logging

If you enable the kv_unstable feature, you can associate structured data with your log records:

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

pub fn shave_the_yak(yak: &mut Yak) {
    trace!(target = "yak_events", yak = as_serde!(yak); "Commencing yak shaving");

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