Gitiles
Code Review Sign In
android-review.linaro.org / platform / external / rust / crates / android_logger / 8328bd87a67c00e8224c1cbdb64c7044b3ec07a9
commit8328bd87a67c00e8224c1cbdb64c7044b3ec07a9[log] [tgz]
authorJeff Vander Stoep <jeffv@google.com>Mon Jan 29 13:25:09 2024 +0100
committerJeff Vander Stoep <jeffv@google.com>Mon Jan 29 13:45:29 2024 +0100
tree0d07bc0a5fa8f8d91e11653083cdfebfe02be907
parentab8bc93c6c8ea92fb6ceb511333b7e803597c2aa [diff]
Provide with_log_buffer() function

The goal is to make it easier to update the 3p android_logger crate.

This adds the upstream with_log_buffer() function. Android currently
carries a local patch which provides the same functionality under a
different name - with_log_id(). This is a temporary addition to allow
updating individual parts of the platform to match the upstream
crate to make the android_logger update more seemless. Normally we
would update everything in one topic, but the number of changes is
so large that this makes it simpler to get individual changes in.

Bug: 322718401
Test: build and run CF with the change.
Test: m aosp_cf_x86_64_phone
Change-Id: Icc63571d640cad0a0580e574df56853288380442
1 file changed
tree: 0d07bc0a5fa8f8d91e11653083cdfebfe02be907
  1. .github/
  2. patches/
  3. src/
  4. tests/
  5. LICENSE ⇨ LICENSE-APACHE
  6. .cargo_vcs_info.json
  7. .gitignore
  8. Android.bp
  9. Cargo.toml
  10. Cargo.toml.orig
  11. cargo_embargo.json
  12. CHANGELOG.md
  13. LICENSE-APACHE
  14. LICENSE-MIT
  15. METADATA
  16. MODULE_LICENSE_APACHE2
  17. OWNERS
  18. README.md
  19. TEST_MAPPING
README.md

Send Rust logs to Logcat

Version CI status

This library is a drop-in replacement for env_logger. Instead, it outputs messages to android's logcat.

This only works on Android and requires linking to log which is only available under android. With Cargo, it is possible to conditionally require this library:

[target.'cfg(target_os = "android")'.dependencies]
android_logger = "0.11"

Example of initialization on activity creation, with log configuration:

#[macro_use] extern crate log;
extern crate android_logger;

use log::LevelFilter;
use android_logger::{Config,FilterBuilder};

fn native_activity_create() {
    android_logger::init_once(
        Config::default()
            .with_max_level(LevelFilter::Trace) // limit log level
            .with_tag("mytag") // logs will show under mytag tag
            .with_filter( // configure messages for specific crate
                FilterBuilder::new()
                    .parse("debug,hello::crate=error")
                    .build())
    );

    trace!("this is a verbose {}", "message");
    error!("this is printed by default");
}

To allow all logs, use the default configuration with min level Trace:

#[macro_use] extern crate log;
extern crate android_logger;

use log::LevelFilter;
use android_logger::Config;

fn native_activity_create() {
    android_logger::init_once(
        Config::default().with_max_level(LevelFilter::Trace),
    );
}

There is a caveat that this library can only be initialized once (hence the init_once function name). However, Android native activity can be re-created every time the screen is rotated, resulting in multiple initialization calls. Therefore this library will only log a warning for subsequent init_once calls.

This library ensures that logged messages do not overflow Android log message limits by efficiently splitting messages into chunks.

License

Licensed under either of

at your option.

Contribution

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