moneyown / logback-android

The reliable, generic, fast and flexible logging framework for Java on Android.

logback-android

^v1.1.1-6

Overview

logback-android brings the power of logback to Android. This library provides a highly configurable logging framework for Android apps, supporting multiple log destinations simultaneously:

• files
• SQLite databases
• logcat
• sockets
• syslog
• email

Runs on Android 2.1 or higher. See Wiki for documentation.

Quick Start

1. Create a new "Basic Activity" app in Android Studio.

2. In app/build.gradle, add the following dependencies:

   // only needed for SNAPSHOT builds
   repositories {
     maven { url 'https://oss.sonatype.org/content/repositories/snapshots' }
   }
   
   dependencies {
     compile 'org.slf4j:slf4j-api:1.7.21'
     compile 'com.github.tony19:logback-android-core:1.1.1-6'
     compile('com.github.tony19:logback-android-classic:1.1.1-6') {
       // workaround issue #73
       exclude group: 'com.google.android', module: 'android'
     }
   }

3. Create app/src/main/assets/logback.xml containing:

   <configuration>
     <appender name="logcat" class="ch.qos.logback.classic.android.LogcatAppender">
       <tagEncoder>
         <pattern>%logger{12}</pattern>
       </tagEncoder>
       <encoder>
         <pattern>[%-20thread] %msg</pattern>
       </encoder>
     </appender>
   
     <root level="DEBUG">
       <appender-ref ref="logcat" />
     </root>
   </configuration>

4. In MainActivity.java, add the following imports:

   import org.slf4j.Logger;
   import org.slf4j.LoggerFactory;

5. ...and modify onOptionsItemSelected() to log "hello world":

   @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

// only needed for SNAPSHOT builds
repositories {
  maven { url 'https://oss.sonatype.org/content/repositories/snapshots' }
}

dependencies {
  compile 'org.slf4j:slf4j-api:1.7.21'
  compile 'com.github.tony19:logback-android-core:1.1.1-6'
  compile 'com.github.tony19:logback-android-classic:1.1.1-6'
}

Prefer local jars?

• logback-android-1.1.1-6.jar (uber jar)
• slf4j-api-1.7.21.jar

Build

logback-android is built with Gradle 2.12. Use these commands to create the uber jar (with debug symbols).

git clone git://github.com/tony19/logback-android.git
cd logback-android
scripts/makejar.sh

The jar would be in: ./build/logback-android-1.1.1-6.jar