README.md

Logger

Simple and useful Android logger library.

Configuration

Gradle Dependency (jCenter)

dependencies {
    compile 'software.rsquared:android-logger:1.3.3'
}

Java

This library uses java 8, please make sure it is enabled in your project:

android {
    ...
    compileOptions {
        targetCompatibility JavaVersion.VERSION_1_8
        sourceCompatibility JavaVersion.VERSION_1_8
    }
}

Sample Usage

//Send a message to all loggers defined in LoggerConfig
Logger.verbose("Verbose log");
Logger.verboseF("Formatted %s message: %.2f", "verbose", 3.1415f);
Logger.debug("Debug log");
Logger.debugF("Formatted %s message: %.2f", "debug", 3.1415f);
Logger.info("Info log");
Logger.infoF("Formatted %s message: %.2f", "info", 3.1415f);
Logger.warning("Warning log");
Logger.warningF("Formatted %s message: %.2f", "warning", 3.1415f);
Logger.error("Error log");
Logger.errorF("Formatted %s message: %.2f", "error", 3.1415f);
Logger.trace();

// log multi argument message
Logger.debug("User:", user.id, user.name);

// log throwable
try {
    ...
} catch (Throwable t){
    Logger.error("error", t);
}

//--------------------------------------------------------------

//Send message to the single logger
Logger logcat = Logger.createWith(new LogcatAppender());
logcat.v("Verbose log");
logcat.vF("Formatted %s message: %.2f", "verbose", 3.1415f);
logcat.d("Debug log");
logcat.dF("Formatted %s message: %.2f", "debug", 3.1415f);
logcat.i("Info log");
logcat.iF("Formatted %s message: %.2f", "info", 3.1415f);
logcat.w("Warning log");
logcat.wF("Formatted %s message: %.2f", "warning", 3.1415f);
logcat.e("Error log");
logcat.eF("Formatted %s message: %.2f", "error", 3.1415f);
logcat.t();
//--------------------------------------------------------------

LogcatAppender logcatAppender = new LogcatAppender();

// add appender to configuration
Logger.getLoggerConfig().addAppender(logcatAppender);
Logger.getLoggerConfig().addAppender("logcatAppenderId", new LogcatAppender());

// get logger by appenderId
Logger logcatLogger = Logger.getLogger("logcatAppenderId");

// remove appender from global configuration
Logger.getLoggerConfig().removeAppender("logcatAppenderId");
Logger.getLoggerConfig().removeAppender(logcatLogger);
Logger.getLoggerConfig().removeAppender(logcatAppender);

Configuration

Base Configuration

Global configuration sets log parameters for all loggers from this library.
New LoggerConfig is initialized with default LogcatAppender. If you want, you can remove it in configuration

Logger.getLoggerConfig()
        .removeAppender(fileAppender)
        .addAppender(toastAppender)
        .enableDefaultAppender(false)
        .overwriteLevel(Level.DEBUG, Level.INFO)
        .removeLevelOverwriting(Level.VERBOSE)
        .catchUncaughtExceptions()
        .runANRWatchDog(new LoggableANRWatchDog(2000))
        .setDefaultTag(Logger.CODE_LINE)
        .setLevel(Level.DEBUG)
        .setLogThrowableWithStackTrace(true)
        .setSeparator(" | ")
        .setThrowableSeparator(Logger.NEW_LINE)
        .setTimePattern("%1$tH:%1$tM");

setTag() - Tag, used to identify source of a log message, default it's class name with line number
You can also use auto generated values:
Logger.SIMPLE_CLASS_NAME
Logger.CLASS_NAME
Logger.METHOD_NAME
Logger.FILE_NAME
Logger.LINE_NUMBER
Logger.LEVEL
Logger.SHORT_LEVEL
Logger.TIME_
Logger.CODE_LINE

setLevel() - Minimal log level, all messages with level below this will be ignored.
Levels order: VERBOSE < DEBUG < INFO < WARNING < ERROR < SILENT

setSeparator - String used to separate parts of message e.g. in method Logger.debug(String...)

setThrowableSeparator - String used to separate message and Throwable stack trace

addLogger - You can add more then one appender. For better management you can also set appenderId for each logger. This library provide five types of appender: LogcatAppender, FileAppender, RollingFileAppender, TextViewAppender, ToastAppender.
You can create custom appender by extending Appender class.

Properties Configuration

Logger can by also configured by the properties file

Initializing

Logger.getLoggerConfig().fromProperties(context, R.raw.logger);

Sample fully defined properties file

(undefined property will be initialized with default values)

logger=logcat, textView, file, toast
logger.level=VERBOSE
logger.value=$CodeLine$
logger.logThrowableWithStackTrace=true
logger.separator=\u0020
logger.throwableSeparator=\r\n
logger.datePattern=dd/MM/yyyy HH:mm:ss:SSS
logger.catchUncaughtExceptions=true
logger.useANRWatchDog=true

logger.textView=software.rsquared.androidlogger.textview.TextViewAppender
logger.textView.level=INFO
logger.textView.value=$CodeLine$
logger.textView.logThrowableWithStackTrace=true
logger.textView.inNewLine=true
logger.textView.printMethod=APPEND

logger.file=software.rsquared.androidlogger.file.FileAppender
logger.file.level=WARNING
logger.file.value=$ShortLevel$ $CurrentTime$ $CodeLine$
logger.file.logThrowableWithStackTrace=true
logger.file.externalFile=loggerLogs/$Date$/log.txt
logger.file.datePattern=dd_MM_yyyy

logger.logcat=software.rsquared.androidlogger.logcat.LogcatAppender
logger.logcat.level=VERBOSE
logger.logcat.value=$CodeLine$
logger.logcat.logThrowableWithStackTrace=true

logger.toast=software.rsquared.androidlogger.toast.ToastAppender
logger.toast.level=ERROR
logger.toast.value=$CodeLine$
logger.toast.logThrowableWithStackTrace=false
logger.toast.duration=SHORT

Developed By

• Rafal Zajfert - rz@rsquared.software

License

Copyright 2017 rSquared s.c. R. Orlik, R. Zajfert

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.