Author: sebb
Date: Sun Feb  4 14:59:18 2007
New Revision: 503506

URL: http://svn.apache.org/viewvc?view=rev&rev=503506
Log:
Various documentation clarifications

Modified:
    jakarta/jmeter/branches/rel-2-2/xdocs/usermanual/component_reference.xml
    jakarta/jmeter/branches/rel-2-2/xdocs/usermanual/get-started.xml
    jakarta/jmeter/branches/rel-2-2/xdocs/usermanual/listeners.xml

Modified: 
jakarta/jmeter/branches/rel-2-2/xdocs/usermanual/component_reference.xml
URL: 
http://svn.apache.org/viewvc/jakarta/jmeter/branches/rel-2-2/xdocs/usermanual/component_reference.xml?view=diff&rev=503506&r1=503505&r2=503506
==============================================================================
--- jakarta/jmeter/branches/rel-2-2/xdocs/usermanual/component_reference.xml 
(original)
+++ jakarta/jmeter/branches/rel-2-2/xdocs/usermanual/component_reference.xml 
Sun Feb  4 14:59:18 2007
@@ -129,19 +129,23 @@
 <note>The HTTP methods HEAD, TRACE, OPTIONS, PUT, DELETE are new in 2.1.2, and 
may have some teething problems.</note>
 <properties>
         <property name="Name" required="No">Descriptive name for this 
controller that is shown in the tree.</property>
-        <property name="Server" required="Yes">Domain name or IP address of 
the web server.</property>
+        <property name="Server" required="No">Domain name or IP address of the 
web server.</property>
         <property name="Port" required="No">Port the web server is listening 
to. Default: 80</property>
         <property name="Protocol" required="No">HTTP or HTTPS. Default: 
HTTP</property>
         <property name="Method" required="Yes">GET, POST, HEAD, TRACE, 
OPTIONS, PUT, DELETE</property>
-               <property name="Redirect Automatically" required="No">
+               <property name="Redirect Automatically" required="Yes">
                Sets the underlying http protocol handler to automatically 
follow redirects,
                so they are not seen by JMeter, and thus will not appear as 
samples.
         </property>
-               <property name="Follow Redirects" required="No">
+               <property name="Follow Redirects" required="Yes">
+               This only has any effect if "Redirect Automatically" is not 
enabled.
                If set, the JMeter sampler will check if the response is a 
redirect and follow it if so.
                The redirect response will appear as an additional sample.
+               Note that the HttpClient sampler may log the following 
message:<br/>
+               "Redirect requested but followRedirects is disabled"<br/>
+               This can be ignored.
                </property>
-               <property name="Use KeepAlive" required="No">JMeter sets the 
Connection: keep-alive header. This does not work properly with the default 
HTTP implementation, as connection re-use is not under user-control. 
+               <property name="Use KeepAlive" required="Yes">JMeter sets the 
Connection: keep-alive header. This does not work properly with the default 
HTTP implementation, as connection re-use is not under user-control. 
                   It does work with the Jakarta httpClient 
implementation.</property>
         <property name="Path" required="Yes">The path to resource (for 
example, /servlets/myServlet). If the
 resource requires query string parameters, add them below in the
@@ -167,7 +171,7 @@
 and send HTTP/HTTPS requests for all images, Java applets, JavaScript files, 
CSSs, etc. referenced in the file.
         See below for more details.
         </property>
-        <property name="Use as monitor" required="No">For use with the 
<complink name="Monitor Results"/> listener.</property>
+        <property name="Use as monitor" required="Yes">For use with the 
<complink name="Monitor Results"/> listener.</property>
 </properties>
 <p>Upto and including JMeter 2.1.1, only responses with the content-type 
"text/html" were scanned for
 embedded resources. Other content-types were assumed to be something other 
than HTML.
@@ -1382,6 +1386,12 @@
                        It then adds a "sample" entry to the test output with 
the total elapsed time.
                        The name of the element is used to name the "sample".
                </p>
+               <p>
+               The generated sample time includes all the times for the nested 
samplers, and any timers etc.
+               Depending on the clock resolution, it may be slightly longer 
than the sum of the individual samplers plus timers.
+               The clock might tick after the controller recorded the start 
time but before the first sample starts.
+               Similarly at the end.
+               </p>
        </description>
 <properties>
        <property name="Name" required="Yes">Descriptive name for this 
controller that is shown in the tree, and used to name the 
transaction.</property>
@@ -1648,7 +1658,8 @@
 <li># Samples - The number of samples for the URL</li>
 <li>Average - The average time of a set of results</li>
 <li>Median - The median is the time in the middle of a set of results.</li>
