3
<!ENTITY project SYSTEM "project.xml">
5
<document url="tools.html">
9
Copyright 1999-2005 The Apache Software Foundation
11
Licensed under the Apache License, Version 2.0 (the "License");
12
you may not use this file except in compliance with the License.
13
You may obtain a copy of the License at
15
http://www.apache.org/licenses/LICENSE-2.0
17
Unless required by applicable law or agreed to in writing, software
18
distributed under the License is distributed on an "AS IS" BASIS,
19
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
20
See the License for the specific language governing permissions and
21
limitations under the License.
25
<author>Glenn Nielsen</author>
26
<date>$Date: 2005-07-04 16:14:53 +0200 (Mon, 04 Jul 2005) $</date>
29
<section name="Introduction">
30
<p>Documentation for additional mod_jk related tools.</p>
33
<section name="Reports">
35
The mod_jk source distribution contains two perl scripts in the
36
jk/tools/reports directory which can be used to analyze the mod_jk
37
logs, save statistical data, and generate report graphs.
40
<p><code>tomcat_trend.pl log_dir archive_dir</code></p>
42
Script for analyzing mod_jk.log data when logging tomcat request data using
43
the <code>JkRequestLogFormat</code> Apache mod_jk configuration.
44
Generates statistics for request latency and errors. Archives the generated
45
data to files for later use in long term trend graphs and reports.
48
<p><code>tomcat_reports.pl archive_dir reports_dir</code></p>
50
Script for generating reports and graphs using statistical data generated
51
by the <code>tomcat_trend.pl</code> script.
53
The following graphs are created:
55
<li>tomcat_request.png - Long term trend graph of total number of tomcat
56
requests handled.</li>
57
<li>tomcat_median.png - Long term overall trend graph of tomcat request
59
<li>tomcat_deviation.png - Long term overall trend graph of tomcat request
60
mean and standard deviation.</li>
61
<li>tomcat_error.png - Long term trend graph of requests rejected by tomcat.
62
Shows requests rejected when tomcat has no request processors available.
63
Can be an indicator that tomcat is overloaded or having other scaling
65
<li>tomcat_client.png - Long term trend graph of requests forward to tomcat
66
which were aborted by the remote client (browser). You will normally see
67
some aborted requests. High numbers of these can be an indicator that
68
tomcat is overloaded or there are requests which have very high latency.</li>
73
A great deal of statistical data is generated but at this time
74
only long term trend graphs are being created and no reports.
75
This is only a start. Many more graphs and reports could be
76
generated from the data. Please consider contributing back any
77
new reports or graphs you create. Thanks.
81
These perl scripts depend upon the following perl modules and libraries:
83
<li>GD 1.8.x graphics library <a href="http://www.boutell.com/gd/">
84
http://www.boutell.com/gd/</a></li>
85
<li>GD 1.4.x perl module</li>
86
<li>GD Graph perl module</li>
87
<li>GD TextUtil perl module</li>
88
<li>StatisticsDescriptive perl module</li>
added
removed
xdocs/common/tools.xml
