[](https://travis-ci.org/orhanobut/logger)
### Logger
Simple, pretty and powerful logger for android
### Setup
Download
```groovy
implementation 'com.orhanobut:logger:2.2.0'
```
Initialize
```java
Logger.addLogAdapter(new AndroidLogAdapter());
```
And use
```java
Logger.d("hello");
```
### Output
### Options
```java
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
```java
Logger.d("hello %s", "world");
```
Collections are supported (only available for debug logs)
```java
Logger.d(MAP);
Logger.d(SET);
Logger.d(LIST);
Logger.d(ARRAY);
```
Json and Xml support (output will be in debug level)
```java
Logger.json(JSON_CONTENT);
Logger.xml(XML_CONTENT);
```
### Advanced
```java
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.
```java
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
```java
Logger.addLogAdapter(new DiskLogAdapter());
```
Add custom tag to Csv format strategy
```java
FormatStrategy formatStrategy = CsvFormatStrategy.newBuilder()
.tag("custom")
.build();
Logger.addLogAdapter(new DiskLogAdapter(formatStrategy));
```
### How it works
### More
- 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
```java
// 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.================================================ FILE: build.gradle ================================================ buildscript { ext.kotlinVersion = '1.2.51' repositories { google() jcenter() } dependencies { classpath 'com.android.tools.build:gradle:3.2.0' classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlinVersion" } } allprojects { repositories { google() jcenter() } } subprojects { project -> group = GROUP version = VERSION_NAME apply plugin: 'checkstyle' task checkstyle(type: Checkstyle) { configFile rootProject.file('checkstyle.xml') source 'src/main/java' ignoreFailures false showViolations true include '**/*.java' classpath = files() } afterEvaluate { if (project.tasks.findByName('check')) { check.dependsOn('checkstyle') } } } task clean(type: Delete) { delete rootProject.buildDir } ext { minSdkVersion = 8 targetSdkVersion = 28 compileSdkVersion = 28 buildToolsVersion = '28.0.2' } ext.deps = [ junit : 'junit:junit:4.12', truth : 'com.google.truth:truth:0.28', robolectric : 'org.robolectric:robolectric:3.3', mockito : "org.mockito:mockito-core:2.8.9", json : "org.json:json:20160810", supportAnnotations: 'androidx.annotation:annotation:1.0.0', kotlin : "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlinVersion" ] ================================================ FILE: checkstyle.xml ================================================
* ┌────────────────────────── * │ Method stack history * ├┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄ * │ Log message * └────────────────────────── **/ public class AndroidLogAdapter implements LogAdapter { @NonNull private final FormatStrategy formatStrategy; public AndroidLogAdapter() { this.formatStrategy = PrettyFormatStrategy.newBuilder().build(); } public AndroidLogAdapter(@NonNull FormatStrategy formatStrategy) { this.formatStrategy = checkNotNull(formatStrategy); } @Override public boolean isLoggable(int priority, @Nullable String tag) { return true; } @Override public void log(int priority, @Nullable String tag, @NonNull String message) { formatStrategy.log(priority, tag, message); } } ================================================ FILE: logger/src/main/java/com/orhanobut/logger/CsvFormatStrategy.java ================================================ package com.orhanobut.logger; import android.os.Environment; import android.os.Handler; import android.os.HandlerThread; import androidx.annotation.NonNull; import androidx.annotation.Nullable; import java.io.File; import java.text.SimpleDateFormat; import java.util.Date; import java.util.Locale; import static com.orhanobut.logger.Utils.checkNotNull; /** * CSV formatted file logging for Android. * Writes to CSV the following data: * epoch timestamp, ISO8601 timestamp (human-readable), log level, tag, log message. */ public class CsvFormatStrategy implements FormatStrategy { private static final String NEW_LINE = System.getProperty("line.separator"); private static final String NEW_LINE_REPLACEMENT = "
* ┌──────────────────────────────────────────── * │ LOGGER * ├┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄ * │ Standard logging mechanism * ├┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄ * │ But more pretty, simple and powerful * └──────────────────────────────────────────── ** *
* Logger.addLogAdapter(new AndroidLogAdapter());
*
* Logger.d("debug");
* Logger.e("error");
* Logger.w("warning");
* Logger.v("verbose");
* Logger.i("information");
* Logger.wtf("What a Terrible Failure");
*
* Logger.d("hello %s", "world");
*
* Logger.d(MAP);
* Logger.d(SET);
* Logger.d(LIST);
* Logger.d(ARRAY);
*
* Logger.json(JSON_CONTENT);
* Logger.xml(XML_CONTENT);
* * ┌────────────────────────── * │ Method stack history * ├┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄ * │ Thread information * ├┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄ * │ Log message * └────────────────────────── ** *
* 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();
* Note: In platform versions 1.1 and earlier, this method only worked well if * both the arguments were instances of String.
* * @param a first CharSequence to check * @param b second CharSequence to check * @return true if a and b are equal *
* NOTE: Logic slightly change due to strict policy on CI -
* "Inner assignments should be avoided"
*/
static boolean equals(CharSequence a, CharSequence b) {
if (a == b) return true;
if (a != null && b != null) {
int length = a.length();
if (length == b.length()) {
if (a instanceof String && b instanceof String) {
return a.equals(b);
} else {
for (int i = 0; i < length; i++) {
if (a.charAt(i) != b.charAt(i)) return false;
}
return true;
}
}
}
return false;
}
/**
* Copied from "android.util.Log.getStackTraceString()" in order to avoid usage of Android stack
* in unit tests.
*
* @return Stack trace in form of String
*/
static String getStackTraceString(Throwable tr) {
if (tr == null) {
return "";
}
// This is to reduce the amount of log spew that apps do in the non-error
// condition of the network being unavailable.
Throwable t = tr;
while (t != null) {
if (t instanceof UnknownHostException) {
return "";
}
t = t.getCause();
}
StringWriter sw = new StringWriter();
PrintWriter pw = new PrintWriter(sw);
tr.printStackTrace(pw);
pw.flush();
return sw.toString();
}
static String logLevel(int value) {
switch (value) {
case VERBOSE:
return "VERBOSE";
case DEBUG:
return "DEBUG";
case INFO:
return "INFO";
case WARN:
return "WARN";
case ERROR:
return "ERROR";
case ASSERT:
return "ASSERT";
default:
return "UNKNOWN";
}
}
public static String toString(Object object) {
if (object == null) {
return "null";
}
if (!object.getClass().isArray()) {
return object.toString();
}
if (object instanceof boolean[]) {
return Arrays.toString((boolean[]) object);
}
if (object instanceof byte[]) {
return Arrays.toString((byte[]) object);
}
if (object instanceof char[]) {
return Arrays.toString((char[]) object);
}
if (object instanceof short[]) {
return Arrays.toString((short[]) object);
}
if (object instanceof int[]) {
return Arrays.toString((int[]) object);
}
if (object instanceof long[]) {
return Arrays.toString((long[]) object);
}
if (object instanceof float[]) {
return Arrays.toString((float[]) object);
}
if (object instanceof double[]) {
return Arrays.toString((double[]) object);
}
if (object instanceof Object[]) {
return Arrays.deepToString((Object[]) object);
}
return "Couldn't find a correct type for the object";
}
@NonNull static