Author: markt Date: Fri Feb 12 18:03:48 2010 New Revision: 909542 URL: http://svn.apache.org/viewvc?rev=909542&view=rev Log: Document new findleaks command
Modified: tomcat/trunk/webapps/docs/html-manager-howto.xml tomcat/trunk/webapps/docs/manager-howto.xml Modified: tomcat/trunk/webapps/docs/html-manager-howto.xml URL: http://svn.apache.org/viewvc/tomcat/trunk/webapps/docs/html-manager-howto.xml?rev=909542&r1=909541&r2=909542&view=diff ============================================================================== --- tomcat/trunk/webapps/docs/html-manager-howto.xml (original) +++ tomcat/trunk/webapps/docs/html-manager-howto.xml Fri Feb 12 18:03:48 2010 @@ -36,7 +36,7 @@ Tomcat. This document is for the HTML web interface to the web application <a href="manager-howto.html">manager</a>.</p> -<p>The interface is divided into five sections: +<p>The interface is divided into six sections: <ul> <li><strong>Message</strong> - Displays success and failure messages.</li> <li><strong>Manager</strong> - General manager operations like list and @@ -44,6 +44,7 @@ <li><strong>Applications</strong> - List of web applications and commands.</li> <li><strong>Deploy</strong> - Deploying web applications.</li> + <li><strong>Diagnostocs</strong> - Identifying potential problems.</li> <li><strong>Server Information</strong> - Information about the Tomcat server.</li> </ul> @@ -546,6 +547,19 @@ </subsection> </section> +<section name="Diagnostics"> + +<p><strong>The find leaks diagnostic triggers a full garbage collection. It +should be used with extreme caution on production systems.</strong></p> + +<p>The find leaks diagnostic attempts to identify web applications that have +caused memory leaks when they were reloaded. Results should always be confirmed +with a profiler. The diagnostic uses additional functionality provided by the +StandardHost implementation. It will not work if a custom host is used that +does not extend StandardHost.</p> + +</section> + <section name="Server Information"> <p>This section displays information about Tomcat, the operating system of Modified: tomcat/trunk/webapps/docs/manager-howto.xml URL: http://svn.apache.org/viewvc/tomcat/trunk/webapps/docs/manager-howto.xml?rev=909542&r1=909541&r2=909542&view=diff ============================================================================== --- tomcat/trunk/webapps/docs/manager-howto.xml (original) +++ tomcat/trunk/webapps/docs/manager-howto.xml Fri Feb 12 18:03:48 2010 @@ -51,6 +51,8 @@ <a href="#Stop an Existing Application">Stop an Existing Application</a><br /> <a href="#Undeploy an Existing Application"> Undeploy an Existing Application</a><br /> +<a href="#Server Status">Server Status</a><br /> +<a href="#Finding memory leaks">Finding memory leaks</a><br /> </blockquote> <a href="#Executing Manager Commands With Ant"> Executing Manager Commands With Ant</a><br /> @@ -891,6 +893,35 @@ </subsection> +<subsection name="Finding memory leaks"> + +<source> +http://localhost:8080/manager/text/findleaks +</source> + +<p><strong>The find leaks diagnostic triggers a full garbage collection. It +should be used with extreme caution on production systems.</strong></p> + +<p>The find leaks diagnostic attempts to identify web applications that have +caused memory leaks when they were reloaded. Results should always be confirmed +with a profiler. The diagnostic uses additional functionality provided by the +StandardHost implementation. It will not work if a custom host is used that +does not extend StandardHost.</p> + +<p>If this command succeeds, you will see a response like this:</p> +<source> +/leaking-webapp +</source> + +<p>Each context path for a web application that is believed to have triggered a +memory leak when it was reloaded will be listed on a new line. If an application +has been reloaded several times, it may be listed several times.</p> + +<p>If the command does not succeed, the response will start with +<code>FAIL</code> and include an error message.</p> + +</subsection> + <subsection name="Server Status"> <p>From this link , you can view information about the server.</p> --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org For additional commands, e-mail: dev-h...@tomcat.apache.org