1d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru/* 2d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * Copyright (C) 2011 The Android Open Source Project 3d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * 4d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * Licensed under the Apache License, Version 2.0 (the "License"); 5d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * you may not use this file except in compliance with the License. 6d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * You may obtain a copy of the License at 7d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * 8d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * http://www.apache.org/licenses/LICENSE-2.0 9d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * 10d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * Unless required by applicable law or agreed to in writing, software 11d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * distributed under the License is distributed on an "AS IS" BASIS, 12d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * See the License for the specific language governing permissions and 14d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * limitations under the License. 15d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru */ 16d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 17d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Querupackage com.android.volley; 18d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 19d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queruimport android.os.SystemClock; 20d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queruimport android.util.Log; 21d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 22d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queruimport java.util.ArrayList; 23d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queruimport java.util.List; 24d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queruimport java.util.Locale; 25d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 26d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru/** Logging helper class. */ 27d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Querupublic class VolleyLog { 28d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru public static String TAG = "Volley"; 29d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 308c5daf39f32ed5ed4e5dc8aa78cbcf5e169c3e4eEvan Charlton public static boolean DEBUG = Log.isLoggable(TAG, Log.VERBOSE); 318c5daf39f32ed5ed4e5dc8aa78cbcf5e169c3e4eEvan Charlton 328c5daf39f32ed5ed4e5dc8aa78cbcf5e169c3e4eEvan Charlton /** 338c5daf39f32ed5ed4e5dc8aa78cbcf5e169c3e4eEvan Charlton * Customize the log tag for your application, so that other apps 348c5daf39f32ed5ed4e5dc8aa78cbcf5e169c3e4eEvan Charlton * using Volley don't mix their logs with yours. 358c5daf39f32ed5ed4e5dc8aa78cbcf5e169c3e4eEvan Charlton * <br /> 368c5daf39f32ed5ed4e5dc8aa78cbcf5e169c3e4eEvan Charlton * Enable the log property for your tag before starting your app: 378c5daf39f32ed5ed4e5dc8aa78cbcf5e169c3e4eEvan Charlton * <br /> 388c5daf39f32ed5ed4e5dc8aa78cbcf5e169c3e4eEvan Charlton * {@code adb shell setprop log.tag.<tag>} 398c5daf39f32ed5ed4e5dc8aa78cbcf5e169c3e4eEvan Charlton */ 408c5daf39f32ed5ed4e5dc8aa78cbcf5e169c3e4eEvan Charlton public static void setTag(String tag) { 418c5daf39f32ed5ed4e5dc8aa78cbcf5e169c3e4eEvan Charlton d("Changing log tag to %s", tag); 428c5daf39f32ed5ed4e5dc8aa78cbcf5e169c3e4eEvan Charlton TAG = tag; 438c5daf39f32ed5ed4e5dc8aa78cbcf5e169c3e4eEvan Charlton 448c5daf39f32ed5ed4e5dc8aa78cbcf5e169c3e4eEvan Charlton // Reinitialize the DEBUG "constant" 458c5daf39f32ed5ed4e5dc8aa78cbcf5e169c3e4eEvan Charlton DEBUG = Log.isLoggable(TAG, Log.VERBOSE); 468c5daf39f32ed5ed4e5dc8aa78cbcf5e169c3e4eEvan Charlton } 47d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 48d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru public static void v(String format, Object... args) { 49d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru if (DEBUG) { 50d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru Log.v(TAG, buildMessage(format, args)); 51d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru } 52d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru } 53d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 54d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru public static void d(String format, Object... args) { 55d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru Log.d(TAG, buildMessage(format, args)); 56d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru } 57d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 58d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru public static void e(String format, Object... args) { 59d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru Log.e(TAG, buildMessage(format, args)); 60d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru } 61d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 62c0d371cf523ec7db27e0b619c174295c4c9e1ac0Evan Charlton public static void e(Throwable tr, String format, Object... args) { 63c0d371cf523ec7db27e0b619c174295c4c9e1ac0Evan Charlton Log.e(TAG, buildMessage(format, args), tr); 64c0d371cf523ec7db27e0b619c174295c4c9e1ac0Evan Charlton } 65c0d371cf523ec7db27e0b619c174295c4c9e1ac0Evan Charlton 66d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru public static void wtf(String format, Object... args) { 67d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru Log.wtf(TAG, buildMessage(format, args)); 68d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru } 69d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 70d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru public static void wtf(Throwable tr, String format, Object... args) { 71d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru Log.wtf(TAG, buildMessage(format, args), tr); 72d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru } 73d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 74d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru /** 75d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * Formats the caller's provided message and prepends useful info like 76d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * calling thread ID and method name. 77d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru */ 78d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru private static String buildMessage(String format, Object... args) { 79d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru String msg = (args == null) ? format : String.format(Locale.US, format, args); 80d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru StackTraceElement[] trace = new Throwable().fillInStackTrace().getStackTrace(); 81d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 82d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru String caller = "<unknown>"; 83d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru // Walk up the stack looking for the first caller outside of VolleyLog. 84d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru // It will be at least two frames up, so start there. 85d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru for (int i = 2; i < trace.length; i++) { 86d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru Class<?> clazz = trace[i].getClass(); 87d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru if (!clazz.equals(VolleyLog.class)) { 88d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru String callingClass = trace[i].getClassName(); 89d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru callingClass = callingClass.substring(callingClass.lastIndexOf('.') + 1); 90d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru callingClass = callingClass.substring(callingClass.lastIndexOf('$') + 1); 91d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 92d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru caller = callingClass + "." + trace[i].getMethodName(); 93d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru break; 94d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru } 95d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru } 96d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru return String.format(Locale.US, "[%d] %s: %s", 97d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru Thread.currentThread().getId(), caller, msg); 98d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru } 99d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 100d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru /** 101d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * A simple event log with records containing a name, thread ID, and timestamp. 102d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru */ 103d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru static class MarkerLog { 104d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru public static final boolean ENABLED = VolleyLog.DEBUG; 105d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 106d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru /** Minimum duration from first marker to last in an marker log to warrant logging. */ 107d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru private static final long MIN_DURATION_FOR_LOGGING_MS = 0; 108d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 109d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru private static class Marker { 110d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru public final String name; 111d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru public final long thread; 112d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru public final long time; 113d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 114d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru public Marker(String name, long thread, long time) { 115d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru this.name = name; 116d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru this.thread = thread; 117d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru this.time = time; 118d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru } 119d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru } 120d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 121d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru private final List<Marker> mMarkers = new ArrayList<Marker>(); 122d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru private boolean mFinished = false; 123d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 124d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru /** Adds a marker to this log with the specified name. */ 125d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru public synchronized void add(String name, long threadId) { 126d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru if (mFinished) { 127d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru throw new IllegalStateException("Marker added to finished log"); 128d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru } 129d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 130d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru mMarkers.add(new Marker(name, threadId, SystemClock.elapsedRealtime())); 131d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru } 132d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 133d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru /** 134d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * Closes the log, dumping it to logcat if the time difference between 135d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * the first and last markers is greater than {@link #MIN_DURATION_FOR_LOGGING_MS}. 136d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * @param header Header string to print above the marker log. 137d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru */ 138d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru public synchronized void finish(String header) { 139d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru mFinished = true; 140d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 141d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru long duration = getTotalDuration(); 142d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru if (duration <= MIN_DURATION_FOR_LOGGING_MS) { 143d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru return; 144d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru } 145d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 146d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru long prevTime = mMarkers.get(0).time; 147d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru d("(%-4d ms) %s", duration, header); 148d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru for (Marker marker : mMarkers) { 149d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru long thisTime = marker.time; 150d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru d("(+%-4d) [%2d] %s", (thisTime - prevTime), marker.thread, marker.name); 151d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru prevTime = thisTime; 152d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru } 153d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru } 154d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 155d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru @Override 156d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru protected void finalize() throws Throwable { 157d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru // Catch requests that have been collected (and hence end-of-lifed) 158d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru // but had no debugging output printed for them. 159d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru if (!mFinished) { 160d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru finish("Request on the loose"); 161d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru e("Marker log finalized without finish() - uncaught exit point for request"); 162d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru } 163d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru } 164d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 165d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru /** Returns the time difference between the first and last events in this log. */ 166d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru private long getTotalDuration() { 167d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru if (mMarkers.size() == 0) { 168d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru return 0; 169d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru } 170d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 171d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru long first = mMarkers.get(0).time; 172d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru long last = mMarkers.get(mMarkers.size() - 1).time; 173d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru return last - first; 174d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru } 175d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru } 176d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru} 177