Modified: jmeter/trunk/docs/usermanual/functions.html URL: http://svn.apache.org/viewvc/jmeter/trunk/docs/usermanual/functions.html?rev=1822450&r1=1822449&r2=1822450&view=diff ============================================================================== --- jmeter/trunk/docs/usermanual/functions.html (original) +++ jmeter/trunk/docs/usermanual/functions.html Sun Jan 28 08:38:53 2018 @@ -334,6 +334,14 @@ Alternatively, just use <span class="cod </tr> <tr> +<td>Formatting</td><td> <a href="#__dateTimeConvert">dateTimeConvert</a></td><td>Convert a date or time from source to target format</td><td>4.0</td> +</tr> + +<tr> +<td>Calculation</td><td> <a href="#__digest">digest</a></td><td>Generate a digest (SHA-1, SHA-256, MD5...)</td><td>4.0</td> +</tr> + +<tr> <td>Calculation</td><td> <a href="#__intSum">intSum</a></td><td>add int numbers</td><td>1.8.1</td> </tr> @@ -382,6 +390,10 @@ Alternatively, just use <span class="cod </tr> <tr> +<td>Properties</td><td> <a href="#__isPropDefined">isPropDefined</a> </td><td>Test if a property exists</td><td>4.0</td> +</tr> + +<tr> <td>Properties</td><td> <a href="#__property">property</a> </td><td>read a property</td><td>2.0</td> </tr> @@ -398,10 +410,6 @@ Alternatively, just use <span class="cod </tr> <tr> -<td>Variables</td><td> <a href="#__V">V</a></td><td>evaluate a variable name</td><td>2.3RC3</td> -</tr> - -<tr> <td>Variables</td><td> <a href="#__eval">eval</a></td><td>evaluate a variable expression</td><td>2.3.1</td> </tr> @@ -410,11 +418,11 @@ Alternatively, just use <span class="cod </tr> <tr> -<td>String</td><td> <a href="#__regexFunction">regexFunction</a></td><td>parse previous response using a regular expression</td><td>1.X</td> +<td>Properties</td><td> <a href="#__isVarDefined">isVarDefined</a> </td><td>Test if a variable exists</td><td>4.0</td> </tr> <tr> -<td>String</td><td> <a href="#__escapeOroRegexpChars">escapeOroRegexpChars</a></td><td>quote meta chars used by ORO regular expression</td><td>2.9</td> +<td>Variables</td><td> <a href="#__V">V</a></td><td>evaluate a variable name</td><td>2.3RC3</td> </tr> <tr> @@ -422,15 +430,15 @@ Alternatively, just use <span class="cod </tr> <tr> -<td>String</td><td> <a href="#__unescape">unescape</a></td><td>Process strings containing Java escapes (e.g. \n & \t)</td><td>2.3.3</td> +<td>String</td><td> <a href="#__changeCase">changeCase</a></td><td>Change case following different modes</td><td>4.0</td> </tr> <tr> -<td>String</td><td> <a href="#__unescapeHtml">unescapeHtml</a></td><td>Decode HTML-encoded strings</td><td>2.3.3</td> +<td>String</td><td> <a href="#__escapeHtml">escapeHtml</a></td><td>Encode strings using HTML encoding</td><td>2.3.3</td> </tr> <tr> -<td>String</td><td> <a href="#__escapeHtml">escapeHtml</a></td><td>Encode strings using HTML encoding</td><td>2.3.3</td> +<td>String</td><td> <a href="#__escapeOroRegexpChars">escapeOroRegexpChars</a></td><td>quote meta chars used by ORO regular expression</td><td>2.9</td> </tr> <tr> @@ -438,6 +446,18 @@ Alternatively, just use <span class="cod </tr> <tr> +<td>String</td><td> <a href="#__regexFunction">regexFunction</a></td><td>parse previous response using a regular expression</td><td>1.X</td> +</tr> + +<tr> +<td>String</td><td> <a href="#__unescape">unescape</a></td><td>Process strings containing Java escapes (e.g. \n & \t)</td><td>2.3.3</td> +</tr> + +<tr> +<td>String</td><td> <a href="#__unescapeHtml">unescapeHtml</a></td><td>Decode HTML-encoded strings</td><td>2.3.3</td> +</tr> + +<tr> <td>String</td><td> <a href="#__urldecode">urldecode</a></td><td>Decode a application/x-www-form-urlencoded string</td><td>2.10</td> </tr> @@ -2230,6 +2250,28 @@ The following variables are set before t Other variables vary from invocation to invocation. </p> +<div class="clear"></div> +<div class="note"> +When using this function please use the variables defined above rather than using string replacement to access a variable in your script. Following this pattern will ensure that your tests are performant by ensuring that the Groovy can be cached. +</div> +<div class="clear"></div> + +<p> +For instance <strong>don't</strong> do the following: +</p> + + +<p> +<pre class="source">${__groovy("${myVar}".substring(0\,2))}</pre> +</p> + + +<p>Imagine that the variable myVar changes with each transaction, the Groovy above cannot be cached as the script changes each time.<br> +<br> +Instead do the following, which can be cached: <pre class="source">${__groovy(vars.get("myVar").substring(0\,2))}</pre> + +</p> + </div> <div class="properties"> <h3 id="__groovy_parms1"> @@ -2268,13 +2310,13 @@ Example: <dl> <dt> -<span class="code">${__groovy(123*456)}</span> +<pre class="source">${__groovy(123*456)}</pre> </dt> <dd>returns <span class="code">56088</span> </dd> <dt> -<span class="code">${__groovy("${var}".substring(0\,2))}</span> +<pre class="source">${__groovy(vars.get("myVar").substring(0\,2))}</pre> </dt> <dd>If var's value is <span class="code">JMeter</span>, it will return <span class="code">JM</span> as it runs <span class="code">String.substring(0,2)</span>. Note that <span class="code">,</span> has been escaped to <span class="code">\,</span> @@ -2316,7 +2358,7 @@ Remember to include any necessary quotes Define <span class="code">VAR</span>="<span class="code">a||c|</span>" in the test plan. <br> -<span class="code">${__split(${VAR},VAR,|)}</span> +<pre class="source">${__split(${VAR},VAR,|)}</pre> <br> This will return the contents of <span class="code">VAR</span>, i.e. "<span class="code">a||c|</span>" and set the following variables: @@ -2510,7 +2552,7 @@ If omitted, <span class="code">,</span> <div class="property"> <div class="name req-false">Format</div> <div class="description req-false"> - The format to be passed to SimpleDateFormat. + The format to be passed to <a href="https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html";>SimpleDateFormat</a>. The function supports various shorthand aliases, see below. If omitted, the function returns the current time in milliseconds since the epoch. </div> @@ -2558,6 +2600,13 @@ The following shorthand aliases are prov <span class="code">time.YMD=yyMMdd</span> </p> +<p> +<pre class="source">${__time(dd/MM/yyyy,)}</pre> will return <span class="code">21/01/2018</span> if ran on 21 january 2018</p> +<p> +<pre class="source">${__time(YMD,)}</pre> will return <span class="code">20180121</span> if ran on 21 january 2018</p> +<p> +<pre class="source">${__time()}</pre> will return time in millis <span class="code">1516540541624</span> +</p> <div class="go-top"> <a href="#">^</a> </div> @@ -3055,13 +3104,13 @@ Supports HTML 4.0 entities. </p> <p> -For example, the string <span class="code">"&lt;Fran&ccedil;ais&gt;"</span> -will become <span class="code">"<Français>"</span>. +For example, the string <pre class="source">${__unescapeHtml(&lt;Fran&ccedil;ais&gt;)}</pre> +will return <span class="code"><Français></span>. </p> <p> If an entity is unrecognized, it is left alone, and inserted verbatim into the result string. -e.g. <span class="code">"&gt;&zzzz;x"</span> will become <span class="code">">&zzzz;x"</span>. +e.g. <span class="code">${__unescapeHtml(&gt;&zzzz;x)}</span> will return <span class="code">>&zzzz;x</span>. </p> <p> @@ -3106,8 +3155,8 @@ Supports HTML 4.0 entities. </p> <p> -For example,<span class="code">"bread" & "butter"</span> -becomes: +For example,<pre class="source">${__escapeHtml("bread" & "butter")}</pre> +return: <span class="code">&quot;bread&quot; &amp; &quot;butter&quot;</span>. </p> @@ -3153,7 +3202,7 @@ Note: use UTF-8 as the encoding scheme. </p> <p> -For example, the string <span class="code">Word+%22school%22+is+%22%C3%A9cole%22+in+french</span> would get converted to +For example, the string <pre class="source">${__urldecode(Word+%22school%22+is+%22%C3%A9cole%22+in+french)}</pre> returns <span class="code">Word "school" is "école" in french</span>. </p> @@ -3198,7 +3247,7 @@ Function to encode a string to a <span c </p> <p> -For example, the string <span class="code">Word "school" is "école" in french</span> would get converted to +For example, the string <pre class="source">${__urldecode(Word "school" is "école" in french)}</pre> returns <span class="code">Word+%22school%22+is+%22%C3%A9cole%22+in+french</span>. </p> @@ -3306,6 +3355,9 @@ A reference name - <span class="code">re and Http Cookie Manager, and in this case the functions are resolved in the context of the Http Sampler. Pre-Processors, Post-Processors and Assertions always have an associated Sampler. </p> + +<p>Example: <pre class="source">${__samplerName()}</pre> +</p> </div> <div class="properties"> @@ -3365,8 +3417,8 @@ Function which escapes the ORO Regexp me </p> <p> -For example,<span class="code">[^"].+?</span> -becomes: +For example,<pre class="source">${__escapeOroRegexpChars([^"].+?,)}</pre> +returns: <span class="code">\[\^\"\]\.\+\?</span>. </p> @@ -3419,8 +3471,8 @@ Function which escapes the characters in </p> <p> -For example,<span class="code">"bread" & 'butter'</span> -becomes: +For example,<pre class="source">${__escapeXml("bread" & 'butter')}</pre> +returns: <span class="code">&quot;bread&quot; &amp; &apos;butter&apos;</span>. </p> @@ -3479,7 +3531,7 @@ becomes: <div class="name req-false">Format</div> <div class="description req-false"> The format to be passed to DateTimeFormatter. - See https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html + See <a href="https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html";>DateTimeFormatter</a> If omitted, the function uses milliseconds since epoch format. </div> <div class="required req-false">No</div> @@ -3538,6 +3590,311 @@ becomes: </div> </div> +<p>Examples: +<pre class="source">${__timeShift(dd/MM/yyyy,21/01/2018,P2D,,)}</pre> returns <span class="code">23/01/2018</span> + +<pre class="source">${__timeShift(dd MMMM yyyy,21 février 2018,P2D,fr_FR,)}</pre> returns <span class="code">23 février 2018</span> + +</p> +<div class="go-top"> +<a href="#">^</a> +</div> +</div> + +<div class="component"> +<h2 id="__digest">__digest<a class="sectionlink" href="#__digest" title="Link to here">¶</a> +</h2> +<div class="description"> + +<p>The digest function returns an encrypted value in the + specific hash algorithm with the optional salt, upper case + and variable name.</p> + +</div> +<div class="properties"> +<h3 id="__digest_parms1"> + Parameters + <a class="sectionlink" href="#__digest_parms1" title="Link to here">¶</a> +</h3> +<div class="property title"> +<div class="name title">Attribute</div> +<div class="description title">Description</div> +<div class="required title">Required</div> +</div> + +<div class="property"> +<div class="name req-true">Algorithm</div> +<div class="description req-true"> + The algorithm to be used to encrypt + For possible algorithms See MessageDigest in + <a href="https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html";>StandardNames</a> + +<ul> + +<li>MD2</li> + +<li>MD5</li> + +<li>SHA-1</li> + +<li>SHA-224</li> + +<li>SHA-256</li> + +<li>SHA-384</li> + +<li>SHA-512</li> + +</ul> + +<div class="clear"></div> +<div class="note">Spaces are taken into account for <span class="code">Salt to add</span> and <span class="code">String to encode</span> +</div> +<div class="clear"></div> + +</div> +<div class="required req-true">Yes</div> +</div> + +<div class="property"> +<div class="name req-true">String to encode</div> +<div class="description req-true"> The String + that will be encrypted </div> +<div class="required req-true">Yes</div> +</div> + +<div class="property"> +<div class="name req-false">Salt to add</div> +<div class="description req-false"> Salt to be added + to string (after it)</div> +<div class="required req-false">No</div> +</div> + +<div class="property"> +<div class="name req-false">Upper Case value</div> +<div class="description req-false"> Result will + be in lower case by default. Choose true to upper case + results. </div> +<div class="required req-false">No</div> +</div> + +<div class="property"> +<div class="name req-false">Name of variable</div> +<div class="description req-false">The name of + the variable to set.</div> +<div class="required req-false">No</div> +</div> + +</div> +<p>Examples: + <pre class="source">${__digest(MD5,Errare humanum est,,,)}</pre> returns <span class="code">c49f00b92667a35c63708933384dad52</span> +<br> + +<pre class="source">${__digest(SHA-256,Felix qui potuit rerum cognoscere causas,mysalt,,)}</pre> returns <span class="code">a3bc6900fe2b2fc5fa8a601a4a84e27a079bf2c581d485009bc5c00516729ac7</span> +<br> + + +</p> +<div class="go-top"> +<a href="#">^</a> +</div> +</div> + +<div class="component"> +<h2 id="__dateTimeConvert">__dateTimeConvert<a class="sectionlink" href="#__dateTimeConvert" title="Link to here">¶</a> +</h2> +<div class="description"> + +<p>The <span class="code">__dateTimeConvert</span> function converts a date that is in source format + to a target format storing the result optionally in the variable name.</p> + +</div> +<div class="properties"> +<h3 id="__dateTimeConvert_parms1"> + Parameters + <a class="sectionlink" href="#__dateTimeConvert_parms1" title="Link to here">¶</a> +</h3> +<div class="property title"> +<div class="name title">Attribute</div> +<div class="description title">Description</div> +<div class="required title">Required</div> +</div> + +<div class="property"> +<div class="name req-true">Date String</div> +<div class="description req-true"> + The date string to convert from Source Date Format to Target Date Format. + </div> +<div class="required req-true">Yes</div> +</div> + +<div class="property"> +<div class="name req-true">Source Date Format</div> +<div class="description req-true">The original date format</div> +<div class="required req-true">Yes</div> +</div> + +<div class="property"> +<div class="name req-true">Target Date Format</div> +<div class="description req-true">The new date format</div> +<div class="required req-true">Yes</div> +</div> + +<div class="property"> +<div class="name req-false">Name of variable</div> +<div class="description req-false">The name of the variable to set.</div> +<div class="required req-false">No</div> +</div> + +</div> +<p>Example: + <pre class="source">${__dateTimeConvert(01212018,MMddyyyy,dd/MM/yyyy,)}</pre> returns <span class="code">21/01/2018</span> + +</p> +<div class="go-top"> +<a href="#">^</a> +</div> +</div> + +<div class="component"> +<h2 id="__isPropDefined">__isPropDefined<a class="sectionlink" href="#__isPropDefined" title="Link to here">¶</a> +</h2> +<div class="description"> + +<p>The <span class="code">__isPropDefined</span> function returns true if property exists or false if not.</p> + +</div> +<div class="properties"> +<h3 id="__isPropDefined_parms1"> + Parameters + <a class="sectionlink" href="#__isPropDefined_parms1" title="Link to here">¶</a> +</h3> +<div class="property title"> +<div class="name title">Attribute</div> +<div class="description title">Description</div> +<div class="required title">Required</div> +</div> + +<div class="property"> +<div class="name req-true">Property Name</div> +<div class="description req-true"> + The Property Name to be used to check if defined + </div> +<div class="required req-true">Yes</div> +</div> + +</div> +<p>Example: <pre class="source">${__isPropDefined(START.HMS)}</pre> will return <span class="code">true</span> +</p> +<div class="go-top"> +<a href="#">^</a> +</div> +</div> + +<div class="component"> +<h2 id="__isVarDefined">__isVarDefined<a class="sectionlink" href="#__isVarDefined" title="Link to here">¶</a> +</h2> +<div class="description"> + +<p>The <span class="code">__isVarDefined</span> function returns true if variable exists or false if not.</p> + +</div> +<div class="properties"> +<h3 id="__isVarDefined_parms1"> + Parameters + <a class="sectionlink" href="#__isVarDefined_parms1" title="Link to here">¶</a> +</h3> +<div class="property title"> +<div class="name title">Attribute</div> +<div class="description title">Description</div> +<div class="required title">Required</div> +</div> + +<div class="property"> +<div class="name req-true">Variable Name</div> +<div class="description req-true"> + The Variable Name to be used to check if defined + </div> +<div class="required req-true">Yes</div> +</div> + +</div> +<p>Example: <pre class="source">${__isVarDefined(JMeterThread.last_sample_ok)}</pre> will return <span class="code">true</span> +</p> +<div class="go-top"> +<a href="#">^</a> +</div> +</div> + +<div class="component"> +<h2 id="__changeCase">__changeCase<a class="sectionlink" href="#__changeCase" title="Link to here">¶</a> +</h2> +<div class="description"> + +<p>The change case function returns a string value which + case has been changed following a specific mode. + Result can optionally be saved in a JMeter variable.</p> + +</div> +<div class="properties"> +<h3 id="__changeCase_parms1"> + Parameters + <a class="sectionlink" href="#__changeCase_parms1" title="Link to here">¶</a> +</h3> +<div class="property title"> +<div class="name title">Attribute</div> +<div class="description title">Description</div> +<div class="required title">Required</div> +</div> + +<div class="property"> +<div class="name req-true">String to change case</div> +<div class="description req-true">The String + which case will be changed</div> +<div class="required req-true">Yes</div> +</div> + +<div class="property"> +<div class="name req-true">change case mode</div> +<div class="description req-true"> + The mode to be used to change case, for example for <span class="code">ab-CD eF</span>: + <ul> + +<li> +<span class="code">UPPER</span> result as AB-CD EF</li> + +<li> +<span class="code">LOWER</span> result as ab-cd ed</li> + +<li> +<span class="code">CAPITALIZE</span> result as Ab-CD eF</li> + +</ul> + +<div class="clear"></div> +<div class="note"> +<span class="code">change case mode</span> is case insensitive</div> +<div class="clear"></div> + +</div> +<div class="required req-true">Yes</div> +</div> + +<div class="property"> +<div class="name req-false">Name of variable</div> +<div class="description req-false">The name of the variable to set.</div> +<div class="required req-false">No</div> +</div> + +</div> +<p>Examples: + <pre class="source">${__changeCase(Avaro omnia desunt\, inopi pauca\, sapienti nihil,UPPER,)}</pre> will return <span class="code">AVARO OMNIA DESUNT, INOPI PAUCA, SAPIENTI NIHIL</span> + +<pre class="source">${__changeCase(LABOR OMNIA VINCIT IMPROBUS,LOWER,)}</pre> will return <span class="code">labor omnia vincit improbus</span> + +<pre class="source">${__changeCase(omnibus viis romam pervenitur,CAPITALIZE,)}</pre> will return <span class="code">Omnibus viis romam pervenitur</span> + +</p> <div class="go-top"> <a href="#">^</a> </div> @@ -3644,7 +4001,7 @@ They are mainly intended for use in file <div class="copyright"> Copyright © 1999 – - 2017 + 2018 , Apache Software Foundation </div> <div class="trademarks">Apache, Apache JMeter, JMeter, the Apache
Modified: jmeter/trunk/docs/usermanual/generating-dashboard.html URL: http://svn.apache.org/viewvc/jmeter/trunk/docs/usermanual/generating-dashboard.html?rev=1822450&r1=1822449&r2=1822450&view=diff ============================================================================== --- jmeter/trunk/docs/usermanual/generating-dashboard.html (original) +++ jmeter/trunk/docs/usermanual/generating-dashboard.html Sun Jan 28 08:38:53 2018 @@ -574,8 +574,8 @@ jmeter.save.saveservice.timestamp_format <div class="clear"></div> Example: <pre class="source">jmeter.reportgenerator.apdex_per_transaction=sample(\\d+):1000|2000;\ - samples12:3000|4000;\ - scenar01-12:5000|6000</pre> + samples12:3000|4000;\ + scenar01-12:5000|6000</pre> </div> <div class="required req-false">No</div> @@ -1224,8 +1224,8 @@ jmeter.save.saveservice.timestamp_format #jmeter.reportgenerator.overall_granularity=60000 Change this parameter if you want to change the granularity of Response time distribution -# Set to 500 ms by default -#jmeter.reportgenerator.graph.responseTimeDistribution.property.set_granularity=500 +# Set to 100 ms by default +#jmeter.reportgenerator.graph.responseTimeDistribution.property.set_granularity=100 # Change this parameter if you want to override the APDEX satisfaction threshold. jmeter.reportgenerator.apdex_satisfied_threshold=1500 @@ -1547,7 +1547,7 @@ jmeter.reportgenerator.exporter.html.fil <div class="copyright"> Copyright © 1999 – - 2017 + 2018 , Apache Software Foundation </div> <div class="trademarks">Apache, Apache JMeter, JMeter, the Apache Modified: jmeter/trunk/docs/usermanual/get-started.html URL: http://svn.apache.org/viewvc/jmeter/trunk/docs/usermanual/get-started.html?rev=1822450&r1=1822449&r2=1822450&view=diff ============================================================================== --- jmeter/trunk/docs/usermanual/get-started.html (original) +++ jmeter/trunk/docs/usermanual/get-started.html Sun Jan 28 08:38:53 2018 @@ -555,7 +555,7 @@ You can rename the parent directory (i.e <br> <p>To run JMeter, run the <span class="code">jmeter.bat</span> (for Windows) or <span class="code">jmeter</span> (for Unix) file. -These files are found in the bin directory. +These files are found in the <span class="code">bin</span> directory. After a short time, the JMeter GUI should appear. <div class="clear"></div> <div class="note">GUI mode should only be used for creating the test script, NON GUI mode must be used for load testing</div> @@ -565,7 +565,7 @@ After a short time, the JMeter GUI shoul <p> -There are some additional scripts in the bin directory that you may find useful. +There are some additional scripts in the <span class="code">bin</span> directory that you may find useful. Windows script files (the .CMD files require Win2K or later): </p> @@ -625,16 +625,75 @@ and means the last test plan that was ru <p> -The environment variable <span class="code">JVM_ARGS</span> can be used to override JVM settings in the <span class="code">jmeter.bat</span> script. -For example: +There are a few environment variables, that can be used to customize the JVM settings for JMeter. An easy way to set those is by creating a file named <span class="code">setenv.bat</span> in the <span class="code">bin</span> directory. Such a file could look like: </p> + +<pre class="source"> +rem This is the content of bin\setenv.bat, +rem it will be called by bin\jmeter.bat + +set JVM_ARGS="-Xms1024m -Xmx1024m -Dpropname=value" +</pre> + + +<p> +The <span class="code">JVM_ARGS</span> can be used to override JVM settings in the <span class="code">jmeter.bat</span> script and will get set when starting JMeter, e.g.: +</p> + + <pre class="source"> -set JVM_ARGS="-Xms1024m -Xmx1024m -Dpropname=propvalue" jmeter -t test.jmx … </pre> +<p>The following environment variables can be defined:</p> + +<dl> + +<dt> +<span class="code">DDRAW</span> +</dt> +<dd>JVM options to influence usage of direct draw, e.g. <span class="code">-Dsun.java2d.ddscale=true</span>. Default is empty.</dd> + +<dt> +<span class="code">JMETER_BIN</span> +</dt> +<dd>JMeter bin directory (must end in <span class="code">\</span>). Value will have been guessed, when <span class="code">setenv.bat</span> is called.</dd> + +<dt> +<span class="code">JMETER_HOME</span> +</dt> +<dd>installation directory. Will be guessed from location of <span class="code">jmeter.bat</span> +</dd> + +<dt> +<span class="code">JM_LAUNCH</span> +</dt> +<dd>Name of the java executable, like <span class="code">java.exe</span> (default) or <span class="code">javaw.exe</span> +</dd> + +<dt> +<span class="code">JVM_ARGS</span> +</dt> +<dd>Java options to be used when starting JMeter. These will be added last to the java command. Defaults to: <span class="code">-Duser.language="en" -Duser.region="EN"</span> +</dd> + +<dt> +<span class="code">GC_ALGO</span> +</dt> +<dd>JVM garbage collector options. Defaults to <span class="code">-XX:+UseG1GC -XX:MaxGCPauseMillis=250 -XX:G1ReservePercent=20</span> +</dd> + +<dt> +<span class="code">HEAP</span> +</dt> +<dd>JVM memory settings used when starting JMeter. Defaults to <span class="code">-Xms512m -Xmx512m -XX:MaxMetaspaceSize=256m</span> +</dd> + +</dl> + + <p> Un*x script files; should work on most Linux/Unix systems: </p> @@ -674,9 +733,7 @@ Un*x script files; should work on most L </dl> <p> -It may be necessary to edit the jmeter shell script if some of the JVM options are not supported -by the JVM you are using. -The <span class="code">JVM_ARGS</span> environment variable can be used to override or set additional JVM options, for example: +It may be necessary to set a few environment variables to configure the JVM used by JMeter. Those variables can be either set directly in the shell starting the <span class="code">jmeter</span> script. For example setting the variable <span class="code">JVM_ARGS</span> will override most pre-defined settings, for example </p> <pre class="source"> @@ -687,6 +744,67 @@ JVM_ARGS="-Xms1024m -Xmx1024m" jmeter -t will override the HEAP settings in the script. </p> +<p>To set those variables permanently, you can place them in a file called <span class="code">setenv.sh</span> in the <span class="code">bin</span> directory. This file will be sourced when running JMeter by calling the <span class="code">jmeter</span> script. An example for <span class="code">bin/setenv.sh</span> could look like: +</p> + + +<pre class="source"> +# This is the file bin/setenv.sh, +# it will be sourced in by bin/jmeter + +# Use a bigger heap, but a smaller metaspace, than the default +export JMETER_HEAP="-Xms1G -Xmx1G -XMaxMetaspaceSize=192m" + +# Try to guess the locale from the OS. The space as value is on purpose! +export JMETER_LANGUAGE=" " +</pre> + + +<p>The following environment variables can be defined:</p> + +<dl> + +<dt> +<span class="code">JAVA_HOME</span> +</dt> +<dd>Must point at your Java Development Kit installation. Required to run the with the "<span class="code">debug</span>" argument. On some OSes it JMeter will try its best to guess the location of the JVM.</dd> + +<dt> +<span class="code">JRE_HOME</span> +</dt> +<dd>Must point at your Java Runtime installation. Defaults to <span class="code">JAVA_HOME</span> if empty. If <span class="code">JRE_HOME</span> and <span class="code">JAVA_HOME</span> are both empty, JMeter will try to guess <span class="code">JAVA_HOME</span>. If <span class="code">JRE_HOME</span> and <span class="code">JAVA_HOME</span> are both set, <span class="code">JAVA_HOME</span> is used.</dd> + +<dt> +<span class="code">JMETER_GC_ALGO</span> +</dt> +<dd>Java runtime options to specify JVM garbage collection algorithm. Defaults to <span class="code">-XX:+UseG1GC -XX:MaxGCPauseMillis=250 -XX:G1ReservePercent=20</span> +</dd> + +<dt> +<span class="code">JMETER_HEAP</span> +</dt> +<dd>Java runtime options for memory management used when JMeter is started. Defaults to <span class="code">-Xms512m -Xmx512m -X:MaxMetaspaceSize=256m</span> +</dd> + +<dt> +<span class="code">JMETER_HOME</span> +</dt> +<dd>May point to your JMeter install dir. If empty it will be set relative to the <span class="code">jmeter</span> script.</dd> + +<dt> +<span class="code">JMETER_LANGUAGE</span> +</dt> +<dd>Java runtime options to specify used language. Defaults to <span class="code">-Duser.language=en -Duser.region=EN</span> +</dd> + +<dt> +<span class="code">JMETER_OPTS</span> +</dt> +<dd>Java runtime options used when JMeter is started. Special options for operating systems might be added by JMeter.</dd> + +</dl> + + <div class="subsection"> <h2 id="classpath">1.4.1 JMeter's Classpath<a class="sectionlink" href="#classpath" title="Link to here">¶</a> </h2> @@ -1693,7 +1811,7 @@ See also the comments in the <span class <div class="copyright"> Copyright © 1999 – - 2017 + 2018 , Apache Software Foundation </div> <div class="trademarks">Apache, Apache JMeter, JMeter, the Apache Modified: jmeter/trunk/docs/usermanual/glossary.html URL: http://svn.apache.org/viewvc/jmeter/trunk/docs/usermanual/glossary.html?rev=1822450&r1=1822449&r2=1822450&view=diff ============================================================================== --- jmeter/trunk/docs/usermanual/glossary.html (original) +++ jmeter/trunk/docs/usermanual/glossary.html Sun Jan 28 08:38:53 2018 @@ -326,7 +326,7 @@ The formula is: Throughput = (number of <div class="copyright"> Copyright © 1999 – - 2017 + 2018 , Apache Software Foundation </div> <div class="trademarks">Apache, Apache JMeter, JMeter, the Apache Modified: jmeter/trunk/docs/usermanual/hints_and_tips.html URL: http://svn.apache.org/viewvc/jmeter/trunk/docs/usermanual/hints_and_tips.html?rev=1822450&r1=1822449&r2=1822450&view=diff ============================================================================== --- jmeter/trunk/docs/usermanual/hints_and_tips.html (original) +++ jmeter/trunk/docs/usermanual/hints_and_tips.html Sun Jan 28 08:38:53 2018 @@ -601,7 +601,7 @@ will match any component that contains t <div class="copyright"> Copyright © 1999 – - 2017 + 2018 , Apache Software Foundation </div> <div class="trademarks">Apache, Apache JMeter, JMeter, the Apache Modified: jmeter/trunk/docs/usermanual/history_future.html URL: http://svn.apache.org/viewvc/jmeter/trunk/docs/usermanual/history_future.html?rev=1822450&r1=1822449&r2=1822450&view=diff ============================================================================== --- jmeter/trunk/docs/usermanual/history_future.html (original) +++ jmeter/trunk/docs/usermanual/history_future.html Sun Jan 28 08:38:53 2018 @@ -266,7 +266,7 @@ The primary goal of further developments <div class="copyright"> Copyright © 1999 – - 2017 + 2018 , Apache Software Foundation </div> <div class="trademarks">Apache, Apache JMeter, JMeter, the Apache Modified: jmeter/trunk/docs/usermanual/include_controller_tutorial.html URL: http://svn.apache.org/viewvc/jmeter/trunk/docs/usermanual/include_controller_tutorial.html?rev=1822450&r1=1822449&r2=1822450&view=diff ============================================================================== --- jmeter/trunk/docs/usermanual/include_controller_tutorial.html (original) +++ jmeter/trunk/docs/usermanual/include_controller_tutorial.html Sun Jan 28 08:38:53 2018 @@ -327,7 +327,7 @@ as the root and add other controllers to <div class="copyright"> Copyright © 1999 – - 2017 + 2018 , Apache Software Foundation </div> <div class="trademarks">Apache, Apache JMeter, JMeter, the Apache Modified: jmeter/trunk/docs/usermanual/index.html URL: http://svn.apache.org/viewvc/jmeter/trunk/docs/usermanual/index.html?rev=1822450&r1=1822449&r2=1822450&view=diff ============================================================================== --- jmeter/trunk/docs/usermanual/index.html (original) +++ jmeter/trunk/docs/usermanual/index.html Sun Jan 28 08:38:53 2018 @@ -844,7 +844,7 @@ <div class="copyright"> Copyright © 1999 – - 2017 + 2018 , Apache Software Foundation </div> <div class="trademarks">Apache, Apache JMeter, JMeter, the Apache Modified: jmeter/trunk/docs/usermanual/jmeter_accesslog_sampler_step_by_step.html URL: http://svn.apache.org/viewvc/jmeter/trunk/docs/usermanual/jmeter_accesslog_sampler_step_by_step.html?rev=1822450&r1=1822449&r2=1822450&view=diff ============================================================================== --- jmeter/trunk/docs/usermanual/jmeter_accesslog_sampler_step_by_step.html (original) +++ jmeter/trunk/docs/usermanual/jmeter_accesslog_sampler_step_by_step.html Sun Jan 28 08:38:53 2018 @@ -401,7 +401,7 @@ or from the menu <div class="copyright"> Copyright © 1999 – - 2017 + 2018 , Apache Software Foundation </div> <div class="trademarks">Apache, Apache JMeter, JMeter, the Apache Modified: jmeter/trunk/docs/usermanual/jmeter_distributed_testing_step_by_step.html URL: http://svn.apache.org/viewvc/jmeter/trunk/docs/usermanual/jmeter_distributed_testing_step_by_step.html?rev=1822450&r1=1822449&r2=1822450&view=diff ============================================================================== --- jmeter/trunk/docs/usermanual/jmeter_distributed_testing_step_by_step.html (original) +++ jmeter/trunk/docs/usermanual/jmeter_distributed_testing_step_by_step.html Sun Jan 28 08:38:53 2018 @@ -212,6 +212,8 @@ This short tutorial explains how to use <li>Make sure JMeter can access the server.</li> <li>Make sure you use the same version of JMeter and Java on all the systems. Mixing versions will not work correctly.</li> + +<li>You have <a href="remote-test.html#setup_ssl">setup SSL for RMI</a> or disabled it.</li> </ul> @@ -532,7 +534,7 @@ to stop the Linux firewall or ensure you <div class="copyright"> Copyright © 1999 – - 2017 + 2018 , Apache Software Foundation </div> <div class="trademarks">Apache, Apache JMeter, JMeter, the Apache Modified: jmeter/trunk/docs/usermanual/jmeter_proxy_step_by_step.html URL: http://svn.apache.org/viewvc/jmeter/trunk/docs/usermanual/jmeter_proxy_step_by_step.html?rev=1822450&r1=1822449&r2=1822450&view=diff ============================================================================== --- jmeter/trunk/docs/usermanual/jmeter_proxy_step_by_step.html (original) +++ jmeter/trunk/docs/usermanual/jmeter_proxy_step_by_step.html Sun Jan 28 08:38:53 2018 @@ -226,10 +226,11 @@ configuration is correct, read <a href=" <ol> -<li>Go to <span class="code">JMETER_HOME/bin</span> and start JMeter with <span class="code">jmeterw.cmd</span> on Windows - and <span class="code">jmeter</span> on Linux/Unix</li> +<li>Go to <span class="code">JMETER_HOME/bin</span> and start JMeter with <span class="code">jmeterw.bat</span> on Windows + and <span class="code">jmeter.sh + </span> on Linux/Unix</li> -<li>Select <span class="code">Templates...</span> on the menu bar</li> +<li>Select <span class="code">Templates…</span> on the menu bar</li> <figure> <a href="../images/screenshots/Select-Templates-Icon.png"><img src="../images/screenshots/Select-Templates-Icon.png" width="" height="" alt=""></a> @@ -254,7 +255,7 @@ configuration is correct, read <a href=" <dl> <dt> -<span class="code">Server name</span> +<span class="code">Server name or IP</span> </dt> <dd>enter <span class="code">example.com</span> </dd> @@ -285,7 +286,7 @@ configuration is correct, read <a href=" <p> This will start the JMeter proxy server which is used to intercept the browser requests. -A file called <span class="code">ApacheJMeterTemporaryRootCA.crt</span> will be generated in <span class="code">jmeter/bin</span> +A file called <span class="code">ApacheJMeterTemporaryRootCA.crt</span> will be generated in <span class="code">JMETER_HOME/bin</span> folder. Install this certificate in your browser, if you don't know how to do it, read <a href="component_reference.html#HTTP%28S%29_Test_Script_Recorder">Installing the JMeter CA certificate for HTTPS recording</a> @@ -404,13 +405,13 @@ is required by all pages, the request de <dl> <dt> -<span class="code">Number of Threads</span> +<span class="code">Number of Threads (users)</span> </dt> <dd>enter <span class="code">5</span> </dd> <dt> -<span class="code">Ramp-Up Period</span> +<span class="code">Ramp-Up Period (in seconds)</span> </dt> <dd>do not change</dd> @@ -470,23 +471,23 @@ Check with <span class="code">View Resul In some scripts, we will need to: <ul> -<li>Variabilize some input (login, password, search words...)</li> +<li>Variabilize some input (login, password, search words, …)</li> -<li>Correlate some data (session variable...) between two requests</li> +<li>Correlate some data (session variable, …) between two requests</li> -</ul> +</ul> </p> <p> To variabilize, we can use: <ul> - + <li> <span class="code">CSV Data Set Config</span> to get input data from csv file</li> - -<li>JMeter functions like <span class="code">__counter</span>, <span class="code">__time</span>...</li> - + +<li>JMeter functions like <span class="code">__counter</span>, <span class="code">__time</span>, …</li> + <li>etc.</li> </ul> @@ -494,7 +495,7 @@ To variabilize, we can use: </p> <p> -To correlate, we can get data from a request with <span class="code">Post Processors</span> like <span class="code">JSON Extractor</span>, <span class="code">Regular Expression Extractor</span>... and inject it in another request. +To correlate, we can get data from a request with <span class="code">Post Processors</span> like <span class="code">JSON Extractor</span>, <span class="code">Regular Expression Extractor</span>, … and inject it in another request. </p> <p> @@ -607,7 +608,7 @@ At the end of the test, an HTML report w <div class="copyright"> Copyright © 1999 – - 2017 + 2018 , Apache Software Foundation </div> <div class="trademarks">Apache, Apache JMeter, JMeter, the Apache Modified: jmeter/trunk/docs/usermanual/jmeter_tutorial.html URL: http://svn.apache.org/viewvc/jmeter/trunk/docs/usermanual/jmeter_tutorial.html?rev=1822450&r1=1822449&r2=1822450&view=diff ============================================================================== --- jmeter/trunk/docs/usermanual/jmeter_tutorial.html (original) +++ jmeter/trunk/docs/usermanual/jmeter_tutorial.html Sun Jan 28 08:38:53 2018 @@ -1572,7 +1572,7 @@ Here are some example commands. <div class="copyright"> Copyright © 1999 – - 2017 + 2018 , Apache Software Foundation </div> <div class="trademarks">Apache, Apache JMeter, JMeter, the Apache Modified: jmeter/trunk/docs/usermanual/junitsampler_tutorial.html URL: http://svn.apache.org/viewvc/jmeter/trunk/docs/usermanual/junitsampler_tutorial.html?rev=1822450&r1=1822449&r2=1822450&view=diff ============================================================================== --- jmeter/trunk/docs/usermanual/junitsampler_tutorial.html (original) +++ jmeter/trunk/docs/usermanual/junitsampler_tutorial.html Sun Jan 28 08:38:53 2018 @@ -534,7 +534,7 @@ runs multi-threaded, it is important to <div class="copyright"> Copyright © 1999 – - 2017 + 2018 , Apache Software Foundation </div> <div class="trademarks">Apache, Apache JMeter, JMeter, the Apache Modified: jmeter/trunk/docs/usermanual/ldapanswer_xml.html URL: http://svn.apache.org/viewvc/jmeter/trunk/docs/usermanual/ldapanswer_xml.html?rev=1822450&r1=1822449&r2=1822450&view=diff ============================================================================== --- jmeter/trunk/docs/usermanual/ldapanswer_xml.html (original) +++ jmeter/trunk/docs/usermanual/ldapanswer_xml.html Sun Jan 28 08:38:53 2018 @@ -277,7 +277,7 @@ The following tag is used: <div class="copyright"> Copyright © 1999 – - 2017 + 2018 , Apache Software Foundation </div> <div class="trademarks">Apache, Apache JMeter, JMeter, the Apache Modified: jmeter/trunk/docs/usermanual/ldapops_tutor.html URL: http://svn.apache.org/viewvc/jmeter/trunk/docs/usermanual/ldapops_tutor.html?rev=1822450&r1=1822449&r2=1822450&view=diff ============================================================================== --- jmeter/trunk/docs/usermanual/ldapops_tutor.html (original) +++ jmeter/trunk/docs/usermanual/ldapops_tutor.html Sun Jan 28 08:38:53 2018 @@ -342,7 +342,7 @@ <div class="copyright"> Copyright © 1999 – - 2017 + 2018 , Apache Software Foundation </div> <div class="trademarks">Apache, Apache JMeter, JMeter, the Apache Modified: jmeter/trunk/docs/usermanual/listeners.html URL: http://svn.apache.org/viewvc/jmeter/trunk/docs/usermanual/listeners.html?rev=1822450&r1=1822449&r2=1822450&view=diff ============================================================================== --- jmeter/trunk/docs/usermanual/listeners.html (original) +++ jmeter/trunk/docs/usermanual/listeners.html Sun Jan 28 08:38:53 2018 @@ -935,7 +935,7 @@ e.g. a spreadsheet or text editor. <div class="copyright"> Copyright © 1999 – - 2017 + 2018 , Apache Software Foundation </div> <div class="trademarks">Apache, Apache JMeter, JMeter, the Apache Modified: jmeter/trunk/docs/usermanual/properties_reference.html URL: http://svn.apache.org/viewvc/jmeter/trunk/docs/usermanual/properties_reference.html?rev=1822450&r1=1822449&r2=1822450&view=diff ============================================================================== --- jmeter/trunk/docs/usermanual/properties_reference.html (original) +++ jmeter/trunk/docs/usermanual/properties_reference.html Sun Jan 28 08:38:53 2018 @@ -360,6 +360,10 @@ <a href="#naming_policy">19.41 Naming Policy</a> <ul></ul> </li> +<li> +<a href="#help">19.42 Help</a> +<ul></ul> +</li> </ul> <div class="section"> <h1 id="introduction">19 Introduction<a class="sectionlink" href="#introduction" title="Link to here">¶</a> @@ -470,9 +474,10 @@ These properties are only taken into acc <div class="clear"></div> <div class="note">SSL (Java) System properties are now in <span class="code">system.properties</span> <br> -JMeter no longer converts <span class="code">javax.<em>xxx</em></span> property entries in this file into System properties.<br> -These must now be defined in the <span class="code">system.properties</span> file or on the command-line.<br> -The <span class="code">system.properties</span> file gives more flexibility.</div> +JMeter no longer converts <span class="code">javax.<em>xxx</em></span> property entries in +<span class="code">jmeter.properties</span> into System properties. These must now be +defined in the <span class="code">system.properties</span> file or on the command-line. The +<span class="code">system.properties</span> file gives more flexibility.</div> <div class="clear"></div> <div class="properties"> @@ -532,6 +537,27 @@ The <span class="code">system.properties </div> <div class="property"> +<div class="name req-true">https.cipherSuites</div> +<div class="description req-true"> + Comma-separated list of SSL cipher suites that may be used in HTTPS + connections. It may be desirable to use a subset of cipher suites in order + to match expected client behavior or to reduce encryption overhead in + JMeter when running with large numbers of users. Errors may occur if the + JVM does not support the specified cipher suites, or if the cipher suites + supported by the HTTPS server do not overlap this list. See the + <a href="https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html#Customization";>JSSE + Reference Guide.</a> +<br> + For example: <pre class="source">https.cipherSuites=TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_RSA_WITH_AES_128_GCM_SHA256</pre> + If not specified, JMeter will use the default list of cipher suites + supported by the JVM. +</div> +<div class="required req-true"> + No + </div> +</div> + +<div class="property"> <div class="name req-true">https.use.cached.ssl.context</div> <div class="description req-true"> Control if we allow reuse of cached SSL context between iterations.<br> @@ -932,6 +958,19 @@ gui.quick_9=ViewResultsFullVisualizer </div> </div> +<div class="property"> +<div class="name req-true">save_automatically_before_run</div> +<div class="description req-true"> +Enable auto saving of the .jmx file before start run a test plan<br> +When enabled, before the run, the .jmx will be saved and also backed up to the directory pointed.<br> +Defaults to: <span class="code">true</span> + +</div> +<div class="required req-true"> + No + </div> +</div> + </div> </div> @@ -1097,6 +1136,102 @@ JMETER-SERVER</pre> </div> </div> +<div class="property"> +<div class="name req-true">server.rmi.ssl.keystore.type</div> +<div class="description req-true"> + Type of keystore for RMI connection security. Possible values are dependent on the JVM in use, but commonly supported are <span class="code">JKS</span> and <span class="code">PKCS12</span>. + Defaults to: <span class="code">JKS</span> + +</div> +<div class="required req-true"> + No + </div> +</div> + +<div class="property"> +<div class="name req-true">server.rmi.ssl.keystore.file</div> +<div class="description req-true"> + Keystore file that contains private key + Defaults to: <span class="code">rmi_keystore.jks</span> + +</div> +<div class="required req-true"> + No + </div> +</div> + +<div class="property"> +<div class="name req-true">server.rmi.ssl.keystore.password</div> +<div class="description req-true"> + Password of Keystore + Defaults to: <span class="code">changeit</span> + +</div> +<div class="required req-true"> + No + </div> +</div> + +<div class="property"> +<div class="name req-true">server.rmi.ssl.keystore.alias</div> +<div class="description req-true"> + Key alias + Defaults to: <span class="code">rmi</span> + +</div> +<div class="required req-true"> + No + </div> +</div> + +<div class="property"> +<div class="name req-true">server.rmi.ssl.truststore.type</div> +<div class="description req-true"> + Type of truststore for RMI connection security + Defaults to: the value of <span class="code">server.rmi.ssl.keystore.type</span>, which is <span class="code">JKS</span> + +</div> +<div class="required req-true"> + No + </div> +</div> + +<div class="property"> +<div class="name req-true">server.rmi.ssl.truststore.file</div> +<div class="description req-true"> + Keystore file that contains certificate + Defaults to: the value of <span class="code">server.rmi.ssl.keystore.file</span>, which is <span class="code">rmi_keystore.jks</span> + +</div> +<div class="required req-true"> + No + </div> +</div> + +<div class="property"> +<div class="name req-true">server.rmi.ssl.truststore.password</div> +<div class="description req-true"> + Password of Trust store + Defaults to: the value of <span class="code">server.rmi.ssl.keystore.password</span>, which is <span class="code">changeit</span> + +</div> +<div class="required req-true"> + No + </div> +</div> + +<div class="property"> +<div class="name req-true">server.rmi.ssl.disable</div> +<div class="description req-true"> + Set this to <span class="code">true</span> if you don't want to use SSL for RMI + Defaults to: <span class="code">false</span> + +</div> +<div class="required req-true"> + No + </div> +</div> + </div> </div> @@ -1296,13 +1431,13 @@ JMETER-SERVER</pre> <div class="description"> Enable header wire and context logging - Best for Debugging - In log4j2.xml, set: + In log4j2.xml, set: <pre class="source"> <Logger name="org.apache.http" level="debug" /> <Logger name="org.apache.http.wire" level="error" /> </pre> Enable full wire and context logging - In log4j2.xml, set: + In log4j2.xml, set: <pre class="source"><Logger name="org.apache.http" level="debug" /></pre> Enable context logging for connection management <pre class="source"><Logger name="org.apache.http.impl.conn" level="debug" /></pre> @@ -1889,12 +2024,12 @@ JMETER-SERVER</pre> <div class="description req-true"> For use with Comma-separated value (CSV) files or other formats where the fields' values are separated by specified delimiters.<br> + Defaults to: <span class="code">,</span> <div class="clear"></div> -<div class="note">For TAB, since JMeter version 2.3 one can use <span class="code">\t</span> +<div class="note">For TAB, one can use <span class="code">\t</span> </div> <div class="clear"></div> - Defaults to: <span class="code">,</span> </div> <div class="required req-true"> @@ -2624,17 +2759,6 @@ JMETER-SERVER</pre> </dd> <dt> -<span class="code">Hold</span> -</dt> - -<dd>retains samples until end of test (may need lots of memory) - <div class="clear"></div> -<div class="note">The related <span class="code">hold_samples</span> was originally defined as a separate property, but is deprecated now.</div> -<div class="clear"></div> - -</dd> - -<dt> <span class="code">Statistical</span> </dt> @@ -3886,33 +4010,6 @@ JMETER-SERVER</pre> </div> <div class="property"> -<div class="name req-true">sampleresult.getbytes.body_real_size</div> -<div class="description req-true"> - Network response size calculation method<br> - Use real size: number of bytes for response body returned by webserver - (i.e. the network bytes received for response). If set to <span class="code">false</span>, - the (uncompressed) response data size will used (default before version 2.5).<br> - Defaults to: <span class="code">true</span> - -</div> -<div class="required req-true"> - No - </div> -</div> - -<div class="property"> -<div class="name req-true">sampleresult.getbytes.headers_size</div> -<div class="description req-true"> - Include headers: add the headers size in real size.<br> - Defaults to: <span class="code">true</span> - -</div> -<div class="required req-true"> - No - </div> -</div> - -<div class="property"> <div class="name req-true">CookieManager.delete_null_cookies</div> <div class="description req-true"> CookieManager behaviour - should cookies with null/empty values be deleted?<br> @@ -4557,7 +4654,7 @@ JMETER-SERVER</pre> <div class="property"> <div class="name req-true">jmeter.reportgenerator.graph.responseTimeDistribution.property.set_granularity</div> <div class="description req-true"> - Defaults to: <span class="code">500</span> + Defaults to: <span class="code">100</span> </div> <div class="required req-true"> @@ -5358,6 +5455,38 @@ JMETER-SERVER</pre> <a href="#">^</a> </div> +<div class="section"> +<h1 id="help">19.42 Help<a class="sectionlink" href="#help" title="Link to here">¶</a> +</h1> + +<div class="description">Controls how documentation in JMeter is displayed</div> + +<div class="properties"> +<h3> + Parameters + </h3> +<div class="property title"> +<div class="name title">Attribute</div> +<div class="description title">Description</div> +<div class="required title">Required</div> +</div> + +<div class="property"> +<div class="name req-true">help.local</div> +<div class="description req-true"> + Switch that allows using Local documentation opened in JMeter GUI.<br> + By default we use Online documentation opened in Browser. + Defaults to <span class="code">false</span> + +</div> +<div class="required req-true"> + No + </div> +</div> + +</div> + +</div> <ul class="pagelinks"> <li> <a href="component_reference.html">< Prev</a> @@ -5388,7 +5517,7 @@ JMETER-SERVER</pre> <div class="copyright"> Copyright © 1999 – - 2017 + 2018 , Apache Software Foundation </div> <div class="trademarks">Apache, Apache JMeter, JMeter, the Apache Modified: jmeter/trunk/docs/usermanual/realtime-results.html URL: http://svn.apache.org/viewvc/jmeter/trunk/docs/usermanual/realtime-results.html?rev=1822450&r1=1822449&r2=1822450&view=diff ============================================================================== --- jmeter/trunk/docs/usermanual/realtime-results.html (original) +++ jmeter/trunk/docs/usermanual/realtime-results.html Sun Jan 28 08:38:53 2018 @@ -586,7 +586,7 @@ datasources: { <div class="copyright"> Copyright © 1999 – - 2017 + 2018 , Apache Software Foundation </div> <div class="trademarks">Apache, Apache JMeter, JMeter, the Apache Modified: jmeter/trunk/docs/usermanual/regular_expressions.html URL: http://svn.apache.org/viewvc/jmeter/trunk/docs/usermanual/regular_expressions.html?rev=1822450&r1=1822449&r2=1822450&view=diff ============================================================================== --- jmeter/trunk/docs/usermanual/regular_expressions.html (original) +++ jmeter/trunk/docs/usermanual/regular_expressions.html Sun Jan 28 08:38:53 2018 @@ -638,7 +638,7 @@ without needing to access any external s <div class="copyright"> Copyright © 1999 – - 2017 + 2018 , Apache Software Foundation </div> <div class="trademarks">Apache, Apache JMeter, JMeter, the Apache Modified: jmeter/trunk/docs/usermanual/remote-test.html URL: http://svn.apache.org/viewvc/jmeter/trunk/docs/usermanual/remote-test.html?rev=1822450&r1=1822449&r2=1822450&view=diff ============================================================================== --- jmeter/trunk/docs/usermanual/remote-test.html (original) +++ jmeter/trunk/docs/usermanual/remote-test.html Sun Jan 28 08:38:53 2018 @@ -250,6 +250,8 @@ Make sure that all the nodes (client and <li>are running exactly the same version of JMeter.</li> <li>are using the same version of Java on all systems. Using different versions of Java may work but is discouraged.</li> + +<li>have a <a href="#setup_ssl">valid keystore for RMI over SSL</a>, or you have disabled the use of SSL.</li> </ul> @@ -363,7 +365,50 @@ The command-line client will exit when a </p> <div class="subsection"> -<h2 id="detail_instructions">13.1 Doing it Manually<a class="sectionlink" href="#detail_instructions" title="Link to here">¶</a> +<h2 id="setup_ssl">13.1 Setting up SSL<a class="sectionlink" href="#setup_ssl" title="Link to here">¶</a> +</h2> + +<div class="clear"></div> +<div class="note">Since JMeter 4.0 the default transport mechanism for RMI will use SSL. SSL needs keys and certificates to work. You will have to create those keys yourself.</div> +<div class="clear"></div> + +<p> +The simplest setup is to use one key/cert pair for all JMeter servers and clients you want to connect. JMeter comes with a script to generate a keystore that +contains one key (and its corresponding certificate) named <span class="code">rmi</span>. The script is located in the <span class="code">bin</span> directory and is available for Windows systems (called <span class="code">bin/create-rmi-keystore.bat</span>) and Unix like systems (called <span class="code">bin/create-rmi-keystore.sh</span>). It will generate a key-pair, that is valid for seven days, with a default passphrase of value '<span class="code">changeit</span>'. It is advised to call it from inside the <span class="code">bin</span> directory. +</p> + +<p> +When you run the script, it will ask you some questions about some names it will embed in the certificate. You can type in whatever you want, as long the keystore tool accepts it. That value has to match the property <span class="code">server.rmi.ssl.keystore.alias</span>, which defaults to <span class="code">rmi</span>. A sample session to create the keystore is shown below. +</p> + +<pre class="source">$ cd jmeter/bin +$ ./create-rmi-keystore.sh +What is your first and last name? + [Unknown]: rmi +What is the name of your organizational unit? + [Unknown]: My unit name +What is the name of your organization? + [Unknown]: My organisation name +What is the name of your City or Locality? + [Unknown]: Your City +What is the name of your State or Province? + [Unknown]: Your State +What is the two-letter country code for this unit? + [Unknown]: XY +Is CN=rmi, OU=My unit name, O=My organisation name, L=Your City, ST=Your State, C=XY correct? + [no]: yes + +Copy the generated rmi_keystore.jks to jmeter/bin folder or reference it in property 'server.rmi.ssl.keystore.file' +</pre> + +<p> +The <a href="properties_reference.html#remote">defaults settings for RMI</a> should work with this setup. Copy the file <span class="code">bin/rmi_keystore.jks</span> to every JMeter server and client you want to use for your distributed testing setup. +</p> + +</div> + +<div class="subsection"> +<h2 id="detail_instructions">13.2 Doing it Manually<a class="sectionlink" href="#detail_instructions" title="Link to here">¶</a> </h2> <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). @@ -415,7 +460,7 @@ Use the "<span class="code">-s</span>" o </div> <div class="subsection"> -<h2 id="tips">13.2 Tips<a class="sectionlink" href="#tips" title="Link to here">¶</a> +<h2 id="tips">13.3 Tips<a class="sectionlink" href="#tips" title="Link to here">¶</a> </h2> <p> @@ -482,7 +527,7 @@ in remote testing, since JMeter 2.6:</p> </div> <div class="subsection"> -<h2 id="portchange">13.3 Using a different port<a class="sectionlink" href="#portchange" title="Link to here">¶</a> +<h2 id="portchange">13.4 Using a different port<a class="sectionlink" href="#portchange" title="Link to here">¶</a> </h2> <p>By default, JMeter uses the standard RMI port <span class="code">1099</span>. It is possible to change this. For this to work successfully, @@ -524,7 +569,7 @@ The chosen port will be logged in the se <div class="subsection"> -<h2 id="sendermode">13.4 Using a different sample sender<a class="sectionlink" href="#sendermode" title="Link to here">¶</a> +<h2 id="sendermode">13.5 Using a different sample sender<a class="sectionlink" href="#sendermode" title="Link to here">¶</a> </h2> <p> @@ -689,7 +734,7 @@ This is not really a problem as there is <div class="subsection"> -<h2 id="retries">13.5 Dealing with nodes that failed starting<a class="sectionlink" href="#retries" title="Link to here">¶</a> +<h2 id="retries">13.6 Dealing with nodes that failed starting<a class="sectionlink" href="#retries" title="Link to here">¶</a> </h2> <p> @@ -745,7 +790,7 @@ This is not really a problem as there is <div class="copyright"> Copyright © 1999 – - 2017 + 2018 , Apache Software Foundation </div> <div class="trademarks">Apache, Apache JMeter, JMeter, the Apache Modified: jmeter/trunk/docs/usermanual/test_plan.html URL: http://svn.apache.org/viewvc/jmeter/trunk/docs/usermanual/test_plan.html?rev=1822450&r1=1822449&r2=1822450&view=diff ============================================================================== --- jmeter/trunk/docs/usermanual/test_plan.html (original) +++ jmeter/trunk/docs/usermanual/test_plan.html Sun Jan 28 08:38:53 2018 @@ -939,7 +939,7 @@ jmeter … -Jhost=www3.example.org <div class="copyright"> Copyright © 1999 – - 2017 + 2018 , Apache Software Foundation </div> <div class="trademarks">Apache, Apache JMeter, JMeter, the Apache Modified: jmeter/trunk/src/core/org/apache/jmeter/util/JMeterVersion.java URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/util/JMeterVersion.java?rev=1822450&r1=1822449&r2=1822450&view=diff ============================================================================== --- jmeter/trunk/src/core/org/apache/jmeter/util/JMeterVersion.java (original) +++ jmeter/trunk/src/core/org/apache/jmeter/util/JMeterVersion.java Sun Jan 28 08:38:53 2018 @@ -49,7 +49,7 @@ public final class JMeterVersion { * This ensures that JMeterUtils always gets the correct * version, even if JMeterUtils is not re-compiled during the build. */ - private static final String VERSION = "4.0-SNAPSHOT"; + private static final String VERSION = "4.0"; private static final String IMPLEMENTATION; Modified: jmeter/trunk/xdocs/download_jmeter.xml URL: http://svn.apache.org/viewvc/jmeter/trunk/xdocs/download_jmeter.xml?rev=1822450&r1=1822449&r2=1822450&view=diff ============================================================================== --- jmeter/trunk/xdocs/download_jmeter.xml (original) +++ jmeter/trunk/xdocs/download_jmeter.xml Sun Jan 28 08:38:53 2018 @@ -18,7 +18,7 @@ <!DOCTYPE document [ -<!ENTITY release '3.3'> +<!ENTITY release '4.0'> <!ENTITY hellip "…" > ]> Modified: jmeter/trunk/xdocs/overview.html URL: http://svn.apache.org/viewvc/jmeter/trunk/xdocs/overview.html?rev=1822450&r1=1822449&r2=1822450&view=diff ============================================================================== --- jmeter/trunk/xdocs/overview.html (original) +++ jmeter/trunk/xdocs/overview.html Sun Jan 28 08:38:53 2018 @@ -18,7 +18,7 @@ <!-- This file is copied into the Javadoc overview --> <html> <body> -This is the documentation for Apache JMeter version 3.3 API. -@version 3.3 +This is the documentation for Apache JMeter version 4.0 API. +@version 4.0 </body> </html> \ No newline at end of file