-<li>90% Line - 90% of the results finished faster than the line.</li>
+<li>90% Line - the maximum time taken for the fastest 90% of the samples. #
+The remaining samples took longer than this.</li>
 <li>Min - The lowest time for the samples of the given URL</li>
 <li>Max - The longest time for the samples of the given URL</li>
 <li>Error % - Percent of requests with errors</li>
@@ -1691,6 +1702,10 @@
 1000 data points at 5 second intervals, the monitor would check the server
 status 12 times a minute or 720 times a hour. This means the buffer shows
 the performance history of each machine for the last hour.</p>
+<note>
+The monitor requires Tomcat 5 or above. 
+Use a browser to check that you can access the Tomcat status servlet OK.
+</note>
 </description>
 </component>
 

Modified: jakarta/jmeter/branches/rel-2-2/xdocs/usermanual/get-started.xml
URL: 
http://svn.apache.org/viewvc/jakarta/jmeter/branches/rel-2-2/xdocs/usermanual/get-started.xml?view=diff&rev=503506&r1=503505&r2=503506
==============================================================================
--- jakarta/jmeter/branches/rel-2-2/xdocs/usermanual/get-started.xml (original)
+++ jakarta/jmeter/branches/rel-2-2/xdocs/usermanual/get-started.xml Sun Feb  4 
14:59:18 2007
@@ -107,6 +107,10 @@
 If your version of Java does not include SSL support, then it is possible to 
add an external implementation.
 Include the necessary encryption packages in JMeter's <a 
href="#classpath">classpath</a>.  Also, update <a 
href="#configuring_jmeter">jmeter.properties</a>
 to register the SSL Provider.</p>
+<p><b>JMeter is configured to accept all certificates,
+whether trusted or not, regardless of validity periods etc.</b>
+This is to allow the maximum flexibility in testing servers.</p>
+<p>If the server requires a client certificate, this can be provided.</p>
 <p>There is also the <complink name="SSL Manager"/>, for greater control of 
certificates.</p>
 <note>The JMeter proxy server (see below) does not support recording SSL 
(https).</note>
 </subsection>
@@ -148,18 +152,18 @@
 </p>
 
 <subsection name="2.4.1 JMeter's Classpath" anchor="classpath">
-<p>JMeter automatically finds classes from jars in its /lib and /lib/ext 
directories.  
+<p>JMeter automatically finds classes from jars in its JMETER_HOME/lib and 
JMETER_HOME/lib/ext directories.  
 If you have developed new JMeter components,
-then you should jar them and copy the jar into JMeter's /lib/ext directory.  
JMeter will
+then you should jar them and copy the jar into JMeter's JMETER_HOME/lib/ext 
directory.  JMeter will
 automatically find JMeter components in any jars found here.
-Support jars should be placed in the lib directory.
-If you don't want to put the extension jars in the lib/ext directory,
+Support jars should be placed in the JMETER_HOME/lib directory.
+If you don't want to put the extension jars in the JMETER_HOME/lib/ext 
directory,
 then define the property <b>search_paths</b> in jmeter.properties.
 Do not use lib/ext for utility jars; it is only intended for JMeter components.
 </p>
 <p>
-Other jars (such as JDBC, and any support libaries needed by the JMeter code)
- should be placed in the lib directory.</p>
+Other jars (such as JDBC, JavaMail, Beanshell and any other support libaries 
needed by the JMeter code)
+ should be placed in the JMETER_HOME/lib directory - not the lib/ext 
directory</p>
 <p>Note: JMeter will only find .jar files, not .zip.</p>
 <p>You can also install utility Jar files in $JAVA_HOME/jre/lib/ext, or (since 
2.1.1) you can set the property user.classpath in jmeter.properties</p>
 <p>Note that setting the CLASSPATH environment variable will have no effect.
@@ -245,8 +249,7 @@
 10/17/2003 12:19:20 PM INFO  - jmeter.JMeter: Version 1.9.20031002 
 10/17/2003 12:19:45 PM INFO  - jmeter.gui.action.Load: Loading file: 
c:\mytestfiles\BSH.jmx 
 10/17/2003 12:19:52 PM INFO  - jmeter.engine.StandardJMeterEngine: Running the 
test! 
-10/17/2003 12:19:52 PM INFO  - jmeter.engine.StandardJMeterEngine: 
-Starting 1 threads for group BSH. Ramp up = 1. 
+10/17/2003 12:19:52 PM INFO  - jmeter.engine.StandardJMeterEngine: Starting 1 
threads for group BSH. Ramp up = 1. 
 10/17/2003 12:19:52 PM INFO  - jmeter.engine.StandardJMeterEngine: Continue on 
error 
 10/17/2003 12:19:52 PM INFO  - jmeter.threads.JMeterThread: Thread BSH1-1 
started 
 10/17/2003 12:19:52 PM INFO  - jmeter.threads.JMeterThread: Thread BSH1-1 is 
