Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tony19/logback-android
📄The reliable, generic, fast and flexible logging framework for Android
https://github.com/tony19/logback-android
android java logback logging-library
Last synced: 3 days ago
JSON representation
📄The reliable, generic, fast and flexible logging framework for Android
- Host: GitHub
- URL: https://github.com/tony19/logback-android
- Owner: tony19
- License: apache-2.0
- Created: 2011-06-29T06:47:06.000Z (over 13 years ago)
- Default Branch: main
- Last Pushed: 2024-10-28T21:36:35.000Z (3 months ago)
- Last Synced: 2024-10-29T15:05:15.657Z (3 months ago)
- Topics: android, java, logback, logging-library
- Language: Java
- Homepage:
- Size: 66.5 MB
- Stars: 1,199
- Watchers: 47
- Forks: 172
- Open Issues: 32
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-android - Logback Android - Logback port to Android which provides a highly configurable logging framework for Android apps. (Libraries / Logger)
- awesome-android-libraries - logback-android
- awesome-android - Logback Android - Logback port to Android which provides a highly configurable logging framework for Android apps. (Libraries / Logger)
README
# logback-android [](https://github.com/tony19/logback-android/releases/) 
[](https://circleci.com/gh/tony19/logback-android/tree/main) [](https://www.codacy.com/gh/tony19/logback-android/dashboard?utm_source=github.com&utm_medium=referral&utm_content=tony19/logback-android&utm_campaign=Badge_Grade)
## Overview
`logback-android` is a lite version of [`logback`](http://logback.qos.ch) that runs on Android. This library provides a highly configurable logging framework for Android apps, supporting multiple log destinations simultaneously:
* files
* SQLite databases
* logcat
* sockets
* syslog
* email
See [Wiki](https://github.com/tony19/logback-android/wiki) for documentation.
*For `[email protected]`, see the [`1.x` branch](https://github.com/tony19/logback-android/tree/1.x).*
## Quick Start
1. Create a new "Basic Activity" app in [Android Studio](http://developer.android.com/sdk/index.html).
2. In `app/build.gradle`, add the following dependencies:
```groovy
dependencies {
implementation 'org.slf4j:slf4j-api:2.0.7'
implementation 'com.github.tony19:logback-android:3.0.0'
}
```
If using `logback-android` in unit tests, **either** [use Robolectric](https://github.com/tony19/logback-android/issues/151#issuecomment-466276739), **or** use this config instead:
```groovy
dependencies {
implementation 'org.slf4j:slf4j-api:2.0.7'
implementation 'com.github.tony19:logback-android:3.0.0'
testImplementation 'ch.qos.logback:logback-classic:1.2.11'
}
configurations.testImplementation {
exclude module: 'logback-android'
}
```
3. Create `app/src/main/assets/logback.xml` containing:
```xml
%logger{12}
[%-20thread] %msg
```
4. In `MainActivity.java`, add the following imports:
```java
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
```
5. ...and modify `onOptionsItemSelected()` to log "hello world":
```java
@Override
public boolean onOptionsItemSelected(MenuItem item) {
Logger log = LoggerFactory.getLogger(MainActivity.class);
log.info("hello world");
// ...
}
```
6. Build and start the app.
7. Open logcat for your device (via the _Android Monitor_ tab in Android Studio).
8. Click the app menu, and select the menu-option. You should see "hello world" in logcat.
## Download
_Gradle_ **release**
```groovy
dependencies {
implementation 'org.slf4j:slf4j-api:2.0.7'
implementation 'com.github.tony19:logback-android:3.0.0'
}
```
_Gradle_ **snapshot (unstable)**
```groovy
repositories {
maven { url 'https://oss.sonatype.org/content/repositories/snapshots' }
}
dependencies {
implementation 'org.slf4j:slf4j-api:2.0.7'
implementation 'com.github.tony19:logback-android:3.0.1-SNAPSHOT'
}
```
## Build
Use these commands to create the AAR:
git clone git://github.com/tony19/logback-android.git
cd logback-android
scripts/makejar.sh
The file is output to:
```sh
./build/logback-android-3.0.0-debug.aar
```
## Release
1. CD into `./scripts/release`.
2. Install deps: `npm install`
3. Make sure `local.properties` contains the following keys, required to sign artifacts and upload to Maven Central:
```properties
# output from `gpg --export-secret-keys | base64`
signing.key=
# PUBKEY_LAST8 from `gpg --list-keys` (last 8 digits of pub key)
signing.keyId=
# password for key (can be empty if key has no password)
signing.password=
# path to secring.gpg file from `gpg --keyring secring.gpg --export-secret-keys > ~/.gnupg/secring.gpg`
signing.secretKeyRingFile=/Users/tony/.gnupg/secring.gpg
# OSS sonatype username at https://issues.sonatype.org
ossrhUsername=
# OSS sonatype password at https://issues.sonatype.org
ossrhPassword=
# profile ID from https://oss.sonatype.org/#stagingProfiles (select profile, and copy profile ID from hash in address bar)
sonatypeStagingProfileId=b2413418ab44f
```
4. Do a dry-run: `npm run start --dry`
5. If everything looks good, rerun without `--dry`.
6. Confirm the artifacts were uploaded in https://repo1.maven.org/maven2/com/github/tony19/logback-android/3.0.0/.