Modified: jakarta/jmeter/trunk/docs/usermanual/regular_expressions.html URL: http://svn.apache.org/viewvc/jakarta/jmeter/trunk/docs/usermanual/regular_expressions.html?rev=773282&r1=773281&r2=773282&view=diff ============================================================================== --- jakarta/jmeter/trunk/docs/usermanual/regular_expressions.html (original) +++ jakarta/jmeter/trunk/docs/usermanual/regular_expressions.html Sat May 9 22:57:45 2009 @@ -18,28 +18,28 @@ <!-- Content Stylesheet for Site --> - + <!-- start the processing --> - <!-- ====================================================================== --> - <!-- Main Page Section --> - <!-- ====================================================================== --> - <html> - <head> - <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/> - - - - <title>JMeter - User's Manual: Regular Expressions</title> - </head> - - <body bgcolor="#ffffff" text="#000000" link="#525D76"> - <table border="0" cellspacing="0"> - <!-- TOP IMAGE --> - <tr> - <td> +<!-- ====================================================================== --> +<!-- Main Page Section --> +<!-- ====================================================================== --> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/> + + + +<title>JMeter - User's Manual: Regular Expressions</title> +</head> + +<body bgcolor="#ffffff" text="#000000" link="#525D76"> +<table border="0" cellspacing="0"> +<!-- TOP IMAGE --> +<tr> +<td> <!-- Need to specify height otherwise iframe seems to grab extra --> <iframe src="http://www.apache.org/ads/halfbanner.html"; height="102" - style="border-width:0; float: left" frameborder="0" scrolling="no"></iframe> +style="border-width:0; float: left" frameborder="0" scrolling="no"></iframe> </td> <td align="left"> <a href="http://jakarta.apache.org";><img width="505" height="48" src="../images/jakarta-logo.gif" alt="Jakarta" title="Jakarta" border="0"/></a> @@ -47,552 +47,582 @@ <td align="right"> <a href="http://jakarta.apache.org/jmeter/";><img width="221" height="102" src="../images/logo.jpg" alt="JMeter" title="JMeter" border="0"/></a> </td> - </tr> - </table> - <table border="0" width="100%" cellspacing="4"> - <tr><td colspan="2"> - <hr noshade size="1"/> - </td></tr> - - <tr> - <!-- LEFT SIDE NAVIGATION --> - <td width="20%" valign="top" nowrap="true"> - <p><strong>About</strong></p> - <ul> - <li> <a href="../index.html">Overview</a> -</li> - <li> <a href="../changes.html">Changes</a> -</li> - <li> <a href="../known_bugs.html">Known Bugs</a> -</li> - <li> <a href="../license.html">License</a> -</li> - <li> <a href="http://wiki.apache.org/jakarta-jmeter/JMeterCommitters";>Contributors</a> -</li> - </ul> - <p><strong>Download</strong></p> - <ul> - <li> <a href="http://jakarta.apache.org/site/downloads/downloads_jmeter.cgi";>Download Releases</a> -</li> - <li> <a href="../nightly.html">Developer (Nightly) Builds</a> -</li> - </ul> - <p><strong>Documentation</strong></p> - <ul> - <li> <a href="../usermanual/index.html">User Manual</a> -</li> - <li> <a href="../api/index.html">Javadocs</a> -</li> - <li> <a href="../localising/index.html">Localisation (Translator's Guide)</a> -</li> - <li> <a href="../building.html">Building JMeter and Add-Ons</a> -</li> - <li> <a href="http://wiki.apache.org/jakarta-jmeter";>JMeter Wiki</a> -</li> - <li> <a href="http://wiki.apache.org/jakarta-jmeter/JMeterFAQ";>FAQ (Wiki)</a> -</li> - </ul> - <p><strong>Tutorials (PDF format)</strong></p> - <ul> - <li> <a href="../usermanual/jmeter_distributed_testing_step_by_step.pdf">Distributed Testing</a> -</li> - <li> <a href="../usermanual/jmeter_proxy_step_by_step.pdf">Recording Tests</a> -</li> - <li> <a href="../usermanual/junitsampler_tutorial.pdf">JUnit Sampler</a> -</li> - <li> <a href="../usermanual/jmeter_accesslog_sampler_step_by_step.pdf">Access Log Sampler</a> -</li> - <li> <a href="../extending/jmeter_tutorial.pdf">Extending JMeter</a> -</li> - </ul> - <p><strong>Community</strong></p> - <ul> - <li> <a href="http://jakarta.apache.org/site/getinvolved.html";>Get Involved</a> -</li> - <li> <a href="http://jakarta.apache.org/site/mail.html";>Mailing Lists</a> -</li> - <li> <a href="http://jakarta.apache.org/site/cvsindex.html";>SVN Repositories</a> -</li> - </ul> - </td> - <td width="80%" align="left" valign="top"> - <table> - <tr> - <td bgcolor="#525D76"> - <div align="right"><a href="index.html"><font size=-1 color="#ffffff" face="arial,helvetica,sanserif">Index</font></a></div> - </td> - <td bgcolor="#525D76"> - <div align="right"><a href="glossary.html"><font size=-1 color="#ffffff" face="arial,helvetica,sanserif">Next</font></a></div> - </td> - <td bgcolor="#525D76"> - <div align="right"><a href="functions.html"><font size=-1 color="#ffffff" face="arial,helvetica,sanserif">Prev</font></a></div> - </td> - </tr> - </table> - <br> - <table border="0" cellspacing="0" cellpadding="2" width="100%"> - <tr><td bgcolor="#525D76"> - <font color="#ffffff" face="arial,helvetica,sanserif"> - <a name="regex"><strong>20. Regular Expressions</strong></a> - </font> - </td></tr> - <tr><td> - <blockquote> - <table border="0" cellspacing="0" cellpadding="2" width="100%"> - <tr><td bgcolor="#828DA6"> - <font color="#ffffff" face="arial,helvetica,sanserif"> - <a name="overview"><strong>20.1 Overview</strong></a> - </font> - </td></tr> - <tr><td> - <blockquote> - <p > - +</tr> +</table> +<table border="0" width="100%" cellspacing="4"> +<tr><td colspan="2"> +<hr noshade size="1"/> +</td></tr> +<tr> +<!-- LEFT SIDE NAVIGATION --> +<td width="20%" valign="top" nowrap="true"> +<p><strong>About</strong></p> +<ul> +<li><a href="../index.html">Overview</a> +</li> +<li><a href="../changes.html">Changes</a> +</li> +<li><a href="../known_bugs.html">Known Bugs</a> +</li> +<li><a href="../license.html">License</a> +</li> +<li><a href="http://wiki.apache.org/jakarta-jmeter/JMeterCommitters";>Contributors</a> +</li> +</ul> +<p><strong>Download</strong></p> +<ul> +<li><a href="http://jakarta.apache.org/site/downloads/downloads_jmeter.cgi";>Download Releases</a> +</li> +<li><a href="../nightly.html">Developer (Nightly) Builds</a> +</li> +</ul> +<p><strong>Documentation</strong></p> +<ul> +<li><a href="../usermanual/index.html">User Manual</a> +</li> +<li><a href="../api/index.html">Javadocs</a> +</li> +<li><a href="../localising/index.html">Localisation (Translator's Guide)</a> +</li> +<li><a href="../building.html">Building JMeter and Add-Ons</a> +</li> +<li><a href="http://wiki.apache.org/jakarta-jmeter";>JMeter Wiki</a> +</li> +<li><a href="http://wiki.apache.org/jakarta-jmeter/JMeterFAQ";>FAQ (Wiki)</a> +</li> +</ul> +<p><strong>Tutorials (PDF format)</strong></p> +<ul> +<li><a href="../usermanual/jmeter_distributed_testing_step_by_step.pdf">Distributed Testing</a> +</li> +<li><a href="../usermanual/jmeter_proxy_step_by_step.pdf">Recording Tests</a> +</li> +<li><a href="../usermanual/junitsampler_tutorial.pdf">JUnit Sampler</a> +</li> +<li><a href="../usermanual/jmeter_accesslog_sampler_step_by_step.pdf">Access Log Sampler</a> +</li> +<li><a href="../extending/jmeter_tutorial.pdf">Extending JMeter</a> +</li> +</ul> +<p><strong>Community</strong></p> +<ul> +<li><a href="http://jakarta.apache.org/site/getinvolved.html";>Get Involved</a> +</li> +<li><a href="http://jakarta.apache.org/site/mail.html";>Mailing Lists</a> +</li> +<li><a href="http://jakarta.apache.org/site/cvsindex.html";>SVN Repositories</a> +</li> +</ul> +</td> +<td width="80%" align="left" valign="top"> +<table> +<tr> +<td bgcolor="#525D76"> +<div align="right"><a href="index.html"><font size=-1 color="#ffffff" face="arial,helvetica,sanserif">Index</font></a></div> +</td> +<td bgcolor="#525D76"> +<div align="right"><a href="glossary.html"><font size=-1 color="#ffffff" face="arial,helvetica,sanserif">Next</font></a></div> +</td> +<td bgcolor="#525D76"> +<div align="right"><a href="functions.html"><font size=-1 color="#ffffff" face="arial,helvetica,sanserif">Prev</font></a></div> +</td> +</tr> +</table> +<br> +<table border="0" cellspacing="0" cellpadding="2" width="100%"> +<tr><td bgcolor="#525D76"> +<font color="#ffffff" face="arial,helvetica,sanserif"> +<a name="regex"><strong>20. Regular Expressions</strong></a> +</font> +</td></tr> +<tr><td> +<blockquote> +<table border="0" cellspacing="0" cellpadding="2" width="100%"> +<tr><td bgcolor="#828DA6"> +<font color="#ffffff" face="arial,helvetica,sanserif"> +<a name="overview"><strong>20.1 Overview</strong></a> +</font> +</td></tr> +<tr><td> +<blockquote> +<p> + JMeter includes the pattern matching software - <a href="http://jakarta.apache.org/oro/";> - Apache Jakarta ORO - </a> - - - <br > - </br> - +<a href="http://jakarta.apache.org/oro/";> +Apache Jakarta ORO +</a> + + +<br> +</br> + There is some documentation for this on the Jakarta web-site, for example - <a href="http://jakarta.apache.org/oro/api/org/apache/oro/text/regex/package-summary.html";> - +<a href="http://jakarta.apache.org/oro/api/org/apache/oro/text/regex/package-summary.html";> + a summary of the pattern matching characters - </a> - +</a> + + +</p> +<p> - </p> - <p > - There is also documentation on an older incarnation of the product at - <a href="http://www.savarese.org/oro/docs/OROMatcher/index.html";> - OROMatcher User's guide - </a> - , which might prove useful. - - </p> - <p > - +<a href="http://www.savarese.org/oro/docs/OROMatcher/index.html";> +OROMatcher User's guide +</a> +, which might prove useful. + +</p> +<p> + The pattern matching is very similar to the pattern matching in Perl. A full installation of Perl will include plenty of documentation on regular expressions - look for perlrequick, perlretut, perlre, perlreref. - </p> - <p > - +</p> +<p> + It is worth stressing the difference between "contains" and "matches", as used on the Response Assertion test element: - </p> - <ul > - +</p> +<ul> + + +<li> - <li > - "contains" means that the regular expression matched at least some part of the target, so 'alphabet' "contains" 'ph.b.' because the regular expression matches the substring 'phabe'. - </li> - +</li> + + +<li> - <li > - "matches" means that the regular expression matched the whole target. So 'alphabet' is "matched" by 'al.*t'. - </li> - +</li> + - </ul> - <p > - In this case, it is equivalent to wrapping the regular expression in ^ and $, viz '^al.*t$'. - - </p> - <p > - However, this is not always the case. +</ul> +<p> +In this case, it is equivalent to wrapping the regular expression in ^ and $, viz '^al.*t$'. + +</p> +<p> +However, this is not always the case. For example, the regular expression 'alp|.lp.*' is "contained" in 'alphabet', but does not match 'alphabet'. - </p> - <p > - Why? Because when the pattern matcher finds the sequence 'alp' in 'alphabet', it stops trying any other combinations - and 'alp' is not the same as 'alphabet', as it does not include 'habet'. - - </p> - <p > - +</p> +<p> +Why? Because when the pattern matcher finds the sequence 'alp' in 'alphabet', it stops trying any other combinations - and 'alp' is not the same as 'alphabet', as it does not include 'habet'. + +</p> +<p> + Note: unlike Perl, there is no need to (i.e. do not) enclose the regular expression in //. - </p> - <p > - +</p> +<p> + So how does one use the modifiers ismx etc if there is no trailing /? The solution is to use - <i > - extended regular expressions - </i> - , i.e. /abc/i becomes (?i)abc. +<i> +extended regular expressions +</i> +, i.e. /abc/i becomes (?i)abc. See also - <a href="placement"> - Placement of modifiers - </a> - below. - - </p> - </blockquote> - </td></tr> - <tr><td><br></td></tr> - </table> - <table border="0" cellspacing="0" cellpadding="2" width="100%"> - <tr><td bgcolor="#828DA6"> - <font color="#ffffff" face="arial,helvetica,sanserif"> - <a name="examples"><strong>20.2 Examples</strong></a> - </font> - </td></tr> - <tr><td> - <blockquote> - <p > - +<a href="placement"> +Placement of modifiers +</a> + below. + +</p> +</blockquote> +</td></tr> +<tr><td><br></td></tr> +</table> +<table border="0" cellspacing="0" cellpadding="2" width="100%"> +<tr><td bgcolor="#828DA6"> +<font color="#ffffff" face="arial,helvetica,sanserif"> +<a name="examples"><strong>20.2 Examples</strong></a> +</font> +</td></tr> +<tr><td> +<blockquote> +<p> + Extract single string - <br > - </br> - +<br> +</br> + Suppose you want to match the following portion of a web-page: - <br > - </br> - +<br> +</br> + name="file" value="readme.txt" and you want to extract readme.txt. - <br > - </br> - +<br> +</br> + A suitable reqular expression would be: - <br > - </br> - +<br> +</br> + name="file" value="(.+?)" - <p > - +<p> + The special characters above are: - </p> - +</p> + - <ul > - +<ul> - <li > - ( and ) - these enclose the portion of the match string to be returned - </li> - - <li > - . - match any character. + - one or more times. +<li> +( and ) - these enclose the portion of the match string to be returned +</li> + + +<li> +. - match any character. + - one or more times. ? - don't be greedy, i.e. stop when first match succeeds - </li> - +</li> + + +</ul> - </ul> - - <p > - +<p> + Note: without the ?, the .+ would continue past the first " until it found the last possible " - probably not what was intended. - </p> - +</p> + + +<p> +Extract multiple strings +</p> - <p > - Extract multiple strings - </p> - Suppose you want to match the following portion of a web-page: name="file.name" value="readme.txt" and you want to extract file.name and readme.txt. - <br > - </br> - +<br> +</br> + A suitable reqular expression would be: - <br > - </br> - +<br> +</br> + name="(.+?)" value="(.+?)" - <br > - </br> - +<br> +</br> + This would create 2 groups, which could be used in the JMeter Regular Expression Extractor template as $1$ and $2$. - <p > - +<p> + The JMeter Regex Extractor saves the values of the groups in additional variables. - </p> - +</p> + + +<p> - <p > - For example, assume: - </p> - +</p> + + +<ul> + + +<li> +Reference Name: MYREF +</li> + + +<li> +Regex: name="(.+?)" value="(.+?)" +</li> + + +<li> +Template: $1$$2$ +</li> + + +</ul> - <ul > - - <li > - Reference Name: MYREF - </li> - - - <li > - Regex: name="(.+?)" value="(.+?)" - </li> - - - <li > - Template: $1$$2$ - </li> - - - </ul> - - - <p><table border="1" bgcolor="#bbbb00" width="50%" cellspacing="0" cellpadding="2"> - <tr><td> Do not enclose the regular expression in / / - </td></tr> - </table></p> - +<p> +<table border="1" bgcolor="#bbbb00" width="50%" cellspacing="0" cellpadding="2"> +<tr><td>Do not enclose the regular expression in / / +</td></tr> +</table> +</p> + + +<p> - <p > - The following variables would be set: - </p> - +</p> - <ul > - - <li > - MYREF: file.namereadme.txt - </li> - - - <li > - MYREF_g0: name="file.name" value="readme.txt" - </li> - - - <li > - MYREF_g1: file.name - </li> - - - <li > - MYREF_g2: readme.txt - </li> - +<ul> + + +<li> +MYREF: file.namereadme.txt +</li> + + +<li> +MYREF_g0: name="file.name" value="readme.txt" +</li> + + +<li> +MYREF_g1: file.name +</li> + + +<li> +MYREF_g2: readme.txt +</li> + + +</ul> - </ul> - These variables can be referred to later on in the JMeter test plan, as ${MYREF}, ${MYREF_g1} etc - </p> - </blockquote> - </td></tr> - <tr><td><br></td></tr> - </table> - <table border="0" cellspacing="0" cellpadding="2" width="100%"> - <tr><td bgcolor="#828DA6"> - <font color="#ffffff" face="arial,helvetica,sanserif"> - <a name="line_mode"><strong>20.3 Line mode</strong></a> - </font> - </td></tr> - <tr><td> - <blockquote> - <p > - The pattern matching behaves in various slightly different ways, +</p> +</blockquote> +</td></tr> +<tr><td><br></td></tr> +</table> +<table border="0" cellspacing="0" cellpadding="2" width="100%"> +<tr><td bgcolor="#828DA6"> +<font color="#ffffff" face="arial,helvetica,sanserif"> +<a name="line_mode"><strong>20.3 Line mode</strong></a> +</font> +</td></tr> +<tr><td> +<blockquote> +<p> +The pattern matching behaves in various slightly different ways, depending on the setting of the multi-line and single-line modifiers. Note that the single-line and multi-line operators have nothing to do with each other; they can be specified independently. - </p> - <h3 > - Single-line mode - </h3> - <p > - +</p> +<h3> +Single-line mode +</h3> +<p> + Single-line mode only affects how the '.' meta-character is interpreted. - </p> - <p > - +</p> +<p> + Default behaviour is that '.' matches any character except newline. In single-line mode, '.' also matches newline. - </p> - <h3 > - Multi-line mode - </h3> - <p > - +</p> +<h3> +Multi-line mode +</h3> +<p> + Multi-line mode only affects how the meta-characters '^' and '$' are interpreted. - </p> - <p > - +</p> +<p> + Default behaviour is that '^' and '$' only match at the very beginning and end of the string. When Multi-line mode is used, the '^' metacharacter matches at the beginning of every line, and the '$' metacharacter matches at the end of every line. - </p> - </blockquote> - </td></tr> - <tr><td><br></td></tr> - </table> - <table border="0" cellspacing="0" cellpadding="2" width="100%"> - <tr><td bgcolor="#828DA6"> - <font color="#ffffff" face="arial,helvetica,sanserif"> - <a name="meta_chars"><strong>20.4 Meta characters</strong></a> - </font> - </td></tr> - <tr><td> - <blockquote> - <p > - +</p> +</blockquote> +</td></tr> +<tr><td><br></td></tr> +</table> +<table border="0" cellspacing="0" cellpadding="2" width="100%"> +<tr><td bgcolor="#828DA6"> +<font color="#ffffff" face="arial,helvetica,sanserif"> +<a name="meta_chars"><strong>20.4 Meta characters</strong></a> +</font> +</td></tr> +<tr><td> +<blockquote> +<p> + Regular expressions use certain characters as meta characters - these characters have a special meaning to the RE engine. Such characters must be escaped by preceeding them with \ (backslash) in order to treat them as ordinary characters. Here is a list of the meta characters and their meaning (please check the ORO documentation if in doubt). - </p> - <ul > - - - <li > - ( ) - grouping - </li> - - - <li > - [ ] - character classes - </li> - - - <li > - { } - repetition - </li> - - - <li > - * + ? - repetition - </li> - - - <li > - . - wild-card character - </li> - - - <li > - \ - escape character - </li> - - - <li > - | - alternatives - </li> - - - <li > - ^ $ - start and end of string or line - </li> - - - </ul> - <p > - Please note that ORO does not support the \Q and \E meta-characters. +</p> +<ul> + + +<li> +( ) - grouping +</li> + + +<li> +[ ] - character classes +</li> + + +<li> +{ } - repetition +</li> + + +<li> +* + ? - repetition +</li> + + +<li> +. - wild-card character +</li> + + +<li> +\ - escape character +</li> + + +<li> +| - alternatives +</li> + + +<li> +^ $ - start and end of string or line +</li> + + +</ul> +<p> +Please note that ORO does not support the \Q and \E meta-characters. [In other RE engines, these can be used to quote a portion of an RE so that the meta-characters stand for themselves.] - </p> - </blockquote> - </td></tr> - <tr><td><br></td></tr> - </table> - <table border="0" cellspacing="0" cellpadding="2" width="100%"> - <tr><td bgcolor="#828DA6"> - <font color="#ffffff" face="arial,helvetica,sanserif"> - <a name="placement"><strong>20.5 Placement of modifiers</strong></a> - </font> - </td></tr> - <tr><td> - <blockquote> - <p > - +</p> +</blockquote> +</td></tr> +<tr><td><br></td></tr> +</table> +<table border="0" cellspacing="0" cellpadding="2" width="100%"> +<tr><td bgcolor="#828DA6"> +<font color="#ffffff" face="arial,helvetica,sanserif"> +<a name="placement"><strong>20.5 Placement of modifiers</strong></a> +</font> +</td></tr> +<tr><td> +<blockquote> +<p> + Modifiers can be placed anywhere in the regex, and apply from that point onwards. [A bug in ORO means that they cannot be used at the very end of the regex. However they would have no effect there anyway.] - </p> - <p > - +</p> +<p> + The single-line (?s) and multi-line (?m) modifiers are normally placed at the start of the regex. - </p> - <p > - +</p> +<p> + The ignore-case modifier (?i) may be usefully applied to just part of a regex, for example: - <pre > - +<pre> + Match ExAct case or (?i)ArBiTrARY(?-i) case - </pre> - +</pre> + - </p> - </blockquote> - </td></tr> - <tr><td><br></td></tr> - </table> - </blockquote> - </p> - </td></tr> - <tr><td><br></td></tr> - </table> - <table> - <tr> - <td bgcolor="#525D76"> - <div align="right"><a href="index.html"><font size=-1 color="#ffffff" face="arial,helvetica,sanserif">Index</font></a></div> - </td> - <td bgcolor="#525D76"> - <div align="right"><a href="glossary.html"><font size=-1 color="#ffffff" face="arial,helvetica,sanserif">Next</font></a></div> - </td> - <td bgcolor="#525D76"> - <div align="right"><a href="functions.html"><font size=-1 color="#ffffff" face="arial,helvetica,sanserif">Prev</font></a></div> - </td> - </tr> - </table> - <br> - </td> - </tr> - - <tr><td colspan="2"> - <hr noshade size="1"/> - </td></tr> - <tr><td colspan="2"> - <div align="center"><font color="#525D76" size="-1"><em> - Copyright © 1999-2008, Apache Software Foundation - </em></font></div> - </td></tr> - </table> - </body> - </html> +</p> +</blockquote> +</td></tr> +<tr><td><br></td></tr> +</table> +</blockquote> +</p> +</td></tr> +<tr><td><br></td></tr> +</table> +<table border="0" cellspacing="0" cellpadding="2" width="100%"> +<tr><td bgcolor="#525D76"> +<font color="#ffffff" face="arial,helvetica,sanserif"> +<a name="testing_expressions"><strong>20.6 Testing Regular Expressions</strong></a> +</font> +</td></tr> +<tr><td> +<blockquote> +<p> + +There is a +<a href="http://jakarta.apache.org/oro/demo.html";> +demo +</a> + applet for Apache JMeter ORO. + +</p> +<p> + +Another approach is to use a simple test plan to test the regular expressions. +The Java Request sampler can be used to generate a sample, or the HTTP Sampler can be used to load a file. +Add a Debug Sampler and a Tree View Listener and changes to the regular expression can be tested quickly, +without needing to access any external servers. + +</p> +</blockquote> +</p> +</td></tr> +<tr><td><br></td></tr> +</table> +<table> +<tr> +<td bgcolor="#525D76"> +<div align="right"><a href="index.html"><font size=-1 color="#ffffff" face="arial,helvetica,sanserif">Index</font></a></div> +</td> +<td bgcolor="#525D76"> +<div align="right"><a href="glossary.html"><font size=-1 color="#ffffff" face="arial,helvetica,sanserif">Next</font></a></div> +</td> +<td bgcolor="#525D76"> +<div align="right"><a href="functions.html"><font size=-1 color="#ffffff" face="arial,helvetica,sanserif">Prev</font></a></div> +</td> +</tr> +</table> +<br> +</td> +</tr> +<tr><td colspan="2"> +<hr noshade size="1"/> +</td></tr> +<tr><td colspan="2"> +<div align="center"><font color="#525D76" size="-1"><em> +Copyright © 1999-2009, Apache Software Foundation +</em></font></div> +</td></tr> +</table> +</body> +</html> <!-- end the processing -->
Modified: jakarta/jmeter/trunk/docs/usermanual/remote-test.html URL: http://svn.apache.org/viewvc/jakarta/jmeter/trunk/docs/usermanual/remote-test.html?rev=773282&r1=773281&r2=773282&view=diff ============================================================================== --- jakarta/jmeter/trunk/docs/usermanual/remote-test.html (original) +++ jakarta/jmeter/trunk/docs/usermanual/remote-test.html Sat May 9 22:57:45 2009 @@ -18,28 +18,28 @@ <!-- Content Stylesheet for Site --> - + <!-- start the processing --> - <!-- ====================================================================== --> - <!-- Main Page Section --> - <!-- ====================================================================== --> - <html> - <head> - <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/> - - - - <title>JMeter - User's Manual: Remote (Distributed) Testing</title> - </head> - - <body bgcolor="#ffffff" text="#000000" link="#525D76"> - <table border="0" cellspacing="0"> - <!-- TOP IMAGE --> - <tr> - <td> +<!-- ====================================================================== --> +<!-- Main Page Section --> +<!-- ====================================================================== --> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/> + + + +<title>JMeter - User's Manual: Remote (Distributed) Testing</title> +</head> + +<body bgcolor="#ffffff" text="#000000" link="#525D76"> +<table border="0" cellspacing="0"> +<!-- TOP IMAGE --> +<tr> +<td> <!-- Need to specify height otherwise iframe seems to grab extra --> <iframe src="http://www.apache.org/ads/halfbanner.html"; height="102" - style="border-width:0; float: left" frameborder="0" scrolling="no"></iframe> +style="border-width:0; float: left" frameborder="0" scrolling="no"></iframe> </td> <td align="left"> <a href="http://jakarta.apache.org";><img width="505" height="48" src="../images/jakarta-logo.gif" alt="Jakarta" title="Jakarta" border="0"/></a> @@ -47,99 +47,98 @@ <td align="right"> <a href="http://jakarta.apache.org/jmeter/";><img width="221" height="102" src="../images/logo.jpg" alt="JMeter" title="JMeter" border="0"/></a> </td> - </tr> - </table> - <table border="0" width="100%" cellspacing="4"> - <tr><td colspan="2"> - <hr noshade size="1"/> - </td></tr> - - <tr> - <!-- LEFT SIDE NAVIGATION --> - <td width="20%" valign="top" nowrap="true"> - <p><strong>About</strong></p> - <ul> - <li> <a href="../index.html">Overview</a> -</li> - <li> <a href="../changes.html">Changes</a> -</li> - <li> <a href="../known_bugs.html">Known Bugs</a> -</li> - <li> <a href="../license.html">License</a> -</li> - <li> <a href="http://wiki.apache.org/jakarta-jmeter/JMeterCommitters";>Contributors</a> -</li> - </ul> - <p><strong>Download</strong></p> - <ul> - <li> <a href="http://jakarta.apache.org/site/downloads/downloads_jmeter.cgi";>Download Releases</a> -</li> - <li> <a href="../nightly.html">Developer (Nightly) Builds</a> -</li> - </ul> - <p><strong>Documentation</strong></p> - <ul> - <li> <a href="../usermanual/index.html">User Manual</a> -</li> - <li> <a href="../api/index.html">Javadocs</a> -</li> - <li> <a href="../localising/index.html">Localisation (Translator's Guide)</a> -</li> - <li> <a href="../building.html">Building JMeter and Add-Ons</a> -</li> - <li> <a href="http://wiki.apache.org/jakarta-jmeter";>JMeter Wiki</a> -</li> - <li> <a href="http://wiki.apache.org/jakarta-jmeter/JMeterFAQ";>FAQ (Wiki)</a> -</li> - </ul> - <p><strong>Tutorials (PDF format)</strong></p> - <ul> - <li> <a href="../usermanual/jmeter_distributed_testing_step_by_step.pdf">Distributed Testing</a> -</li> - <li> <a href="../usermanual/jmeter_proxy_step_by_step.pdf">Recording Tests</a> -</li> - <li> <a href="../usermanual/junitsampler_tutorial.pdf">JUnit Sampler</a> -</li> - <li> <a href="../usermanual/jmeter_accesslog_sampler_step_by_step.pdf">Access Log Sampler</a> -</li> - <li> <a href="../extending/jmeter_tutorial.pdf">Extending JMeter</a> -</li> - </ul> - <p><strong>Community</strong></p> - <ul> - <li> <a href="http://jakarta.apache.org/site/getinvolved.html";>Get Involved</a> -</li> - <li> <a href="http://jakarta.apache.org/site/mail.html";>Mailing Lists</a> -</li> - <li> <a href="http://jakarta.apache.org/site/cvsindex.html";>SVN Repositories</a> -</li> - </ul> - </td> - <td width="80%" align="left" valign="top"> - <table> - <tr> - <td bgcolor="#525D76"> - <div align="right"><a href="index.html"><font size=-1 color="#ffffff" face="arial,helvetica,sanserif">Index</font></a></div> - </td> - <td bgcolor="#525D76"> - <div align="right"><a href="best-practices.html"><font size=-1 color="#ffffff" face="arial,helvetica,sanserif">Next</font></a></div> - </td> - <td bgcolor="#525D76"> - <div align="right"><a href="listeners.html"><font size=-1 color="#ffffff" face="arial,helvetica,sanserif">Prev</font></a></div> - </td> - </tr> - </table> - <br> - <table border="0" cellspacing="0" cellpadding="2" width="100%"> - <tr><td bgcolor="#525D76"> - <font color="#ffffff" face="arial,helvetica,sanserif"> - <a name="$section.getAttributeValue("anchor")"><strong>15. Remote Testing</strong></a> - </font> - </td></tr> - <tr><td> - <blockquote> - <p > - In the event that your JMeter client machine is unable, performance-wise, to simulate +</tr> +</table> +<table border="0" width="100%" cellspacing="4"> +<tr><td colspan="2"> +<hr noshade size="1"/> +</td></tr> +<tr> +<!-- LEFT SIDE NAVIGATION --> +<td width="20%" valign="top" nowrap="true"> +<p><strong>About</strong></p> +<ul> +<li><a href="../index.html">Overview</a> +</li> +<li><a href="../changes.html">Changes</a> +</li> +<li><a href="../known_bugs.html">Known Bugs</a> +</li> +<li><a href="../license.html">License</a> +</li> +<li><a href="http://wiki.apache.org/jakarta-jmeter/JMeterCommitters";>Contributors</a> +</li> +</ul> +<p><strong>Download</strong></p> +<ul> +<li><a href="http://jakarta.apache.org/site/downloads/downloads_jmeter.cgi";>Download Releases</a> +</li> +<li><a href="../nightly.html">Developer (Nightly) Builds</a> +</li> +</ul> +<p><strong>Documentation</strong></p> +<ul> +<li><a href="../usermanual/index.html">User Manual</a> +</li> +<li><a href="../api/index.html">Javadocs</a> +</li> +<li><a href="../localising/index.html">Localisation (Translator's Guide)</a> +</li> +<li><a href="../building.html">Building JMeter and Add-Ons</a> +</li> +<li><a href="http://wiki.apache.org/jakarta-jmeter";>JMeter Wiki</a> +</li> +<li><a href="http://wiki.apache.org/jakarta-jmeter/JMeterFAQ";>FAQ (Wiki)</a> +</li> +</ul> +<p><strong>Tutorials (PDF format)</strong></p> +<ul> +<li><a href="../usermanual/jmeter_distributed_testing_step_by_step.pdf">Distributed Testing</a> +</li> +<li><a href="../usermanual/jmeter_proxy_step_by_step.pdf">Recording Tests</a> +</li> +<li><a href="../usermanual/junitsampler_tutorial.pdf">JUnit Sampler</a> +</li> +<li><a href="../usermanual/jmeter_accesslog_sampler_step_by_step.pdf">Access Log Sampler</a> +</li> +<li><a href="../extending/jmeter_tutorial.pdf">Extending JMeter</a> +</li> +</ul> +<p><strong>Community</strong></p> +<ul> +<li><a href="http://jakarta.apache.org/site/getinvolved.html";>Get Involved</a> +</li> +<li><a href="http://jakarta.apache.org/site/mail.html";>Mailing Lists</a> +</li> +<li><a href="http://jakarta.apache.org/site/cvsindex.html";>SVN Repositories</a> +</li> +</ul> +</td> +<td width="80%" align="left" valign="top"> +<table> +<tr> +<td bgcolor="#525D76"> +<div align="right"><a href="index.html"><font size=-1 color="#ffffff" face="arial,helvetica,sanserif">Index</font></a></div> +</td> +<td bgcolor="#525D76"> +<div align="right"><a href="best-practices.html"><font size=-1 color="#ffffff" face="arial,helvetica,sanserif">Next</font></a></div> +</td> +<td bgcolor="#525D76"> +<div align="right"><a href="listeners.html"><font size=-1 color="#ffffff" face="arial,helvetica,sanserif">Prev</font></a></div> +</td> +</tr> +</table> +<br> +<table border="0" cellspacing="0" cellpadding="2" width="100%"> +<tr><td bgcolor="#525D76"> +<font color="#ffffff" face="arial,helvetica,sanserif"> +<a name="$section.getAttributeValue("anchor")"><strong>15. Remote Testing</strong></a> +</font> +</td></tr> +<tr><td> +<blockquote> +<p> +In the event that your JMeter client machine is unable, performance-wise, to simulate enough users to stress your server, an option exists to control multiple, remote JMeter engines from a single JMeter GUI client. By running JMeter remotely, you can replicate a test across many low-end computers and thus simulate a larger load on the server. One @@ -148,30 +147,31 @@ - <ul > - +<ul> + + +<li> +Saving of test samples to a local machine +</li> + + +<li> +Managment of multiple JMeterEngines from a single machine +</li> + + +</ul> + + +</p> +<p> - <li > - Saving of test samples to a local machine - </li> - - - <li > - Managment of multiple JMeterEngines from a single machine - </li> - - - </ul> - - - </p> - <p > - However, remote mode does use more resources than running the same number of non-GUI tests independently. +If many server instances are used, the client JMeter can become overloaded, as can the client network connection. - </p> - <p > - Note that while you can indeed execute the JMeterEngine on your application +</p> +<p> +Note that while you can execute the JMeterEngine on your application server, you need to be mindful of the fact that this will be adding processing overhead on the application server and thus your testing results will be somewhat tainted. The recommended approach is to have one or more machines on @@ -180,85 +180,96 @@ results without impacting the performance of the application serer itself. - </p> - <p > - <b > - Step 1: Start the servers - </b> - </p> - <p > - To run JMeter in remote node, start the JMeter server component on all machines you wish to run on by running the - <b > - JMETER_HOME/bin/jmeter-server - </b> - (unix) or - <b > - JMETER_HOME/bin/jmeter-server.bat - </b> - (windows) script. - </p> - <p > - Note that there can only be one JMeter server on each node unless different RMI ports are used. - </p> - <p > - Since JMeter 2.3.1, the JMeter server application starts the RMI registry itself; +</p> +<p> +<b> +Step 1: Start the servers +</b> +</p> +<p> +To run JMeter in remote node, start the JMeter server component on all machines you wish to run on by running the +<b> +JMETER_HOME/bin/jmeter-server +</b> + (unix) or +<b> +JMETER_HOME/bin/jmeter-server.bat +</b> + (windows) script. +</p> +<p> +Note that there can only be one JMeter server on each node unless different RMI ports are used. +</p> +<p> +Since JMeter 2.3.1, the JMeter server application starts the RMI registry itself; there is no need to start RMI registry separately. To revert to the previous behaviour, define the JMeter property server.rmi.create=false on the server host systems. - </p> - <p > - <b > - Step 2: Add the server IP to your client's Properties File - </b> - </p> - <p > - Edit the properties file - <i > - on the controlling JMeter machine - </i> - . In /bin/jmeter.properties, find the property named, "remote_hosts", and +</p> +<p> + +By default, RMI uses a dynamic port for the JMeter server engine. This can cause problems for firewalls, +so versions of JMeter after 2.3.2 will check for the JMeter property +<b> +server.rmi.localport +</b> +. +If this is non-zero, it will be used as the local port number for the server engine. + +</p> +<p> +<b> +Step 2: Add the server IP to your client's Properties File +</b> +</p> +<p> +Edit the properties file +<i> +on the controlling JMeter machine +</i> +. In /bin/jmeter.properties, find the property named, "remote_hosts", and add the value of your running JMeter server's IP address. Multiple such servers can be added, comma-delimited. - </p> - <p > - Note that you can use the -R - <a href="get-started.html#override"> - command line option - </a> - +</p> +<p> +Note that you can use the -R +<a href="get-started.html#override"> +command line option +</a> + instead to specify the remote host(s) to use. This has the same effect as using -r and -Jremote_hosts={serverlist}. E.g. jmeter -Rhost1,127.0.0.1,host2 - </p> - <p > - If you define the JMeter property server.exitaftertest=true, then the server will exit after it runs a single test. +</p> +<p> +If you define the JMeter property server.exitaftertest=true, then the server will exit after it runs a single test. See also the -X flag (described below) - </p> - <p > - <b > - Step 3a: Start the JMeter Client from a GUI client - </b> - </p> - <p > - Now you are ready to start the controlling JMeter client. For MS-Windows, start the client with the script "bin/jmeter.bat". For UNIX, +</p> +<p> +<b> +Step 3a: Start the JMeter Client from a GUI client +</b> +</p> +<p> +Now you are ready to start the controlling JMeter client. For MS-Windows, start the client with the script "bin/jmeter.bat". For UNIX, use the script "bin/jmeter". You will notice that the Run menu contains two new sub-menus: "Remote Start" and "Remote Stop" (see figure 1). These menus contain the client that you set in the properties file. Use the remote start and stop instead of the normal JMeter start and stop menu items. - </p> - <p><table border="0" cellspacing="0" cellpadding="0"><tr><td><img src="../images/screenshots/remote/run-menu00.gif"><br> - <font size="-1"> Figure 1 - Run Menu - </font></td></tr></table></p> - <p > - <b > - Step 3b: Start the JMeter from a non-GUI Client - </b> - </p> - <p > - +</p> +<p><table border="0" cellspacing="0" cellpadding="0"><tr><td><img src="../images/screenshots/remote/run-menu00.gif"><br> +<font size="-1">Figure 1 - Run Menu +</font></td></tr></table></p> +<p> +<b> +Step 3b: Start the JMeter from a non-GUI Client +</b> +</p> +<p> + As an alternative, you can start the remote server(s) from a non-GUI (command-line) client. The command to do this is: - <pre > - +<pre> + jmeter -n -t script.jmx -r or jmeter -n -t script.jmx -R server1,server2... @@ -267,185 +278,195 @@ -Gproperty=value - define a property in all the servers (may appear more than once) -Z - Exit remote servers at the end of the test. - </pre> - +</pre> + The first example will start whatever servers are defined in the JMeter property remote_hosts; the second example will define remote_hosts from the list of servers and then run the remote servers. - <br > - </br> - +<br> +</br> + The command-line client will exit when all the remote servers have stopped. - </p> - <table border="0" cellspacing="0" cellpadding="2" width="100%"> - <tr><td bgcolor="#828DA6"> - <font color="#ffffff" face="arial,helvetica,sanserif"> - <a name="detail_instructions"><strong>15.1 Doing it Manually</strong></a> - </font> - </td></tr> - <tr><td> - <blockquote> - <p > - In some cases, the jmeter-server script may not work for you (if you are using an OS platform not anticipated by the JMeter developers). Here is how to start the JMeter servers (step 1 above) with a more manual process: - </p> - <p > - <b > - Step 1a: Start the RMI Registry - </b> - </p> - <p > - +</p> +<table border="0" cellspacing="0" cellpadding="2" width="100%"> +<tr><td bgcolor="#828DA6"> +<font color="#ffffff" face="arial,helvetica,sanserif"> +<a name="detail_instructions"><strong>15.1 Doing it Manually</strong></a> +</font> +</td></tr> +<tr><td> +<blockquote> +<p> +In some cases, the jmeter-server script may not work for you (if you are using an OS platform not anticipated by the JMeter developers). Here is how to start the JMeter servers (step 1 above) with a more manual process: +</p> +<p> +<b> +Step 1a: Start the RMI Registry +</b> +</p> +<p> + Since JMeter 2.3.1, the RMI registry is started by the JMeter server, so this section does not apply in the normal case. To revert to the previous behaviour, define the JMeter property server.rmi.create=false on the server host systems and follow the instructions below. - </p> - <p > - JMeter uses Remote Method Invocation (RMI) as the remote communication mechanism. Therefore, you need +</p> +<p> +JMeter uses Remote Method Invocation (RMI) as the remote communication mechanism. Therefore, you need to run the RMI Registry application (which is named, "rmiregistry") that comes with the JDK and is located in the "bin" directory. Before running rmiregistry, make sure that the following jars are in your system claspath: - <ul > - +<ul> + - <li > - JMETER_HOME/lib/ext/ApacheJMeter_core.jar - </li> - +<li> +JMETER_HOME/lib/ext/ApacheJMeter_core.jar +</li> + - <li > - JMETER_HOME/lib/jorphan.jar - </li> - +<li> +JMETER_HOME/lib/jorphan.jar +</li> + - <li > - JMETER_HOME/lib/logkit-1.2.jar - </li> - +<li> +JMETER_HOME/lib/logkit-1.2.jar +</li> + + +</ul> - </ul> - The rmiregistry application needs access to certain JMeter classes. Run rmiregistry with no parameters. By default the application listens to port 1099. - </p> - <p > - <b > - Step 1b: Start the JMeter Server - </b> - </p> - <p > - Once the RMI Registry application is running, start the JMeter Server. +</p> +<p> +<b> +Step 1b: Start the JMeter Server +</b> +</p> +<p> +Once the RMI Registry application is running, start the JMeter Server. Use the "-s" option with the jmeter startup script ("jmeter -s"). - </p> - <p > - Steps 2 and 3 remain the same. - </p> - </blockquote> - </td></tr> - <tr><td><br></td></tr> - </table> - <table border="0" cellspacing="0" cellpadding="2" width="100%"> - <tr><td bgcolor="#828DA6"> - <font color="#ffffff" face="arial,helvetica,sanserif"> - <a name="tips"><strong>15.2 Tips</strong></a> - </font> - </td></tr> - <tr><td> - <blockquote> - <p > - If you're running Suse Linux, these tips may help. The default installation may enable the firewall. In that case, remote testing will not work properly. The following tips were contributed by Sergey Ten. - </p> - <p > - If you see connections refused, turn on debugging by passing the following options. - </p> - <p > - Since JMeter 2.3.1, the RMI registry is started by the server; however the options can still be passed in from the JMeter command line. +</p> +<p> +Steps 2 and 3 remain the same. +</p> +</blockquote> +</td></tr> +<tr><td><br></td></tr> +</table> +<table border="0" cellspacing="0" cellpadding="2" width="100%"> +<tr><td bgcolor="#828DA6"> +<font color="#ffffff" face="arial,helvetica,sanserif"> +<a name="tips"><strong>15.2 Tips</strong></a> +</font> +</td></tr> +<tr><td> +<blockquote> +<p> + +JMeter/RMI requires a connection from the client to the server. This will use the port you chose, default 1099. +JMeter/RMI also requires a reverse connection in order to return sample results from the server to the client. +This will use a high-numbered port. +If there are any firewalls or other network filters between JMeter client and server, +you will need to make sure that they are set up to allow the connections through. +If necessary, use monitoring software to show what traffic is being generated. + +</p> +<p> +If you're running Suse Linux, these tips may help. The default installation may enable the firewall. In that case, remote testing will not work properly. The following tips were contributed by Sergey Ten. +</p> +<p> +If you see connections refused, turn on debugging by passing the following options. +</p> +<p> +Since JMeter 2.3.1, the RMI registry is started by the server; however the options can still be passed in from the JMeter command line. For example: "jmeter -s -Dsun.rmi.loader.logLevel=verbose" (i.e. omit the -J prefixes). Alternatively the properties can be defined in the system.properties file. - </p> - <p > - The solution to the problem is to remove the loopbacks 127.0.0.1 and 127.0.0.2 from etc/hosts. What happens is jmeter-server can't connect to rmiregistry if 127.0.0.2 loopback is not available. Use the following settings to fix the problem. - </p> - <p > - Replace - </p> - <ul > - - - <li > - `dirname $0`/jmeter -s "$@" - </li> - - - </ul> - <p > - With - </p> - <ul > - - - <li > - HOST="-Djava.rmi.server.hostname=[computer_name][computer_domain] - </li> - - - <li > - -Djava.security.policy=`dirname $0`/[policy_file]" - </li> - - - <li > - `dirname $0`/jmeter $HOST -s "$@" - </li> - - - </ul> - <p > - Also create a policy file and add [computer_name][computer_domain] line to /etc/hosts. - </p> - </blockquote> - </td></tr> - <tr><td><br></td></tr> - </table> - <table border="0" cellspacing="0" cellpadding="2" width="100%"> - <tr><td bgcolor="#828DA6"> - <font color="#ffffff" face="arial,helvetica,sanserif"> - <a name="portchange"><strong>15.3 Using a different port</strong></a> - </font> - </td></tr> - <tr><td> - <blockquote> - <p > - By default, JMeter uses the standard RMI port 1099. It is possible to change this. For this to work successfully, all the following need to agree: - </p> - <ul > - - - <li > - On the server, start rmiregistry using the new port number - </li> - - - <li > - On the server, start JMeter with the property server_port defined - </li> - - - <li > - On the client, update the remote_hosts property to include the new remote host:port settings - </li> - - - </ul> - <p > - Since Jmeter 2.1.1, the jmeter-server scripts provide support for changing the port. +</p> +<p> +The solution to the problem is to remove the loopbacks 127.0.0.1 and 127.0.0.2 from etc/hosts. What happens is jmeter-server can't connect to rmiregistry if 127.0.0.2 loopback is not available. Use the following settings to fix the problem. +</p> +<p> + Replace +</p> +<ul> + + +<li> + `dirname $0`/jmeter -s "$@" +</li> + + +</ul> +<p> + With +</p> +<ul> + + +<li> + HOST="-Djava.rmi.server.hostname=[computer_name][computer_domain] +</li> + + +<li> + -Djava.security.policy=`dirname $0`/[policy_file]" +</li> + + +<li> + `dirname $0`/jmeter $HOST -s "$@" +</li> + + +</ul> +<p> +Also create a policy file and add [computer_name][computer_domain] line to /etc/hosts. +</p> +</blockquote> +</td></tr> +<tr><td><br></td></tr> +</table> +<table border="0" cellspacing="0" cellpadding="2" width="100%"> +<tr><td bgcolor="#828DA6"> +<font color="#ffffff" face="arial,helvetica,sanserif"> +<a name="portchange"><strong>15.3 Using a different port</strong></a> +</font> +</td></tr> +<tr><td> +<blockquote> +<p> +By default, JMeter uses the standard RMI port 1099. It is possible to change this. For this to work successfully, all the following need to agree: +</p> +<ul> + + +<li> +On the server, start rmiregistry using the new port number +</li> + + +<li> +On the server, start JMeter with the property server_port defined +</li> + + +<li> +On the client, update the remote_hosts property to include the new remote host:port settings +</li> + + +</ul> +<p> +Since Jmeter 2.1.1, the jmeter-server scripts provide support for changing the port. For example, assume you want to use port 1664 (perhaps 1099 is already used). - </p> - <pre > - +</p> +<pre> + On Windows (in a DOS box) C:\JMETER> SET SERVER_PORT=1664 C:\JMETER> JMETER-SERVER [other options] @@ -454,161 +475,160 @@ $ SERVER_PORT=1664 jmeter-server [other options] [N.B. use upper case for the environment variable] - </pre> - <p > - +</pre> +<p> + In both cases, the script starts rmiregistry on the specified port, and then starts JMeter in server mode, having defined the "server_port" property. - </p> - <p > - +</p> +<p> + The chosen port will be logged in the server jmeter.log file (rmiregistry does not create a log file). - </p> - </blockquote> - </td></tr> - <tr><td><br></td></tr> - </table> - <table border="0" cellspacing="0" cellpadding="2" width="100%"> - <tr><td bgcolor="#828DA6"> - <font color="#ffffff" face="arial,helvetica,sanserif"> - <a name="batchmode"><strong>15.4 Using sample batching</strong></a> - </font> - </td></tr> - <tr><td> - <blockquote> - <p > - +</p> +</blockquote> +</td></tr> +<tr><td><br></td></tr> +</table> +<table border="0" cellspacing="0" cellpadding="2" width="100%"> +<tr><td bgcolor="#828DA6"> +<font color="#ffffff" face="arial,helvetica,sanserif"> +<a name="batchmode"><strong>15.4 Using sample batching</strong></a> +</font> +</td></tr> +<tr><td> +<blockquote> +<p> + Listeners in the test plan send their results back to the client JMeter which writes the results to the specified files By default, samples are sent back as they are generated. This can place a large load on the network and the JMeter client. There are some JMeter properties that can be set to alter this behaviour. - </p> - <ul > - - - <li > - mode - sample sending mode - default is Standard - </li> - - - <ul > - - - <li > - Standard - send samples as soon as they are generated - </li> - - - <li > - Hold - hold samples in an array until the end of a run. This may use a lot of memory on the server. - </li> - - - <li > - Batch - send saved samples when either the count or time exceeds a threshold - </li> - +</p> +<ul> + + +<li> +mode - sample sending mode - default is Standard +</li> + + +<ul> + - <li > - Statistical - send a summary sample when either the count or time exceeds a threshold. +<li> +Standard - send samples as soon as they are generated +</li> + + +<li> +Hold - hold samples in an array until the end of a run. This may use a lot of memory on the server. +</li> + + +<li> +Batch - send saved samples when either the count or time exceeds a threshold +</li> + + +<li> +Statistical - send a summary sample when either the count or time exceeds a threshold. The samples are summarised by thread group name and sample label. The following fields are accumulated: - <ul > - +<ul> + + +<li> +elapsed time +</li> + + +<li> +latency +</li> + + +<li> +bytes +</li> + + +<li> +sample count +</li> + - <li > - elapsed time - </li> - - - <li > - latency - </li> - - - <li > - bytes - </li> - - - <li > - sample count - </li> - - - <li > - error count - </li> - +<li> +error count +</li> + - </ul> - +</ul> + Other fields that vary between samples are lost. - </li> - +</li> + + +</ul> + + +</ul> +<p> +The following properties apply to the Batch and Statistical modes: +</p> +<ul> + + +<li> +num_sample_threshold - number of samples in a batch (default 100) +</li> + - </ul> - +<li> +time_threshold - number of milliseconds to wait (default 60 seconds) +</li> - </ul> - <p > - The following properties apply to the Batch and Statistical modes: - </p> - <ul > - - - <li > - num_sample_threshold - number of samples in a batch (default 100) - </li> - - - <li > - time_threshold - number of milliseconds to wait (default 60 seconds) - </li> - - - </ul> - </blockquote> - </td></tr> - <tr><td><br></td></tr> - </table> - </blockquote> - </p> - </td></tr> - <tr><td><br></td></tr> - </table> - <table> - <tr> - <td bgcolor="#525D76"> - <div align="right"><a href="index.html"><font size=-1 color="#ffffff" face="arial,helvetica,sanserif">Index</font></a></div> - </td> - <td bgcolor="#525D76"> - <div align="right"><a href="best-practices.html"><font size=-1 color="#ffffff" face="arial,helvetica,sanserif">Next</font></a></div> - </td> - <td bgcolor="#525D76"> - <div align="right"><a href="listeners.html"><font size=-1 color="#ffffff" face="arial,helvetica,sanserif">Prev</font></a></div> - </td> - </tr> - </table> - <br> - </td> - </tr> - - <tr><td colspan="2"> - <hr noshade size="1"/> - </td></tr> - <tr><td colspan="2"> - <div align="center"><font color="#525D76" size="-1"><em> - Copyright © 1999-2008, Apache Software Foundation - </em></font></div> - </td></tr> - </table> - </body> - </html> + +</ul> +</blockquote> +</td></tr> +<tr><td><br></td></tr> +</table> +</blockquote> +</p> +</td></tr> +<tr><td><br></td></tr> +</table> +<table> +<tr> +<td bgcolor="#525D76"> +<div align="right"><a href="index.html"><font size=-1 color="#ffffff" face="arial,helvetica,sanserif">Index</font></a></div> +</td> +<td bgcolor="#525D76"> +<div align="right"><a href="best-practices.html"><font size=-1 color="#ffffff" face="arial,helvetica,sanserif">Next</font></a></div> +</td> +<td bgcolor="#525D76"> +<div align="right"><a href="listeners.html"><font size=-1 color="#ffffff" face="arial,helvetica,sanserif">Prev</font></a></div> +</td> +</tr> +</table> +<br> +</td> +</tr> +<tr><td colspan="2"> +<hr noshade size="1"/> +</td></tr> +<tr><td colspan="2"> +<div align="center"><font color="#525D76" size="-1"><em> +Copyright © 1999-2009, Apache Software Foundation +</em></font></div> +</td></tr> +</table> +</body> +</html> <!-- end the processing --> --------------------------------------------------------------------- To unsubscribe, e-mail: jmeter-dev-unsubscr...@jakarta.apache.org For additional commands, e-mail: jmeter-dev-h...@jakarta.apache.org
