Simple, pretty and powerful logger for android
Java
Latest commit 441d244 Aug 28, 2016 @orhanobut committed on GitHub Update README.md

README.md

Android Arsenal Join the chat at https://gitter.im/orhanobut/logger Build Status

Logger

Simple, pretty and powerful logger for android

Logger provides :

  • Thread information
  • Class information
  • Method information
  • Pretty-print for json content
  • Pretty-print for new line "\n"
  • Clean output
  • Jump to source

Download

compile 'com.orhanobut:logger:1.15'

Current Log system

Log.d(TAG,"hello");

Logger

Logger.d("hello");
Logger.d("hello %s %d", "world", 5);   // String.format

Logger.d("hello");
Logger.e("hello");
Logger.w("hello");
Logger.v("hello");
Logger.wtf("hello");
Logger.json(JSON_CONTENT);
Logger.xml(XML_CONTENT);
Logger.log(DEBUG, "tag", "message", throwable);

String format arguments are supported

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

Array, Map, Set and List are supported

Logger.d(list);
Logger.d(map);
Logger.d(set);
Logger.d(new String[]);

Change TAG

All logs

Logger.init(YOUR_TAG);

Log based

Logger.t("mytag").d("hello");

Settings (optional)

Change the settings with init. This should be called only once. Best place would be in application class. All of them are optional. You can just use the default settings if you don't init Logger.

Logger
  .init(YOUR_TAG)                 // default PRETTYLOGGER or use just init()
  .methodCount(3)                 // default 2
  .hideThreadInfo()               // default shown
  .logLevel(LogLevel.NONE)        // default LogLevel.FULL
  .methodOffset(2)                // default 0
  .logAdapter(new AndroidLogAdapter()); //default AndroidLogAdapter
}

Note: Use LogLevel.NONE for the release versions.

Use another log util instead of android.util.log

  • Implement LogAdapter
  • set it with init
.logAdapter(new CustomLogAdapter())

More log samples

Logger.d("hello");
Logger.e(exception, "message");
Logger.json(JSON_CONTENT);

Method info

Observe the caller methods in the order they are invoked and also thread information.

void methodA(){
   methodB();
}
void methodA(){
   Logger.d("hello");
}

Both method information will be shown in the order of invocation.

Change method count (Default: 2)

All logs

Logger.init().methodCount(1);

Log based

Logger.t(1).d("hello");

Change method stack offset (Default: 0)

To integrate logger with other libraries, you can set the offset in order to avoid that library's methods.

Logger.init().methodOffset(5);

Hide thread information

Logger.init().methodCount(1).hideThreadInfo();

Only show the message

Logger.init().methodCount(0).hideThreadInfo();

Pretty print json, Logger.json

Format the json content in a pretty way

Logger.json(YOUR_JSON_DATA);

Log exceptions in a simple way

Show the cause of the exception

Logger.e(exception,"message");

Notes

  • Use the filter for a better result

  • Make sure that the wrap option is disabled

Timber Integration

You can also use logger along with Timber.

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 2015 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.