AndroidHandler.java revision ef0996ffa36cfe9b7927e09aece801fb4f594ced
19066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/* 29066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Copyright (C) 2008 The Android Open Source Project 39066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 49066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Licensed under the Apache License, Version 2.0 (the "License"); 59066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * you may not use this file except in compliance with the License. 69066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * You may obtain a copy of the License at 79066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 89066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 99066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Unless required by applicable law or agreed to in writing, software 119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * See the License for the specific language governing permissions and 149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * limitations under the License. 159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpackage com.android.internal.logging; 189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.util.Log; 209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport java.util.logging.*; 229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport java.util.Date; 239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport java.text.MessageFormat; 249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport java.io.PrintWriter; 259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport java.io.StringWriter; 269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/** 289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Implements a {@link java.util.logging.Logger} handler that writes to the Android log. The 299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * implementation is rather straightforward. The name of the logger serves as 309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the log tag. Only the log levels need to be converted appropriately. For 319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * this purpose, the following mapping is being used: 329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <table> 349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <tr> 359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <th>logger level</th> 369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <th>Android level</th> 379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </tr> 389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <tr> 399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td> 409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * SEVERE 419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </td> 429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td> 439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * ERROR 449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </td> 459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </tr> 469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <tr> 479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td> 489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * WARNING 499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </td> 509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td> 519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * WARN 529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </td> 539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </tr> 549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <tr> 559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td> 569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * INFO 579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </td> 589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td> 599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * INFO 609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </td> 619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </tr> 629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <tr> 639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td> 649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * CONFIG 659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </td> 669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td> 679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * DEBUG 689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </td> 699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </tr> 709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <tr> 719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td> 729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * FINE, FINER, FINEST 739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </td> 749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <td> 759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * VERBOSE 769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </td> 779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </tr> 789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </table> 799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpublic class AndroidHandler extends Handler { 819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Holds the formatter for all Android log handlers. 839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private static final Formatter THE_FORMATTER = new Formatter() { 859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project @Override 869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public String format(LogRecord r) { 879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Throwable thrown = r.getThrown(); 889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (thrown != null) { 899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project StringWriter sw = new StringWriter(); 909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project PrintWriter pw = new PrintWriter(sw); 919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project sw.write(r.getMessage()); 929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project sw.write("\n"); 939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project thrown.printStackTrace(pw); 949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project pw.flush(); 959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return sw.toString(); 969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } else { 979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return r.getMessage(); 989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project }; 1019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Constructs a new instance of the Android log handler. 1049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public AndroidHandler() { 1069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project setFormatter(THE_FORMATTER); 1079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project @Override 1109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void close() { 1119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // No need to close, but must implement abstract method. 1129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project @Override 1159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void flush() { 1169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // No need to flush, but must implement abstract method. 1179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project @Override 1209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void publish(LogRecord record) { 1219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project try { 1229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project int level = getAndroidLevel(record.getLevel()); 1239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project String tag = record.getLoggerName(); 1249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (tag == null) { 1269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // Anonymous logger. 1279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project tag = "null"; 1289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } else { 1299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // Tags must be <= 23 characters. 1309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project int length = tag.length(); 1319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (length > 23) { 1329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // Most loggers use the full class name. Try dropping the 1339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // package. 1349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project int lastPeriod = tag.lastIndexOf("."); 1359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (length - lastPeriod - 1 <= 23) { 1369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project tag = tag.substring(lastPeriod + 1); 1379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } else { 1389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // Use last 23 chars. 1399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project tag = tag.substring(tag.length() - 23); 1409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (!Log.isLoggable(tag, level)) { 1459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return; 1469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project String message = getFormatter().format(record); 1499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Log.println(level, tag, message); 1509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } catch (RuntimeException e) { 1519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Log.e("AndroidHandler", "Error logging message.", e); 1529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 154ef0996ffa36cfe9b7927e09aece801fb4f594cedBob Lee 1559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Converts a {@link java.util.logging.Logger} logging level into an Android one. 1579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param level The {@link java.util.logging.Logger} logging level. 1599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The resulting Android logging level. 1619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 162ef0996ffa36cfe9b7927e09aece801fb4f594cedBob Lee static int getAndroidLevel(Level level) { 1639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project int value = level.intValue(); 164ef0996ffa36cfe9b7927e09aece801fb4f594cedBob Lee if (value >= 1000) { // SEVERE 1659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return Log.ERROR; 166ef0996ffa36cfe9b7927e09aece801fb4f594cedBob Lee } else if (value >= 900) { // WARNING 1679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return Log.WARN; 168ef0996ffa36cfe9b7927e09aece801fb4f594cedBob Lee } else if (value >= 800) { // INFO 1699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return Log.INFO; 170ef0996ffa36cfe9b7927e09aece801fb4f594cedBob Lee } else { 1719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return Log.DEBUG; 1729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project} 176