logger: A Java repository from kosiara

CHANGES IN THIS FORK

Fix for mixed up logging: orhanobut#191

Added separate formatting for info/error: orhanobut#212

USAGE

/**
 * Log interface implementation
 */
object LogImpl {

    private const val TAG_NAME = "MY_CUSTOM_LOG"
    private const val NO_OF_STACKTRACE_LINES_TO_SHOW = 4
    private const val INTERNAL_METHOD_FILTER_OFFSET = 4

    private lateinit var errorLogger: LoggerPrinter
    private lateinit var infoLogger: LoggerPrinter

    fun init() {
        errorLogger = createLogger(true)
        infoLogger = createLogger(false)
    }

    fun e(msg: String) = errorLogger.e(msg)
    fun w(msg: String) = errorLogger.w(msg)
    fun i(msg: String) = infoLogger.i(msg)
    fun d(msg: String) = infoLogger.d(msg)

    private fun createLogger(showStackTrace: Boolean): LoggerPrinter {
        return LoggerPrinter().withAdapter(AndroidLogAdapter(PrettyFormatStrategy.newBuilder()
            .showThreadInfo(showStackTrace)
            .logStrategy(PrettyLogcatLogStrategy())
            .methodCount(if (showStackTrace) NO_OF_STACKTRACE_LINES_TO_SHOW else 0)
            .methodOffset(if (showStackTrace) INTERNAL_METHOD_FILTER_OFFSET else 0)
            .tag(TAG_NAME)
            .build()))
    }
}

Logger

Simple, pretty and powerful logger for android

Setup

Download

implementation 'com.orhanobut:logger:2.2.0'

Initialize

Logger.addLogAdapter(new AndroidLogAdapter());

And use

Logger.d("hello");

Output

Options

Logger.d("debug");
Logger.e("error");
Logger.w("warning");
Logger.v("verbose");
Logger.i("information");
Logger.wtf("What a Terrible Failure");

String format arguments are supported

Logger.d("hello %s", "world");

Collections are supported (only available for debug logs)

Logger.d(MAP);
Logger.d(SET);
Logger.d(LIST);
Logger.d(ARRAY);

Json and Xml support (output will be in debug level)

Logger.json(JSON_CONTENT);
Logger.xml(XML_CONTENT);

Advanced

FormatStrategy formatStrategy = PrettyFormatStrategy.newBuilder()
  .showThreadInfo(false)  // (Optional) Whether to show thread info or not. Default true
  .methodCount(0)         // (Optional) How many method line to show. Default 2
  .methodOffset(7)        // (Optional) Hides internal method calls up to offset. Default 5
  .logStrategy(customLog) // (Optional) Changes the log strategy to print out. Default LogCat
  .tag("My custom tag")   // (Optional) Global tag for every log. Default PRETTY_LOGGER
  .build();

Logger.addLogAdapter(new AndroidLogAdapter(formatStrategy));

Loggable

Log adapter checks whether the log should be printed or not by checking this function. If you want to disable/hide logs for output, override isLoggable method. true will print the log message, false will ignore it.

Logger.addLogAdapter(new AndroidLogAdapter() {
  @Override public boolean isLoggable(int priority, String tag) {
    return BuildConfig.DEBUG;
  }
});

Save logs to the file

//TODO: More information will be added later

Logger.addLogAdapter(new DiskLogAdapter());

Add custom tag to Csv format strategy

FormatStrategy formatStrategy = CsvFormatStrategy.newBuilder()
  .tag("custom")
  .build();
  
Logger.addLogAdapter(new DiskLogAdapter(formatStrategy));

How it works

Use filter for a better result. PRETTY_LOGGER or your custom tag
Make sure that wrap option is disabled
You can also simplify output by changing settings.

Timber Integration

// Set methodOffset to 5 in order to hide internal method calls
Timber.plant(new Timber.DebugTree() {
  @Override protected void log(int priority, String tag, String message, Throwable t) {
    Logger.log(priority, tag, message, t);
  }
});

License

Copyright 2018 Orhan Obut

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.

kosiara/logger