Streaming Android Logger

Additional

Language
Kotlin
Version
N/A
Created
Jan 28, 2018
Updated
Oct 11, 2019
Owner
Jan Rabe (kibotu)
Contributors
Armando TBA (ShkurtiA)
Jan Rabe (kibotu)
2
Activity
Badge
Generate
Download
Source code

Promotion

StreamingAndroidLogger

Introduction

Convenient logger that adds support to having multiple different loggers and different log levels for each one of them. e.g. LogcatLogger, CrashlyticsLogger, On-Device-Weblogging, UDP (e.g. Papertrail), SystemLogging.

How to install

repositories {
    maven {
        url "https://jitpack.io"
    }
}

dependencies {
    implementation 'com.github.kibotu:StreamingAndroidLogger:-SNAPSHOT'
}

How to use

Add a Logger

Logger.addLogger(LogcatLogger(), Level.VERBOSE)
Logger.addLogger(SystemLogger(), Level.VERBOSE)
Logger.addLogger(CrashlyticsLogger(), Level.WARNING)
Logger.addLogger(WebLogger(), Level.INFO)
Logger.addLogger(UDPLogger(this, "logs.papertrailapp.com", 8080), Level.INFO)

Streaming Log Server

Logger.addLogger(WebLogger(), Level.VERBOSE)
var loggingWebServer = LoggingWebServer(port, assets)
loggingWebServer.start()
loggingWebServer.stop()

Log with different log levels:

logv { "verbose message" }
logd { "debug message" }
logi { "info message" }
logw { "warning message" }
loge { "error message" }

Log Levels

VERBOSE
DEBUG
INFO
WARNING
ERROR
SILENT

ILogger interface

/**
 * Debug Message.
 *
 * @param tag     - Application Tag.
 * @param message - Logging message.
 */
fun debug(tag: String, message: String)

/**
 * Debug Message.
 *
 * @param tag     - Application Tag.
 * @param message - Logging message.
 */
fun verbose(tag: String, message: String)

/**
 * Information Message.
 *
 * @param tag     - Application Tag.
 * @param message - Logging message.
 */
fun information(tag: String, message: String)

/**
 * Warning Message.
 *
 * @param tag     - Application Tag.
 * @param message - Logging message.
 */
fun warning(tag: String, message: String)

/**
 * Error Message.
 *
 * @param tag     - Application Tag.
 * @param message - Logging message.
 */
fun error(tag: String, message: String)

/**
 * Handle caught exception.
 *
 * @param throwable - Exception
 */
fun exception(throwable: Throwable)

/**
 * Toast message.
 *
 * @param message - Displayed message.
 */
fun toast(message: String)

/**
 * Snackbar message.
 *
 * @param message - Displayed message.
 */
fun snackbar(message: String)

How to build

graldew clean build

CI

gradlew clean assembleRelease test javadoc

Build Requirements

  • JDK8
  • Android Build Tools 29.0.2
  • Android SDK 29

Notes

In case you don't use the weblogger in release, add this to your build.gradle, to remove weblogging files

release {
    […]
    aaptOptions {
        ignoreAssetsPattern "!html:!StreamingLogger:"
    }
}

Notes

Follow me on Twitter: @wolkenschauer

Let me know what you think: jan.rabe@kibotu.net

Contributions welcome!

License

Copyright 2018 Jan Rabe

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.