done 
@@ -315,12 +318,11 @@
   </note>
   <properties>
        <property name="ssl.provider">You can specify the class for your SSL
-       implementation.  If you are using the JSSE from sun, then it is:<br/>
-       com.sun.net.ssl.internal.ssl.Provider.  JMeter, by default, should 
provide https support is you are
-       using JDK1.4.</property>
+       implementation if you don't want to use the built-in Java 
implementation.
+       </property>
        <property name="xml.parser">You can specify an implementation as your 
XML
        parser.  The default value is: 
org.apache.xerces.parsers.SAXParser</property>
-  <property name="remote_hosts">Comma-delimited list of remote JMeter hosts.
+  <property name="remote_hosts">Comma-delimited list of remote JMeter hosts 
(or host:port if required).
        If you are running JMeter in a distributed environment, list the 
machines where
   you have JMeter remote servers running.  This will allow you to control those
        servers from this machine's GUI</property>

Modified: jakarta/jmeter/branches/rel-2-2/xdocs/usermanual/listeners.xml
URL: 
http://svn.apache.org/viewvc/jakarta/jmeter/branches/rel-2-2/xdocs/usermanual/listeners.xml?view=diff&rev=503506&r1=503505&r2=503506
==============================================================================
--- jakarta/jmeter/branches/rel-2-2/xdocs/usermanual/listeners.xml (original)
+++ jakarta/jmeter/branches/rel-2-2/xdocs/usermanual/listeners.xml Sun Feb  4 
14:59:18 2007
@@ -15,6 +15,12 @@
    See the License for the specific language governing permissions and
    limitations under the License.
 -->
+
+<!DOCTYPE document
+[
+<!ENTITY sect-num '14'>
+]>
+
 <document prev="build-monitor-test-plan.html" next="remote-test.html" 
date="$Date$">
 
 <properties>
@@ -23,7 +29,7 @@
 
 <body>
 
-<section name="14. Introduction to listeners" anchor="intro">
+<section name="&sect-num;. Introduction to listeners" anchor="intro">
 <p>A listener is a component that shows the results of the
 samples. The results can be shown in a tree, tables, graphs or simply written 
to a log
 file. To view the contents of a response from any given sampler, add either of 
the Listeners "View
@@ -51,7 +57,7 @@
 </p>
 </section>
 
-<section name="14.1 Screen captures" anchor="screencap">
+<section name="&sect-num;.1 Screen captures" anchor="screencap">
 <p>JMeter is capable of saving any listener as a PNG file. To do so, select the
 listener in the left panel. Click edit -> Save As Image. A file dialog will
 appear. Enter the desired name and save the listener.
@@ -59,7 +65,7 @@
 <figure image="save_image.png">Figure 1 - Edit -> Save As Image</figure>
 
 </section>
-<section name="14.2 non-GUI (batch) test runs" anchor="batch">
+<section name="&sect-num;.2 non-GUI (batch) test runs" anchor="batch">
 <p>
 When running in non-GUI mode, the -l flag can be used to create a top-level 
listener for the test run.
 This is in addition to any Listeners defined in the test plan.
@@ -84,7 +90,7 @@
 </p>
 </section>
 
-<section name="14.3 Resource usage" anchor="resources">
+<section name="&sect-num;.3 Resource usage" anchor="resources">
 <p>
 Listeners can be quite resource intensive so use as few as possible. 
 For minimum resource usage, remove all listeners, and run the test in non-GUI 
mode with the -l flag to define a single listener.
@@ -92,7 +98,7 @@
 </p>
 </section>
 
-<section name="14.4 CSV Log format" anchor="csvlogformat">
+<section name="&sect-num;.4 CSV Log format" anchor="csvlogformat">
 <p>
 The CSV log format depends on which data items are selected in the 
configuration.
 Only the specified data items are recorded in the file.
@@ -118,15 +124,17 @@
 </p>
 </section>
 
-<section name="14.5 XML Log format 2.0" anchor="xmlformat2.0">
+<section name="&sect-num;.5 XML Log format 2.0" anchor="xmlformat2.0">
 <p>
 The format of the original XML (2.0) is as follows (line breaks will be 
different):
 </p>
 <pre>
 &amp;lt;?xml version="1.0" encoding="UTF-8"?>
 &amp;lt;testResults version="1.2">
