Revision control
Copy as Markdown
Other Tools
## Send Rust logs to Logcat
[](https://crates.io/crates/android_logger)
[](https://github.com/Nercury/android_logger-rs/actions/workflows/ci.yml/)
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:
```toml
[target.'cfg(target_os = "android")'.dependencies]
android_logger = "0.11"
```
Example of initialization on activity creation, with log configuration:
```rust
#[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:
```rust
#[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
* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
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.