Author: markt Date: Wed Apr 7 20:19:24 2010 New Revision: 931666 URL: http://svn.apache.org/viewvc?rev=931666&view=rev Log: Improve log messages when a potential leak is detected by including the name of the offending context
Modified: tomcat/tc6.0.x/trunk/ (props changed) tomcat/tc6.0.x/trunk/STATUS.txt tomcat/tc6.0.x/trunk/java/org/apache/catalina/loader/LocalStrings.properties tomcat/tc6.0.x/trunk/java/org/apache/catalina/loader/WebappClassLoader.java tomcat/tc6.0.x/trunk/webapps/docs/changelog.xml Propchange: tomcat/tc6.0.x/trunk/ ------------------------------------------------------------------------------ --- svn:mergeinfo (original) +++ svn:mergeinfo Wed Apr 7 20:19:24 2010 @@ -1 +1 @@ -/tomcat/trunk:601180,606992,612607,630314,640888,652744,653247,666232,673796,673820,677910,683969,683982,684001,684081,684234,684269-684270,685177,687503,687645,689402,690781,691392,691805,692748,693378,694992,695053,695311,696780,696782,698012,698227,698236,698613,699427,699634,701355,709294,709811,709816,710063,710066,710125,710205,711126,711600,712461,712467,713953,714002,718360,719119,719124,719602,719626,719628,720046,720069,721040,721286,721708,721886,723404,723738,726052,727303,728032,728768,728947,729057,729567,729569,729571,729681,729809,729815,729934,730250,730590,731651,732859,732863,734734,740675,740684,742677,742697,742714,744160,744238,746321,746384,746425,747834,747863,748344,750258,750291,750921,751286-751287,751289,751295,752323,753039,757335,757774,758249,758365,758596,758616,758664,759074,761601,762868,762929,762936-762937,763166,763183,763193,763228,763262,763298,763302,763325,763599,763611,763654,763681,763706,764985,764997,765662,768335,769979,770716,77 0809,770876,772872,776921,776924,776935,776945,777464,777466,777576,777625,778379,778523-778524,781528,781779,782145,782791,783316,783696,783724,783756,783762,783766,783863,783934,784453,784602,784614,785381,785688,785768,785859,786468,786487,786490,786496,786667,787627,787770,787985,789389,790405,791041,791184,791194,791224,791243,791326,791328,791789,792740,793372,793757,793882,793981,794082,794673,794822,795043,795152,795210,795457,795466,797168,797425,797596,797607,802727,802940,804462,804544,804734,805153,809131,809603,810916,810977,812125,812137,812432,813001,813013,813866,814180,814708,814876,815972,816252,817442,817822,819339,819361,820110,820132,820874,820954,821397,828196,828201,828210,828225,828759,830378-830379,830999,831106,831774,831785,831828,831850,831860,832214,832218,833121,833545,834047,835036,835336,836405,881396,881412,883130,883134,883146,883165,883177,883362,883565,884341,885038,885231,885241,885260,885901,885991,886019,888072,889363,889606,889716,8901 39,890265,890349-890350,890417,891185-891187,891583,892198,892341,892415,892464,892555,892812,892814,892817,892843,892887,893321,893493,894580,894586,894805,894831,895013,895045,895057,895191,895392,895703,896370,896384,897380-897381,897776,898126,898256,898468,898527,898555,898558,898718,898836,898906,899284,899348,899420,899653,899769-899770,899783,899788,899792,899916,899918-899919,899935,899949,903916,905020,905151,905722,905728,905735,907311,907513,907538,907652,907819,907825,907864,908002,908721,908754,908759,909097,909206,909212,909525,909636,909869,909875,909887,910266,910370,910442,910471,910974,915226,915737,915861,916097,916141,916157,916170,917598,917633,918093,918594,918684,918787,918792,918799,918885,919851,919914,920025,920055,920596 +/tomcat/trunk:601180,606992,612607,630314,640888,652744,653247,666232,673796,673820,677910,683969,683982,684001,684081,684234,684269-684270,685177,687503,687645,689402,690781,691392,691805,692748,693378,694992,695053,695311,696780,696782,698012,698227,698236,698613,699427,699634,701355,709294,709811,709816,710063,710066,710125,710205,711126,711600,712461,712467,713953,714002,718360,719119,719124,719602,719626,719628,720046,720069,721040,721286,721708,721886,723404,723738,726052,727303,728032,728768,728947,729057,729567,729569,729571,729681,729809,729815,729934,730250,730590,731651,732859,732863,734734,740675,740684,742677,742697,742714,744160,744238,746321,746384,746425,747834,747863,748344,750258,750291,750921,751286-751287,751289,751295,752323,753039,757335,757774,758249,758365,758596,758616,758664,759074,761601,762868,762929,762936-762937,763166,763183,763193,763228,763262,763298,763302,763325,763599,763611,763654,763681,763706,764985,764997,765662,768335,769979,770716,77 0809,770876,772872,776921,776924,776935,776945,777464,777466,777576,777625,778379,778523-778524,781528,781779,782145,782791,783316,783696,783724,783756,783762,783766,783863,783934,784453,784602,784614,785381,785688,785768,785859,786468,786487,786490,786496,786667,787627,787770,787985,789389,790405,791041,791184,791194,791224,791243,791326,791328,791789,792740,793372,793757,793882,793981,794082,794673,794822,795043,795152,795210,795457,795466,797168,797425,797596,797607,802727,802940,804462,804544,804734,805153,809131,809603,810916,810977,812125,812137,812432,813001,813013,813866,814180,814708,814876,815972,816252,817442,817822,819339,819361,820110,820132,820874,820954,821397,828196,828201,828210,828225,828759,830378-830379,830999,831106,831774,831785,831828,831850,831860,832214,832218,833121,833545,834047,835036,835336,836405,881396,881412,883130,883134,883146,883165,883177,883362,883565,884341,885038,885231,885241,885260,885901,885991,886019,888072,889363,889606,889716,8901 39,890265,890349-890350,890417,891185-891187,891583,892198,892341,892415,892464,892555,892812,892814,892817,892843,892887,893321,893493,894580,894586,894805,894831,895013,895045,895057,895191,895392,895703,896370,896384,897380-897381,897776,898126,898256,898468,898527,898555,898558,898718,898836,898906,899284,899348,899420,899653,899769-899770,899783,899788,899792,899916,899918-899919,899935,899949,903916,905020,905151,905722,905728,905735,907311,907513,907538,907652,907819,907825,907864,908002,908721,908754,908759,909097,909206,909212,909525,909636,909869,909875,909887,910266,910370,910442,910471,910974,915226,915737,915861,916097,916141,916157,916170,917598,917633,918093,918594,918684,918787,918792,918799,918885,919851,919914,920025,920055,920298,920596 Modified: tomcat/tc6.0.x/trunk/STATUS.txt URL: http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/STATUS.txt?rev=931666&r1=931665&r2=931666&view=diff ============================================================================== --- tomcat/tc6.0.x/trunk/STATUS.txt (original) +++ tomcat/tc6.0.x/trunk/STATUS.txt Wed Apr 7 20:19:24 2010 @@ -99,12 +99,6 @@ PATCHES PROPOSED TO BACKPORT: +1: kkolinko, markt -1: -* Improve log messages when a potential leak is detected by including the name - of the offending context - http://svn.apache.org/viewvc?view=revision&revision=920298 - +1: markt, kkolinko, kfujino - -1: - * Fix https://issues.apache.org/bugzilla/show_bug.cgi?id=48629 Allow user names as well as DNs to be used with the nested role search Add roleNested to the docs Modified: tomcat/tc6.0.x/trunk/java/org/apache/catalina/loader/LocalStrings.properties URL: http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/catalina/loader/LocalStrings.properties?rev=931666&r1=931665&r2=931666&view=diff ============================================================================== --- tomcat/tc6.0.x/trunk/java/org/apache/catalina/loader/LocalStrings.properties (original) +++ tomcat/tc6.0.x/trunk/java/org/apache/catalina/loader/LocalStrings.properties Wed Apr 7 20:19:24 2010 @@ -29,23 +29,23 @@ standardLoader.removeRepository=Removing standardLoader.starting=Starting this Loader standardLoader.stopping=Stopping this Loader webappClassLoader.illegalJarPath=Illegal JAR entry detected with name {0} -webappClassLoader.jdbcRemoveFailed=JDBC driver de-registration failed -webappClassLoader.jdbcRemoveStreamError=Exception closing input stream during JDBC driver de-registration +webappClassLoader.jdbcRemoveFailed=JDBC driver de-registration failed for web application [{0}] +webappClassLoader.jdbcRemoveStreamError=Exception closing input stream during JDBC driver de-registration for web application [{0}] webappClassLoader.stopped=Illegal access: this web application instance has been stopped already. Could not load {0}. The eventual following stack trace is caused by an error thrown for debugging purposes as well as to attempt to terminate the thread which caused the illegal access, and has no functional impact. webappClassLoader.readError=Resource read error: Could not load {0}. -webappClassLoader.clearJbdc=A web application registered the JBDC driver [{0}] but failed to unregister it when the web application was stopped. To prevent a memory leak, the JDBC Driver has been forcibly unregistered. -webappClassLoader.clearReferencesResourceBundlesCount=Removed [{0}] ResourceBundle references from the cache -webappClassLoader.clearReferencesResourceBundlesFail=Failed to clear ResourceBundle references -webappClassLoader.clearRmiInfo=Failed to find class sun.rmi.transport.Target to clear context class loader. This is expected on non-Sun JVMs. -webappClassLoader.clearRmiFail=Failed to clear context class loader referenced from sun.rmi.transport.Target -webappClassLoader.clearThreadLocalDebug=A web application created a ThreadLocal with key of type [{0}] (value [{1}]). The ThreadLocal has been correctly set to null and the key will be removed by GC. However, to simplify the process of tracing memory leaks, the key has been forcibly removed. -webappClassLoader.clearThreadLocal=A web application created a ThreadLocal with key of type [{0}] (value [{1}]) and a value of type [{2}] (value [{3}]) but failed to remove it when the web application was stopped. To prevent a memory leak, the ThreadLocal has been forcibly removed. -webappClassLoader.clearThreadLocalFail=Failed to clear ThreadLocal references -webappClassLoader.stopThreadFail=Failed to terminate thread named [{0}] -webappClassLoader.stopTimerThreadFail=Failed to terminate TimerThread named [{0}] +webappClassLoader.clearJbdc=The web application [{0}] registered the JBDC driver [{1}] but failed to unregister it when the web application was stopped. To prevent a memory leak, the JDBC Driver has been forcibly unregistered. +webappClassLoader.clearReferencesResourceBundlesCount=Removed [{0}] ResourceBundle references from the cache for web application [{1}] +webappClassLoader.clearReferencesResourceBundlesFail=Failed to clear ResourceBundle references for web application [{0}] +webappClassLoader.clearRmiInfo=Failed to find class sun.rmi.transport.Target to clear context class loader for web application [{0}]. This is expected on non-Sun JVMs. +webappClassLoader.clearRmiFail=Failed to clear context class loader referenced from sun.rmi.transport.Target for web application [{0}] +webappClassLoader.clearThreadLocalDebug=The web application [{0}] created a ThreadLocal with key of type [{1}] (value [{2}]). The ThreadLocal has been correctly set to null and the key will be removed by GC. However, to simplify the process of tracing memory leaks, the key has been forcibly removed. +webappClassLoader.clearThreadLocal=The web application [{0}] created a ThreadLocal with key of type [{1}] (value [{2}]) and a value of type [{3}] (value [{4}]) but failed to remove it when the web application was stopped. To prevent a memory leak, the ThreadLocal has been forcibly removed. +webappClassLoader.clearThreadLocalFail=Failed to clear ThreadLocal references for web application [{0}] +webappClassLoader.stopThreadFail=Failed to terminate thread named [{0}] for web application [{1}] +webappClassLoader.stopTimerThreadFail=Failed to terminate TimerThread named [{0}] for web application [{1}] webappClassLoader.validationErrorJarPath=Unable to validate JAR entry with name {0} -webappClassLoader.warnThread=A web application appears to have started a thread named [{0}] but has failed to stop it. This is very likely to create a memory leak. -webappClassLoader.warnTimerThread=A web application appears to have started a TimerThread named [{0}] via the java.util.Timer API but has failed to stop it. To prevent a memory leak, the timer (and hence the associated thread) has been forcibly cancelled. +webappClassLoader.warnThread=The web application [{0}] appears to have started a thread named [{1}] but has failed to stop it. This is very likely to create a memory leak. +webappClassLoader.warnTimerThread=The web application [{0}] appears to have started a TimerThread named [{1}] via the java.util.Timer API but has failed to stop it. To prevent a memory leak, the timer (and hence the associated thread) has been forcibly canceled. webappClassLoader.wrongVersion=(unable to load class {0}) webappLoader.addRepository=Adding repository {0} webappLoader.deploy=Deploying class repositories to work directory {0} Modified: tomcat/tc6.0.x/trunk/java/org/apache/catalina/loader/WebappClassLoader.java URL: http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/java/org/apache/catalina/loader/WebappClassLoader.java?rev=931666&r1=931665&r2=931666&view=diff ============================================================================== --- tomcat/tc6.0.x/trunk/java/org/apache/catalina/loader/WebappClassLoader.java (original) +++ tomcat/tc6.0.x/trunk/java/org/apache/catalina/loader/WebappClassLoader.java Wed Apr 7 20:19:24 2010 @@ -70,6 +70,7 @@ import org.apache.catalina.LifecycleList import org.apache.catalina.util.StringManager; import org.apache.jasper.servlet.JasperLoader; import org.apache.naming.JndiPermission; +import org.apache.naming.resources.ProxyDirContext; import org.apache.naming.resources.Resource; import org.apache.naming.resources.ResourceAttributes; import org.apache.tomcat.util.IntrospectionUtils; @@ -458,6 +459,16 @@ public class WebappClassLoader */ private boolean clearReferencesLogFactoryRelease = true; + + /** + * Name of associated context used with logging to associate messages with + * the right web application. Particularly useful for the clear references + * messages. Defaults to unknown but if standard Tomcat components are used + * it will be updated during initialisation from the resources. + */ + private String contextName = "unknown"; + + // ------------------------------------------------------------- Properties @@ -478,6 +489,9 @@ public class WebappClassLoader this.resources = resources; + if (resources instanceof ProxyDirContext) { + contextName = ((ProxyDirContext) resources).getContextName(); + } } @@ -1656,7 +1670,7 @@ public class WebappClassLoader // Clearing references should be done before setting started to // false, due to possible side effects clearReferences(); - + started = false; int length = files.length; @@ -1820,18 +1834,21 @@ public class WebappClassLoader List<String> driverNames = (List<String>) obj.getClass().getMethod( "clearJdbcDriverRegistrations").invoke(obj); for (String name : driverNames) { - log.error(sm.getString("webappClassLoader.clearJbdc", name)); + log.error(sm.getString("webappClassLoader.clearJbdc", + contextName, name)); } } catch (Exception e) { // So many things to go wrong above... - log.warn(sm.getString("webappClassLoader.jdbcRemoveFailed"), e); + log.warn(sm.getString( + "webappClassLoader.jdbcRemoveFailed", contextName), e); } finally { if (is != null) { try { is.close(); } catch (IOException ioe) { log.warn(sm.getString( - "webappClassLoader.jdbcRemoveStreamError"), ioe); + "webappClassLoader.jdbcRemoveStreamError", + contextName), ioe); } } } @@ -1996,7 +2013,7 @@ public class WebappClassLoader } log.error(sm.getString("webappClassLoader.warnThread", - thread.getName())); + contextName, thread.getName())); // Don't try an stop the threads unless explicitly // configured to do so @@ -2026,19 +2043,19 @@ public class WebappClassLoader } catch (SecurityException e) { log.warn(sm.getString( "webappClassLoader.stopThreadFail", - thread.getName()), e); + thread.getName(), contextName), e); } catch (NoSuchFieldException e) { log.warn(sm.getString( "webappClassLoader.stopThreadFail", - thread.getName()), e); + thread.getName(), contextName), e); } catch (IllegalArgumentException e) { log.warn(sm.getString( "webappClassLoader.stopThreadFail", - thread.getName()), e); + thread.getName(), contextName), e); } catch (IllegalAccessException e) { log.warn(sm.getString( "webappClassLoader.stopThreadFail", - thread.getName()), e); + thread.getName(), contextName), e); } // This method is deprecated and for good reason. This is @@ -2078,24 +2095,24 @@ public class WebappClassLoader } log.error(sm.getString("webappClassLoader.warnTimerThread", - thread.getName())); + contextName, thread.getName())); } catch (NoSuchFieldException e) { log.warn(sm.getString( "webappClassLoader.stopTimerThreadFail", - thread.getName()), e); + thread.getName(), contextName), e); } catch (IllegalAccessException e) { log.warn(sm.getString( "webappClassLoader.stopTimerThreadFail", - thread.getName()), e); + thread.getName(), contextName), e); } catch (NoSuchMethodException e) { log.warn(sm.getString( "webappClassLoader.stopTimerThreadFail", - thread.getName()), e); + thread.getName(), contextName), e); } catch (InvocationTargetException e) { log.warn(sm.getString( "webappClassLoader.stopTimerThreadFail", - thread.getName()), e); + thread.getName(), contextName), e); } } @@ -2131,19 +2148,26 @@ public class WebappClassLoader } } } catch (SecurityException e) { - log.warn(sm.getString("webappClassLoader.clearThreadLocalFail"), e); + log.warn(sm.getString("webappClassLoader.clearThreadLocalFail", + contextName), e); } catch (NoSuchFieldException e) { - log.warn(sm.getString("webappClassLoader.clearThreadLocalFail"), e); + log.warn(sm.getString("webappClassLoader.clearThreadLocalFail", + contextName), e); } catch (ClassNotFoundException e) { - log.warn(sm.getString("webappClassLoader.clearThreadLocalFail"), e); + log.warn(sm.getString("webappClassLoader.clearThreadLocalFail", + contextName), e); } catch (IllegalArgumentException e) { - log.warn(sm.getString("webappClassLoader.clearThreadLocalFail"), e); + log.warn(sm.getString("webappClassLoader.clearThreadLocalFail", + contextName), e); } catch (IllegalAccessException e) { - log.warn(sm.getString("webappClassLoader.clearThreadLocalFail"), e); + log.warn(sm.getString("webappClassLoader.clearThreadLocalFail", + contextName), e); } catch (NoSuchMethodException e) { - log.warn(sm.getString("webappClassLoader.clearThreadLocalFail"), e); + log.warn(sm.getString("webappClassLoader.clearThreadLocalFail", + contextName), e); } catch (InvocationTargetException e) { - log.warn(sm.getString("webappClassLoader.clearThreadLocalFail"), e); + log.warn(sm.getString("webappClassLoader.clearThreadLocalFail", + contextName), e); } } @@ -2183,14 +2207,15 @@ public class WebappClassLoader remove = true; } if (remove) { - Object[] args = new Object[4]; + Object[] args = new Object[5]; + args[0] = contextName; if (key != null) { - args[0] = key.getClass().getCanonicalName(); - args[1] = key.toString(); + args[1] = key.getClass().getCanonicalName(); + args[2] = key.toString(); } if (value != null) { - args[2] = value.getClass().getCanonicalName(); - args[3] = value.toString(); + args[3] = value.getClass().getCanonicalName(); + args[4] = value.toString(); } if (value == null) { if (log.isDebugEnabled()) { @@ -2302,15 +2327,20 @@ public class WebappClassLoader } } } catch (ClassNotFoundException e) { - log.info(sm.getString("webappClassLoader.clearRmiInfo"), e); + log.info(sm.getString("webappClassLoader.clearRmiInfo", + contextName), e); } catch (SecurityException e) { - log.warn(sm.getString("webappClassLoader.clearRmiFail"), e); + log.warn(sm.getString("webappClassLoader.clearRmiFail", + contextName), e); } catch (NoSuchFieldException e) { - log.warn(sm.getString("webappClassLoader.clearRmiFail"), e); + log.warn(sm.getString("webappClassLoader.clearRmiFail", + contextName), e); } catch (IllegalArgumentException e) { - log.warn(sm.getString("webappClassLoader.clearRmiFail"), e); + log.warn(sm.getString("webappClassLoader.clearRmiFail", + contextName), e); } catch (IllegalAccessException e) { - log.warn(sm.getString("webappClassLoader.clearRmiFail"), e); + log.warn(sm.getString("webappClassLoader.clearRmiFail", + contextName), e); } } @@ -2374,25 +2404,30 @@ public class WebappClassLoader if (countRemoved > 0 && log.isDebugEnabled()) { log.debug(sm.getString( "webappClassLoader.clearReferencesResourceBundlesCount", - Integer.valueOf(countRemoved))); + Integer.valueOf(countRemoved), contextName)); } } catch (SecurityException e) { log.error(sm.getString( - "webappClassLoader.clearReferencesResourceBundlesFail"), e); + "webappClassLoader.clearReferencesResourceBundlesFail", + contextName), e); } catch (NoSuchFieldException e) { if (System.getProperty("java.vendor").startsWith("Sun")) { log.error(sm.getString( - "webappClassLoader.clearReferencesResourceBundlesFail"), e); + "webappClassLoader.clearReferencesResourceBundlesFail", + contextName), e); } else { log.debug(sm.getString( - "webappClassLoader.clearReferencesResourceBundlesFail"), e); + "webappClassLoader.clearReferencesResourceBundlesFail", + contextName), e); } } catch (IllegalArgumentException e) { log.error(sm.getString( - "webappClassLoader.clearReferencesResourceBundlesFail"), e); + "webappClassLoader.clearReferencesResourceBundlesFail", + contextName), e); } catch (IllegalAccessException e) { log.error(sm.getString( - "webappClassLoader.clearReferencesResourceBundlesFail"), e); + "webappClassLoader.clearReferencesResourceBundlesFail", + contextName), e); } } Modified: tomcat/tc6.0.x/trunk/webapps/docs/changelog.xml URL: http://svn.apache.org/viewvc/tomcat/tc6.0.x/trunk/webapps/docs/changelog.xml?rev=931666&r1=931665&r2=931666&view=diff ============================================================================== --- tomcat/tc6.0.x/trunk/webapps/docs/changelog.xml (original) +++ tomcat/tc6.0.x/trunk/webapps/docs/changelog.xml Wed Apr 7 20:19:24 2010 @@ -39,6 +39,14 @@ Catalina, Coyote, Jasper, Cluster, Webapps, Other --> <section name="Tomcat 6.0.27 (jfclere)"> + <subsection name="Catalina"> + <changelog> + <add> + Include context name when reporting memory leaks to aid root cause + identification. (markt) + </add> + </changelog> + </subsection> <subsection name="Other"> <changelog> <update>Update to Commons Daemon 1.0.2. Use service launcher (procrun) --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org For additional commands, e-mail: dev-h...@tomcat.apache.org