[](https://travis-ci.org/orhanobut/logger)
3 |
4 | 
5 |
6 | ### Logger
7 | Simple, pretty and powerful logger for android
8 |
9 | ### Setup
10 | Download
11 | ```groovy
12 | implementation 'com.orhanobut:logger:2.2.0'
13 | ```
14 |
15 | Initialize
16 | ```java
17 | Logger.addLogAdapter(new AndroidLogAdapter());
18 | ```
19 | And use
20 | ```java
21 | Logger.d("hello");
22 | ```
23 |
24 | ### Output
25 | 
26 |
27 |
28 | ### Options
29 | ```java
30 | Logger.d("debug");
31 | Logger.e("error");
32 | Logger.w("warning");
33 | Logger.v("verbose");
34 | Logger.i("information");
35 | Logger.wtf("What a Terrible Failure");
36 | ```
37 |
38 | String format arguments are supported
39 | ```java
40 | Logger.d("hello %s", "world");
41 | ```
42 |
43 | Collections are supported (only available for debug logs)
44 | ```java
45 | Logger.d(MAP);
46 | Logger.d(SET);
47 | Logger.d(LIST);
48 | Logger.d(ARRAY);
49 | ```
50 |
51 | Json and Xml support (output will be in debug level)
52 | ```java
53 | Logger.json(JSON_CONTENT);
54 | Logger.xml(XML_CONTENT);
55 | ```
56 |
57 | ### Advanced
58 | ```java
59 | FormatStrategy formatStrategy = PrettyFormatStrategy.newBuilder()
60 | .showThreadInfo(false) // (Optional) Whether to show thread info or not. Default true
61 | .methodCount(0) // (Optional) How many method line to show. Default 2
62 | .methodOffset(7) // (Optional) Hides internal method calls up to offset. Default 5
63 | .logStrategy(customLog) // (Optional) Changes the log strategy to print out. Default LogCat
64 | .tag("My custom tag") // (Optional) Global tag for every log. Default PRETTY_LOGGER
65 | .build();
66 |
67 | Logger.addLogAdapter(new AndroidLogAdapter(formatStrategy));
68 | ```
69 |
70 | ### Loggable
71 | Log adapter checks whether the log should be printed or not by checking this function.
72 | If you want to disable/hide logs for output, override `isLoggable` method.
73 | `true` will print the log message, `false` will ignore it.
74 | ```java
75 | Logger.addLogAdapter(new AndroidLogAdapter() {
76 | @Override public boolean isLoggable(int priority, String tag) {
77 | return BuildConfig.DEBUG;
78 | }
79 | });
80 | ```
81 |
82 | ### Save logs to the file
83 | //TODO: More information will be added later
84 | ```java
85 | Logger.addLogAdapter(new DiskLogAdapter());
86 | ```
87 |
88 | Add custom tag to Csv format strategy
89 | ```java
90 | FormatStrategy formatStrategy = CsvFormatStrategy.newBuilder()
91 | .tag("custom")
92 | .build();
93 |
94 | Logger.addLogAdapter(new DiskLogAdapter(formatStrategy));
95 | ```
96 |
97 | ### How it works
98 | 
99 |
100 |
101 | ### More
102 | - Use filter for a better result. PRETTY_LOGGER or your custom tag
103 | - Make sure that wrap option is disabled
104 | - You can also simplify output by changing settings.
105 |
106 | 
107 |
108 | - Timber Integration
109 | ```java
110 | // Set methodOffset to 5 in order to hide internal method calls
111 | Timber.plant(new Timber.DebugTree() {
112 | @Override protected void log(int priority, String tag, String message, Throwable t) {
113 | Logger.log(priority, tag, message, t);
114 | }
115 | });
116 | ```
117 |
118 | ### License
119 | 120 | Copyright 2018 Orhan Obut 121 | 122 | Licensed under the Apache License, Version 2.0 (the "License"); 123 | you may not use this file except in compliance with the License. 124 | You may obtain a copy of the License at 125 | 126 | http://www.apache.org/licenses/LICENSE-2.0 127 | 128 | Unless required by applicable law or agreed to in writing, software 129 | distributed under the License is distributed on an "AS IS" BASIS, 130 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 131 | See the License for the specific language governing permissions and 132 | limitations under the License. 133 |134 | -------------------------------------------------------------------------------- /art/how_it_works.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orhanobut/logger/c64a72c2ce3d0fcdebe829b091e3a530c94ca6bd/art/how_it_works.png -------------------------------------------------------------------------------- /art/logcat_options.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orhanobut/logger/c64a72c2ce3d0fcdebe829b091e3a530c94ca6bd/art/logcat_options.png -------------------------------------------------------------------------------- /art/logger-logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orhanobut/logger/c64a72c2ce3d0fcdebe829b091e3a530c94ca6bd/art/logger-logo.png -------------------------------------------------------------------------------- /art/logger_output.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orhanobut/logger/c64a72c2ce3d0fcdebe829b091e3a530c94ca6bd/art/logger_output.png -------------------------------------------------------------------------------- /build.gradle: -------------------------------------------------------------------------------- 1 | buildscript { 2 | ext.kotlinVersion = '1.2.51' 3 | repositories { 4 | google() 5 | jcenter() 6 | } 7 | dependencies { 8 | classpath 'com.android.tools.build:gradle:3.2.0' 9 | classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlinVersion" 10 | } 11 | } 12 | 13 | allprojects { 14 | repositories { 15 | google() 16 | jcenter() 17 | } 18 | } 19 | 20 | subprojects { project -> 21 | group = GROUP 22 | version = VERSION_NAME 23 | 24 | apply plugin: 'checkstyle' 25 | 26 | task checkstyle(type: Checkstyle) { 27 | configFile rootProject.file('checkstyle.xml') 28 | source 'src/main/java' 29 | ignoreFailures false 30 | showViolations true 31 | include '**/*.java' 32 | 33 | classpath = files() 34 | } 35 | 36 | afterEvaluate { 37 | if (project.tasks.findByName('check')) { 38 | check.dependsOn('checkstyle') 39 | } 40 | } 41 | } 42 | 43 | task clean(type: Delete) { 44 | delete rootProject.buildDir 45 | } 46 | 47 | ext { 48 | minSdkVersion = 8 49 | targetSdkVersion = 28 50 | compileSdkVersion = 28 51 | buildToolsVersion = '28.0.2' 52 | } 53 | 54 | ext.deps = [ 55 | junit : 'junit:junit:4.12', 56 | truth : 'com.google.truth:truth:0.28', 57 | robolectric : 'org.robolectric:robolectric:3.3', 58 | mockito : "org.mockito:mockito-core:2.8.9", 59 | json : "org.json:json:20160810", 60 | supportAnnotations: 'androidx.annotation:annotation:1.0.0', 61 | kotlin : "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlinVersion" 62 | ] -------------------------------------------------------------------------------- /checkstyle.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 6 |
14 | * ┌────────────────────────── 15 | * │ Method stack history 16 | * ├┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄ 17 | * │ Log message 18 | * └────────────────────────── 19 | *20 | */ 21 | public class AndroidLogAdapter implements LogAdapter { 22 | 23 | @NonNull private final FormatStrategy formatStrategy; 24 | 25 | public AndroidLogAdapter() { 26 | this.formatStrategy = PrettyFormatStrategy.newBuilder().build(); 27 | } 28 | 29 | public AndroidLogAdapter(@NonNull FormatStrategy formatStrategy) { 30 | this.formatStrategy = checkNotNull(formatStrategy); 31 | } 32 | 33 | @Override public boolean isLoggable(int priority, @Nullable String tag) { 34 | return true; 35 | } 36 | 37 | @Override public void log(int priority, @Nullable String tag, @NonNull String message) { 38 | formatStrategy.log(priority, tag, message); 39 | } 40 | 41 | } 42 | -------------------------------------------------------------------------------- /logger/src/main/java/com/orhanobut/logger/CsvFormatStrategy.java: -------------------------------------------------------------------------------- 1 | package com.orhanobut.logger; 2 | 3 | import android.os.Environment; 4 | import android.os.Handler; 5 | import android.os.HandlerThread; 6 | import androidx.annotation.NonNull; 7 | import androidx.annotation.Nullable; 8 | 9 | import java.io.File; 10 | import java.text.SimpleDateFormat; 11 | import java.util.Date; 12 | import java.util.Locale; 13 | 14 | import static com.orhanobut.logger.Utils.checkNotNull; 15 | 16 | /** 17 | * CSV formatted file logging for Android. 18 | * Writes to CSV the following data: 19 | * epoch timestamp, ISO8601 timestamp (human-readable), log level, tag, log message. 20 | */ 21 | public class CsvFormatStrategy implements FormatStrategy { 22 | 23 | private static final String NEW_LINE = System.getProperty("line.separator"); 24 | private static final String NEW_LINE_REPLACEMENT = "
10 | * ┌──────────────────────────────────────────── 11 | * │ LOGGER 12 | * ├┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄ 13 | * │ Standard logging mechanism 14 | * ├┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄ 15 | * │ But more pretty, simple and powerful 16 | * └──────────────────────────────────────────── 17 | *18 | * 19 | *
22 | * Logger.addLogAdapter(new AndroidLogAdapter());
23 | *
28 | * Logger.d("debug");
29 | * Logger.e("error");
30 | * Logger.w("warning");
31 | * Logger.v("verbose");
32 | * Logger.i("information");
33 | * Logger.wtf("What a Terrible Failure");
34 | *
38 | * Logger.d("hello %s", "world");
39 | *
43 | * Logger.d(MAP);
44 | * Logger.d(SET);
45 | * Logger.d(LIST);
46 | * Logger.d(ARRAY);
47 | *
51 | * Logger.json(JSON_CONTENT);
52 | * Logger.xml(XML_CONTENT);
53 | * 17 | * ┌────────────────────────── 18 | * │ Method stack history 19 | * ├┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄ 20 | * │ Thread information 21 | * ├┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄ 22 | * │ Log message 23 | * └────────────────────────── 24 | *25 | * 26 | *
28 | * FormatStrategy formatStrategy = PrettyFormatStrategy.newBuilder()
29 | * .showThreadInfo(false) // (Optional) Whether to show thread info or not. Default true
30 | * .methodCount(0) // (Optional) How many method line to show. Default 2
31 | * .methodOffset(7) // (Optional) Hides internal method calls up to offset. Default 5
32 | * .logStrategy(customLog) // (Optional) Changes the log strategy to print out. Default LogCat
33 | * .tag("My custom tag") // (Optional) Global tag for every log. Default PRETTY_LOGGER
34 | * .build();
35 | * Note: In platform versions 1.1 and earlier, this method only worked well if 40 | * both the arguments were instances of String.
41 | * 42 | * @param a first CharSequence to check 43 | * @param b second CharSequence to check 44 | * @return true if a and b are equal 45 | *
46 | * NOTE: Logic slightly change due to strict policy on CI -
47 | * "Inner assignments should be avoided"
48 | */
49 | static boolean equals(CharSequence a, CharSequence b) {
50 | if (a == b) return true;
51 | if (a != null && b != null) {
52 | int length = a.length();
53 | if (length == b.length()) {
54 | if (a instanceof String && b instanceof String) {
55 | return a.equals(b);
56 | } else {
57 | for (int i = 0; i < length; i++) {
58 | if (a.charAt(i) != b.charAt(i)) return false;
59 | }
60 | return true;
61 | }
62 | }
63 | }
64 | return false;
65 | }
66 |
67 | /**
68 | * Copied from "android.util.Log.getStackTraceString()" in order to avoid usage of Android stack
69 | * in unit tests.
70 | *
71 | * @return Stack trace in form of String
72 | */
73 | static String getStackTraceString(Throwable tr) {
74 | if (tr == null) {
75 | return "";
76 | }
77 |
78 | // This is to reduce the amount of log spew that apps do in the non-error
79 | // condition of the network being unavailable.
80 | Throwable t = tr;
81 | while (t != null) {
82 | if (t instanceof UnknownHostException) {
83 | return "";
84 | }
85 | t = t.getCause();
86 | }
87 |
88 | StringWriter sw = new StringWriter();
89 | PrintWriter pw = new PrintWriter(sw);
90 | tr.printStackTrace(pw);
91 | pw.flush();
92 | return sw.toString();
93 | }
94 |
95 | static String logLevel(int value) {
96 | switch (value) {
97 | case VERBOSE:
98 | return "VERBOSE";
99 | case DEBUG:
100 | return "DEBUG";
101 | case INFO:
102 | return "INFO";
103 | case WARN:
104 | return "WARN";
105 | case ERROR:
106 | return "ERROR";
107 | case ASSERT:
108 | return "ASSERT";
109 | default:
110 | return "UNKNOWN";
111 | }
112 | }
113 |
114 | public static String toString(Object object) {
115 | if (object == null) {
116 | return "null";
117 | }
118 | if (!object.getClass().isArray()) {
119 | return object.toString();
120 | }
121 | if (object instanceof boolean[]) {
122 | return Arrays.toString((boolean[]) object);
123 | }
124 | if (object instanceof byte[]) {
125 | return Arrays.toString((byte[]) object);
126 | }
127 | if (object instanceof char[]) {
128 | return Arrays.toString((char[]) object);
129 | }
130 | if (object instanceof short[]) {
131 | return Arrays.toString((short[]) object);
132 | }
133 | if (object instanceof int[]) {
134 | return Arrays.toString((int[]) object);
135 | }
136 | if (object instanceof long[]) {
137 | return Arrays.toString((long[]) object);
138 | }
139 | if (object instanceof float[]) {
140 | return Arrays.toString((float[]) object);
141 | }
142 | if (object instanceof double[]) {
143 | return Arrays.toString((double[]) object);
144 | }
145 | if (object instanceof Object[]) {
146 | return Arrays.deepToString((Object[]) object);
147 | }
148 | return "Couldn't find a correct type for the object";
149 | }
150 |
151 | @NonNull static