rubbos/app/tomcat-connectors-1.2.32-src/xdocs/miscellaneous/reporttools.xml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE document [
   3   <!ENTITY project SYSTEM "project.xml">
   4 ]>
   5 <document url="reporttools.html">
   6
   7   &project;
   8 <copyright>
   9    Licensed to the Apache Software Foundation (ASF) under one or more
  10    contributor license agreements.  See the NOTICE file distributed with
  11    this work for additional information regarding copyright ownership.
  12    The ASF licenses this file to You under the Apache License, Version 2.0
  13    (the "License"); you may not use this file except in compliance with
  14    the License.  You may obtain a copy of the License at
  15
  16        http://www.apache.org/licenses/LICENSE-2.0
  17
  18    Unless required by applicable law or agreed to in writing, software
  19    distributed under the License is distributed on an "AS IS" BASIS,
  20    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  21    See the License for the specific language governing permissions and
  22    limitations under the License.
  23 </copyright>
  24 <properties>
  25 <title>Reporting Tools</title>
  26 <author>Glenn Nielsen</author>
  27 <date>$Date: 2009-10-18 16:13:42 +0200 (Sun, 18 Oct 2009) $</date>
  28 </properties>
  29 <body>
  30 <section name="Reporting Tools">
  31 <p>
  32 The mod_jk source distribution contains two perl scripts in the
  33 tools/reports directory which can be used to analyze the mod_jk
  34 logs, save statistical data, and generate report graphs.
  35 </p>
  36
  37 <p><code>tomcat_trend.pl log_dir archive_dir</code></p>
  38 <p>
  39 Script for analyzing mod_jk.log data when logging tomcat request data using
  40 the <code>JkRequestLogFormat</code> Apache mod_jk configuration.
  41 Generates statistics for request latency and errors.  Archives the generated
  42 data to files for later use in long term trend graphs and reports.
  43 </p>
  44
  45 <p><code>tomcat_reports.pl archive_dir reports_dir</code></p>
  46 <p>
  47 Script for generating reports and graphs using statistical data generated
  48 by the <code>tomcat_trend.pl</code> script.
  49
  50 The following graphs are created:
  51 <ul>
  52   <li>tomcat_request.png - Long term trend graph of total number of tomcat
  53     requests handled.</li>
  54   <li>tomcat_median.png - Long term overall trend graph of tomcat request
  55     latency median.</li>
  56   <li>tomcat_deviation.png - Long term overall trend graph of tomcat request
  57     mean and standard deviation.</li>
  58   <li>tomcat_error.png - Long term trend graph of requests rejected by tomcat.
  59     Shows requests rejected when tomcat has no request processors available.
  60     Can be an indicator that tomcat is overloaded or having other scaling
  61     problems.</li>
  62   <li>tomcat_client.png - Long term trend graph of requests forward to tomcat
  63     which were aborted by the remote client (browser).  You will normally see
  64     some aborted requests.  High numbers of these can be an indicator that
  65     tomcat is overloaded or there are requests which have very high latency.</li>
  66 </ul>
  67 </p>
  68
  69 <p>
  70 A great deal of statistical data is generated but at this time
  71 only long term trend graphs are being created and no reports.
  72 This is only a start.  Many more graphs and reports could be
  73 generated from the data. Please consider contributing back any
  74 new reports or graphs you create.  Thanks.
  75 </p>
  76
  77 <p>
  78 These perl scripts depend upon the following perl modules and libraries:
  79 <ul>
  80   <li>GD 1.8.x graphics library <a href="http://www.boutell.com/gd/">
  81     http://www.boutell.com/gd/</a></li>
  82   <li>GD 1.4.x perl module</li>
  83   <li>GD Graph perl module</li>
  84   <li>GD TextUtil perl module</li>
  85   <li>StatisticsDescriptive perl module</li>
  86 </ul>
  87 </p>
  88 </section>
  89
  90 </body>
  91 </document>