-&amp;lt;sampleResult timeStamp="1144365463297" dataType="text" 
threadName="Listen 1-1" label="HTTP Request" time="1502" responseMessage="OK" 
responseCode="200" success="true">
- &amp;lt;sampleResult timeStamp="1144365464238" dataType="text" 
threadName="Listen 1-1" label="http://www.apache.org/style/style.css"; 
time="171" responseMessage="OK" responseCode="200" success="true">
+&amp;lt;sampleResult timeStamp="1144365463297" dataType="text" 
threadName="Listen 1-1" 
+   label="HTTP Request" time="1502" responseMessage="OK" responseCode="200" 
success="true">
+ &amp;lt;sampleResult timeStamp="1144365464238" dataType="text" 
threadName="Listen 1-1" 
+    label="http://www.apache.org/style/style.css"; time="171" 
responseMessage="OK" responseCode="200" success="true">
  &amp;lt;property xml:space="preserve" name="samplerData">
  GET http://www.apache.org/style/style.css
  &amp;lt;/property>
@@ -146,7 +154,7 @@
 </pre>
 </section>
 
-<section name="14.6 XML Log format 2.1" anchor="xmlformat2.1">
+<section name="&sect-num;.6 XML Log format 2.1" anchor="xmlformat2.1">
 <p>
 The format of the updated XML (2.1) is as follows (line breaks will be 
different):
 </p>
@@ -156,8 +164,10 @@
 
 -- HTTP Sample, with nested samples 
 
-&amp;lt;httpSample t="1392" lt="351" ts="1144371014619" s="true" lb="HTTP 
Request" rc="200" rm="OK" tn="Listen 1-1" dt="text" de="iso-8859-1" by="12407">
-  &amp;lt;httpSample t="170" lt="170" ts="1144371015471" s="true" 
lb="http://www.apache.org/style/style.css"; rc="200" rm="OK" tn="Listen 1-1" 
dt="text" de="ISO-8859-1" by="1002">
+&amp;lt;httpSample t="1392" lt="351" ts="1144371014619" s="true" lb="HTTP 
Request" rc="200" rm="OK" 
+     tn="Listen 1-1" dt="text" de="iso-8859-1" by="12407">
+  &amp;lt;httpSample t="170" lt="170" ts="1144371015471" s="true" 
+        lb="http://www.apache.org/style/style.css"; rc="200" rm="OK" tn="Listen 
1-1" dt="text" de="ISO-8859-1" by="1002">
     &amp;lt;responseHeader class="java.lang.String">HTTP/1.1 200 OK
 Date: Fri, 07 Apr 2006 00:50:14 GMT
 ...
@@ -177,7 +187,8 @@
     &amp;lt;queryString class="java.lang.String">&amp;lt;/queryString>
     &amp;lt;url>http://www.apache.org/style/style.css&amp;lt;/url>
   &amp;lt;/httpSample>
-  &amp;lt;httpSample t="200" lt="180" ts="1144371015641" s="true" 
lb="http://www.apache.org/images/asf_logo_wide.gif"; rc="200" rm="OK" tn="Listen 
1-1" dt="bin" de="ISO-8859-1" by="5866">
+  &amp;lt;httpSample t="200" lt="180" ts="1144371015641" s="true" 
lb="http://www.apache.org/images/asf_logo_wide.gif"; 
+     rc="200" rm="OK" tn="Listen 1-1" dt="bin" de="ISO-8859-1" by="5866">
     &amp;lt;responseHeader class="java.lang.String">HTTP/1.1 200 OK
 Date: Fri, 07 Apr 2006 00:50:14 GMT
 ...
@@ -217,7 +228,8 @@
 
 -- nonHTTPP Sample
 
-&amp;lt;sample t="0" lt="0" ts="1144372616082" s="true" lb="Example Sampler" 
rc="200" rm="OK" tn="Listen 1-1" dt="text" de="ISO-8859-1" by="10">
+&amp;lt;sample t="0" lt="0" ts="1144372616082" s="true" lb="Example Sampler" 
rc="200" rm="OK" 
+    tn="Listen 1-1" dt="text" de="ISO-8859-1" by="10">
   &amp;lt;responseHeader class="java.lang.String">&amp;lt;/responseHeader>
   &amp;lt;requestHeader class="java.lang.String">&amp;lt;/requestHeader>
   &amp;lt;responseData class="java.lang.String">Listen 
1-1&amp;lt;/responseData>
@@ -259,7 +271,7 @@
 </p>
 </section>
 
-<section name="14.7 Saving response data" anchor="saving">
+<section name="&sect-num;.7 Saving response data" anchor="saving">
 <p>
 As shown above, the response data can be saved in the XML log file if required.
 However, this can make the file rather large, and the text has to be encoded so
@@ -271,6 +283,10 @@
 The data will be retrieved from the file if necessary when the sample log file 
is reloaded.
 </p>
 </section>
-
+<section name="&sect-num;.8 Loading (reading) response data" anchor="loading">
+<p>To view an existing results file, you can use the File "Browse..." button 
to select a file.
+If necessary, just create a dummy testplan with the appropriate Listener in it.
+</p>
+</section>
 </body>
 </document>



---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to