https://github.com/flxo/android-logd-logger

Android logger in pure Rust without a dependency to lib log
https://github.com/flxo/android-logd-logger

Last synced: 3 days ago
JSON representation

Android logger in pure Rust without a dependency to lib log

• Host: GitHub
• URL: https://github.com/flxo/android-logd-logger
• Owner: flxo
• Created: 2020-03-03T10:27:19.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-04-24T13:27:32.000Z (5 months ago)
• Last Synced: 2024-09-26T01:31:40.962Z (8 days ago)
• Language: Rust
• Size: 79.1 KB
• Stars: 11
• Watchers: 5
• Forks: 6
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# `android-logd-logger`

[![Crates.io][crates-badge]][crates-url]

[![Build Status][actions-badge]][actions-url]

[![Docs][docs-badge]][docs-url]

[docs-badge]: https://docs.rs/android-logd-logger/badge.svg

[docs-url]: https://docs.rs/android-logd-logger

[crates-badge]: https://img.shields.io/crates/v/android-logd-logger.svg

[crates-url]: https://crates.io/crates/android-logd-logger

[actions-badge]: https://github.com/flxo/android-logd-logger/workflows/CI/badge.svg

[actions-url]: https://github.com/flxo/android-logd-logger/actions?query=workflow%3ACI+branch%3Amaster

This logger writes logs to the Android `logd`, a system service with

multiple ringbuffers for logs and evens. This is normally done

via `liblog` (a native Android lib). Instead of using `liblog`, this crate

writes directly to the `logd` socket with the trivial protocol below.

This logger is written in pure Rust without any need for ffi.

On non Android system the log output is printed to stdout in the default

format of `logcat`.

## Usage

Add this to your Cargo.toml

```toml

[dependencies]

android-logd-logger = "0.4.3"

```

Initialize the logger with a fixed `tag` and the module path included

in the log payload.

```rust

fn main() {

    android_logd_logger::builder()

        .parse_filters("debug")

        .tag(TagMode::TargetStrip)

        .prepend_module(true)

        .init();

    trace!("trace message: is not logged");

    debug!("debug message");

    info!("info message");

    warn!("warn message");

    error!("error message");

}

```

To write android logd "events" use `event` or `event_now`, e.g:

```rust

android_logd_logger::write_event_now(1, "test").unwrap();

```

## Configuration

Writing to the logd socket is a single point of synchronization for threads.

The `android-logd-logger` can be configured with the `tls` feature to maintain

one socket per thread *or* use a single socket for the whole process.

Use the features `tls` if you want less interference between threads but pay

for one connection per thread.

## License

Licensed under either of

* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or )

* MIT license ([LICENSE-MIT](LICENSE-MIT) or )