You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jmeter-dev@jakarta.apache.org by se...@apache.org on 2006/03/28 04:12:18 UTC
svn commit: r389353 - in /jakarta/jmeter/branches/rel-2-1/xdocs: changes.xml
usermanual/get-started.xml usermanual/listeners.xml usermanual/test_plan.xml
Author: sebb
Date: Mon Mar 27 18:12:15 2006
New Revision: 389353
URL: http://svn.apache.org/viewcvs?rev=389353&view=rev
Log:
More documentation updates...
Modified:
jakarta/jmeter/branches/rel-2-1/xdocs/changes.xml
jakarta/jmeter/branches/rel-2-1/xdocs/usermanual/get-started.xml
jakarta/jmeter/branches/rel-2-1/xdocs/usermanual/listeners.xml
jakarta/jmeter/branches/rel-2-1/xdocs/usermanual/test_plan.xml
Modified: jakarta/jmeter/branches/rel-2-1/xdocs/changes.xml
URL: http://svn.apache.org/viewcvs/jakarta/jmeter/branches/rel-2-1/xdocs/changes.xml?rev=389353&r1=389352&r2=389353&view=diff
==============================================================================
--- jakarta/jmeter/branches/rel-2-1/xdocs/changes.xml (original)
+++ jakarta/jmeter/branches/rel-2-1/xdocs/changes.xml Mon Mar 27 18:12:15 2006
@@ -43,8 +43,6 @@
<li>Does not always handle non-default encoding properly</li>
<li>Spaces in the installation path cause problems for client-server mode</li>
<li>Change of Language does not propagate to all test elements</li>
-<li></li>
-<li></li>
</ul>
<h4>New functionality:</h4>
Modified: jakarta/jmeter/branches/rel-2-1/xdocs/usermanual/get-started.xml
URL: http://svn.apache.org/viewcvs/jakarta/jmeter/branches/rel-2-1/xdocs/usermanual/get-started.xml?rev=389353&r1=389352&r2=389353&view=diff
==============================================================================
--- jakarta/jmeter/branches/rel-2-1/xdocs/usermanual/get-started.xml (original)
+++ jakarta/jmeter/branches/rel-2-1/xdocs/usermanual/get-started.xml Mon Mar 27 18:12:15 2006
@@ -101,7 +101,8 @@
</subsection>
<subsection name="2.2.3 Email Support" anchor="opt_email">
-<p>JMeter has limited Email capabilities (it can send email based on test results).
+<p>JMeter has limited Email capabilities. It can send email based on test results, and has a POP/IMAP sampler.
+It does not currently support SMTP sampling.
To enable Email support, add Sun's JavaMail packages and the activation packages to JMeter's <a href="#classpath">classpath</a>.</p>
</subsection>
@@ -112,10 +113,13 @@
by registering the SSL Provider.</p>
<p>There is also the <complink name="SSL Manager"/>, for greater control of certificates.</p>
<p>Note: if you are running JDK1.4, then you do not have to download JSSE because Sun integrated it into JDK1.4 as a standard library.</p>
+<p>The JMeter proxy server (see below) does not support recording SSL (https).</p>
</subsection>
<subsection name="2.2.5 JDBC Driver" anchor="opt_jdbc">
-<p>You will need to add your database vendor's JDBC driver to the <a href="#classpath">classpath</a> if you want to do JDBC testing.</p>
+<p>You will need to add your database vendor's JDBC driver to the <a href="#classpath">classpath</a> if you want to do JDBC testing.
+Make sure the file is a jar file, not a zip.
+</p>
</subsection>
<subsection name="2.2.6 Apache SOAP" anchor="opt_soap">
@@ -136,14 +140,14 @@
<subsection name="2.3.1 Downloading the Latest Release" anchor="download_release">
<p>We recommend that most users run the <a href="http://jakarta.apache.org/site/downloads/index.html">latest release</a>.</p>
<p>To install a release build, simply unzip the zip/tar file into the directory
-where you want JMeter to be installed. Provided that you have a JDK correctly installed
+where you want JMeter to be installed. Provided that you have a JRE/JDK correctly installed
and the JAVA_HOME environment variable set, there is nothing more for you to do.</p>
</subsection>
<subsection name="2.3.2 Downloading Nightly Builds" anchor="download_nightly">
<p>If you do not mind working with beta-quality software, then you can download and run the <a href="http://jakarta.apache.org/builds/jakarta-jmeter/nightly">latest nightly build</a>.</p>
<p>To install a nightly build, unzip the _bin and _lib zip/tar files into the same directory structure.
-Provided that you have a JDK correctly installed
+Provided that you have a JRE/JDK correctly installed
and the JAVA_HOME environment variable set, JMeter should be installed successfully.</p>
</subsection>
</section>
@@ -157,10 +161,11 @@
<subsection name="2.4.1 JMeter's Classpath" anchor="classpath">
<p>JMeter automatically finds classes from jars in its /lib and /lib/ext directories.
-If you want to add other JAR files to JMeter's classpath, then
-you must copy them to JMeter's "lib" directory. If you have developed new JMeter specific components,
+If you have developed new JMeter components,
then you should jar them and copy the jar into JMeter's /lib/ext directory. JMeter will
-automatically find JMeter components in any jars found here.</p>
+automatically find JMeter components in any jars found here.
+Other jars (such as JDBC, and any support libaries needed by the JMeter code)
+ should be placed in the lib 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.
@@ -179,6 +184,9 @@
-a [password for proxy authentication - if required]</p>
<p><b>Example</b>: jmeter -H my.proxy.server -P 8000 -u username -a password</p>
<p>Alternatively, you can use --proxyHost, --proxyPort, --username, and --password</p>
+<note>JMeter also has its own in-built <complink name="Proxy Server">Proxy Server</complink>,
+which can be used for recording HTTP (but not HTTPS) browser sessions.
+This is not to be confused with the proxy settings described above, which are used when JMeter makes HTTP or HTTPS requests itself.</note>
</subsection>
<subsection name="2.4.3 Non-GUI Mode (Command Line mode)" anchor="non_gui">
Modified: jakarta/jmeter/branches/rel-2-1/xdocs/usermanual/listeners.xml
URL: http://svn.apache.org/viewcvs/jakarta/jmeter/branches/rel-2-1/xdocs/usermanual/listeners.xml?rev=389353&r1=389352&r2=389353&view=diff
==============================================================================
--- jakarta/jmeter/branches/rel-2-1/xdocs/usermanual/listeners.xml (original)
+++ jakarta/jmeter/branches/rel-2-1/xdocs/usermanual/listeners.xml Mon Mar 27 18:12:15 2006
@@ -24,13 +24,28 @@
<body>
<section name="14. Introduction to listeners" anchor="intro">
-<p>For those new to JMeter, a listener is a component that shows the results of the
+<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 view
-results tree or in table to a test plan. To view the response time graphically, add
-graph results, spline results or distribution graph. For detailed explanation, of
-each listener, please go to the components page.</p>
+file. To view the contents of a response from any given sampler, add either of the Listeners "View
+Results Tree" or "View Results in table" to a test plan. To view the response time graphically, add
+graph results, spline results or distribution graph.
+The <complink name="listeners">Listeners</complink>
+section of the components page has full descriptions of all the listeners.</p>
+<note>
+Different listeners display the response information in different ways.
+However, they all write the same raw data to the output file - if one is specified.
+</note>
+<p>
+The "Configure" button can be used to specify which fields to write to the file, and whether to
+write it as CSV or XML.
+CSV files are much smaller than XML files, so use CSV if you are generating lots of samples.
+</p>
+<p>
+If you only wish to record certain samples, add the Listener as a child of the sampler.
+Or you can use a Simple Controller to group a set of samplers, and add the Listener to that.
+The same filename can be used by multiple samplers - but make sure they all use the same configuration!
+</p>
</section>
<section name="14.1 Screen captures" anchor="screencap">
@@ -40,6 +55,38 @@
</p>
<figure image="save_image.png">Figure 1 - Edit -> Save As Image</figure>
+</section>
+<section name="14.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.
+The configuration of this listener is controlled by entries in the file jmeter.properties.
+</p>
+<p>
+This feature can be used to specify a different data log file for each test run, for example:
+<code>
+jmeter -n -t testplan.jmx -l testplan_01.jtl
+jmeter -n -t testplan.jmx -l testplan_02.jtl
+</code>
+</p>
+<p>
+However, note that jmeter logging messages are always written to jmeter.log by default.
+This file is recreated each time, so if you want to keep the log files for each run,
+you will need to rename it after the run has finished.
+Or you can use the environment variable JVM_ARGS to pass in the option -Dlog_file=filename.
+This will define the Java system property,
+which will be used as the default JMeter property if not overridden in jmeter.properties
+If you are using an OS such as VMS just use a logical name for the log file in jmeter.properties
+and define the logical before starting JMeter.
+</p>
+</section>
+
+<section name="14.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.
+The result log file can be read back into a Listener after a test has completed.
+</p>
</section>
</body>
Modified: jakarta/jmeter/branches/rel-2-1/xdocs/usermanual/test_plan.xml
URL: http://svn.apache.org/viewcvs/jakarta/jmeter/branches/rel-2-1/xdocs/usermanual/test_plan.xml?rev=389353&r1=389352&r2=389353&view=diff
==============================================================================
--- jakarta/jmeter/branches/rel-2-1/xdocs/usermanual/test_plan.xml (original)
+++ jakarta/jmeter/branches/rel-2-1/xdocs/usermanual/test_plan.xml Mon Mar 27 18:12:15 2006
@@ -87,10 +87,8 @@
<p>Logical Controllers let you customize the logic that JMeter uses to
decide when to send requests. For example, you can add an Interleave
-Logic Controller to alternate between two HTTP Request Samplers. Also,
-one particular Logic Controller, the Modification Manager, lets you modify
-the results of a request. For more information,
-see <a href="#logic_controller">Logical Controllers</a>.</p>
+Logic Controller to alternate between two HTTP Request Samplers.
+For more information, see <a href="#logic_controller">Logical Controllers</a>.</p>
</subsection>
@@ -214,9 +212,11 @@
<subsection name="4.3 Listeners" anchor="listeners">
<p>Listeners provide access to the information JMeter gathers about the test cases while
-JMeter runs. The simplest listener, the <complink name="Graph
-Results"/> listener plots the response times on a graph. Listeners provide a
-graphical view of the data that JMeter generates.</p>
+JMeter runs. The <complink name="Graph
+Results"/> listener plots the response times on a graph.
+The "View Results Tree" Listener shows details of sampler requests and responses, and can display basic HTML and XML representations of the response.
+Other listeners provide summary or aggregation information.
+</p>
<p>Additionally, listeners can direct the data they collect to a file for later use. Every
listener in JMeter provides a field to indicate the file to store data to.</p>
@@ -240,7 +240,7 @@
<p>
If you choose to add more than one timer to a Thread Group, JMeter takes the sum of
-the timers and pauses for that amount of time.</p>
+the timers and pauses for that amount of time before executing the samplers to which they apply.</p>
</subsection>
<subsection name="4.5 Assertions" anchor="assertions">
@@ -255,7 +255,7 @@
the whole response.</p>
<p>You can add an assertion to any Sampler. For example, you can
-add an assertion to a HTTP Request that checks for the text, "</HTML>". JMeter
+add an assertion to a HTTP Request that checks for the text, "&lt;/HTML&gt;". JMeter
will then check that the text is present in the HTTP response. If JMeter cannot find the
text, then it will mark this as a failed request.</p>
---------------------------------------------------------------------
To unsubscribe, e-mail: jmeter-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: jmeter-dev-help@jakarta.apache.org