You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jmeter.apache.org by fs...@apache.org on 2017/09/17 10:05:39 UTC
svn commit: r1808612 - /jmeter/trunk/xdocs/usermanual/component_reference.xml
Author: fschumacher
Date: Sun Sep 17 10:05:38 2017
New Revision: 1808612
URL: http://svn.apache.org/viewvc?rev=1808612&view=rev
Log:
Mostly uppercase/lowercase/mixedcase and markup changes. One 'num' to 'number'
Modified:
jmeter/trunk/xdocs/usermanual/component_reference.xml
Modified: jmeter/trunk/xdocs/usermanual/component_reference.xml
URL: http://svn.apache.org/viewvc/jmeter/trunk/xdocs/usermanual/component_reference.xml?rev=1808612&r1=1808611&r2=1808612&view=diff
==============================================================================
--- jmeter/trunk/xdocs/usermanual/component_reference.xml (original)
+++ jmeter/trunk/xdocs/usermanual/component_reference.xml Sun Sep 17 10:05:38 2017
@@ -666,7 +666,7 @@ This will not have any impact on existin
</properties>
</component>
<component name="LDAP Request" index="§-num;.1.7" width="621" height="462" screenshot="ldap_request.png">
- <description>This Sampler lets you send a different Ldap request(<code>Add</code>, <code>Modify</code>, <code>Delete</code> and <code>Search</code>) to an LDAP server.
+ <description>This Sampler lets you send a different LDAP request(<code>Add</code>, <code>Modify</code>, <code>Delete</code> and <code>Search</code>) to an LDAP server.
<p>If you are going to send multiple requests to the same LDAP server, consider
using an <complink name="LDAP Request Defaults"/>
Configuration Element so you do not have to enter the same information for each
@@ -745,7 +745,7 @@ This will not have any impact on existin
<property name="Server Name or IP" required="Yes">Domain name or IP address of the LDAP server.
JMeter assumes the LDAP server is listening on the default port (<code>389</code>).</property>
<property name="Port" required="Yes">Port to connect to (default is <code>389</code>).</property>
- <property name="root DN" required="Yes">Base DN to use for ldap operations</property>
+ <property name="root DN" required="Yes">Base DN to use for LDAP operations</property>
<property name="Username" required="Usually">LDAP server username.</property>
<property name="Password" required="Usually">LDAP server password. (N.B. this is stored unencrypted in the test plan)</property>
<property name="Entry DN" required="Yes, if User Defined Test and Add Test or Modify Test is selected">the name of the context to create or Modify; may not be empty.
@@ -761,7 +761,7 @@ This will not have any impact on existin
</properties>
<links>
- <link href="build-ldap-test-plan.html">Building an Ldap Test Plan</link>
+ <link href="build-ldap-test-plan.html">Building an LDAP Test Plan</link>
<complink name="LDAP Request Defaults"/>
</links>
@@ -833,7 +833,7 @@ This will not have any impact on existin
</dd>
<dt><b>Add test</b></dt>
<dd>
- <p>This is the ldap "<code>add</code>" operation. It can be used to add any kind of
+ <p>This is the LDAP "<code>add</code>" operation. It can be used to add any kind of
object to the LDAP server.</p>
<properties>
<property name="Name" required="No">Descriptive name for this sampler that is shown in the tree.</property>
@@ -913,7 +913,7 @@ This will not have any impact on existin
<center><h2>(Beta Code)</h2></center>
<description><p>AccessLogSampler was designed to read access logs and generate http requests.
For those not familiar with the access log, it is the log the webserver maintains of every
-request it accepted. This means every image, css file, javascript file, html file, …
+request it accepted. This means every image, CSS file, JavaScript file, html file, …
The current implementation is complete, but some features have not been enabled.
There is a filter for the access log parser, but I haven't figured out how to link to the pre-processor.
Once I do, changes to the sampler will be made to enable that functionality.</p>
@@ -1120,8 +1120,8 @@ Beware however that misuse of any method
</note>
<p>By default, JMeter supports the following languages:</p>
<ul>
- <li>javascript</li>
- <li>xslt</li>
+ <li>JavaScript</li>
+ <li>XSLT</li>
</ul>
<note>Unlike the BeanShell sampler, the interpreter is not saved between invocations.</note>
</description>
@@ -1129,7 +1129,7 @@ Beware however that misuse of any method
<property name="Name" required="No">Descriptive name for this sampler that is shown in the tree.</property>
<property name="Scripting Language" required="Yes">Name of the BSF scripting language to be used.
<note>N.B. Not all the languages in the drop-down list are supported by default.
- The following are supported: javascript, xslt.
+ The following are supported: JavaScript, XSLT.
Others may be available if the appropriate jar is installed in the JMeter lib directory.
</note>
</property>
@@ -1217,7 +1217,7 @@ To benefit from this feature:
</note>
</li>
</ul>
-Cache size is controlled by the following jmeter property (<code>jmeter.properties</code>):
+Cache size is controlled by the following JMeter property (<code>jmeter.properties</code>):
<source>jsr223.compiled_scripts_cache_size=100</source>
<note>Unlike the <complink name="BeanShell Sampler" />, the interpreter is not saved between invocations.</note>
<note>
@@ -1414,7 +1414,7 @@ Currently the only way to changes these
to create the connection.
</property>
<property name="JNDI Initial Context Factory" required="No">Name of the context factory</property>
- <property name="Provider URL" required="Yes, unless using jndi.properties">The URL for the jms provider</property>
+ <property name="Provider URL" required="Yes, unless using jndi.properties">The URL for the JMS provider</property>
<property name="Destination" required="Yes">The message destination (topic or queue name)</property>
<property name="Setup" required="Yes">The destination setup type. With <code>At startup</code>, the destination name is static (i.e. always same name during the test), with <code>Each sample</code>, the destination name is dynamic and is evaluate at each sample (i.e. the destination name may be a variable)</property>
<property name="Authentication" required="Yes">Authentication requirement for the JMS provider</property>
@@ -1521,7 +1521,7 @@ The following table shows some values wh
to create the connection.
</property>
<property name="JNDI Initial Context Factory" required="No">Name of the context factory</property>
- <property name="Provider URL" required="No">The URL for the jms provider</property>
+ <property name="Provider URL" required="No">The URL for the JMS provider</property>
<property name="Destination" required="Yes">the message destination (topic or queue name)</property>
<property name="Durable Subscription ID" required="No">The ID to use for a durable subscription. On first
use the respective queue will automatically be generated by the JMS provider if it does not exist yet.</property>
@@ -1669,7 +1669,7 @@ The following table shows some values wh
The JNDI Properties are the specific properties for the underlying JNDI implementation.
</property>
<property name="Provider URL" required="No">
- The URL for the jms provider.
+ The URL for the JMS provider.
</property>
</properties>
</component>
@@ -2244,17 +2244,17 @@ Please refer to the <complink name="Cons
By default, the condition is evaluated only once on initial entry, but you have the option to have it evaluated for every runnable element contained in the controller.
</p>
<p>
- The script can be processed as a variable expression, rather than requiring Javascript.
- It was always possible to use functions and variables in the Javascript condition, so long as they evaluated to "<code>true</code>" or "<code>false</code>";
- now this can be done without the overhead of using Javascript as well. For example, previously one could use the condition:
- <code>${__jexl3(${VAR} == 23)}</code> and this would be evaluated as <code>true</code>/<code>false</code>, the result would then be passed to Javascript
+ The script can be processed as a variable expression, rather than requiring JavaScript.
+ It was always possible to use functions and variables in the JavaScript condition, so long as they evaluated to "<code>true</code>" or "<code>false</code>";
+ now this can be done without the overhead of using JavaScript as well. For example, previously one could use the condition:
+ <code>${__jexl3(${VAR} == 23)}</code> and this would be evaluated as <code>true</code>/<code>false</code>, the result would then be passed to JavaScript
which would then return <code>true</code>/<code>false</code>. If the Variable Expression option is selected, then the expression is evaluated
- and compared with "<code>true</code>", without needing to use Javascript.
+ and compared with "<code>true</code>", without needing to use JavaScript.
Also, variable expressions can return any value, whereas the
- Javascript condition must return "<code>true</code>"/"<code>false</code>" or an error is logged.
+ JavaScript condition must return "<code>true</code>"/"<code>false</code>" or an error is logged.
</p>
<note>
- No variables are made available to the script when the condition is interpreted as Javascript.
+ No variables are made available to the script when the condition is interpreted as JavaScript.
If you need access to such variables, then select "<code>Interpret Condition as Variable Expression?</code>" and use
a <code><funclink name="__jexl3"/></code>, <code><funclink name="__groovy"/></code> or <code><funclink name="__javaScript()"/></code> (discouraged for performance) function call. You can then use the objects "<code>vars</code>", "<code>log</code>", "<code>ctx</code>" etc. in the script.
</note>
@@ -2268,11 +2268,11 @@ Please refer to the <complink name="Cons
</description>
<properties>
<property name="Name" required="No">Descriptive name for this controller that is shown in the tree.</property>
- <property name="Condition (default Javascript)" required="Yes">By default the condition is interpreted as <b>Javascript</b> code that returns "<code>true</code>" or "<code>false</code>",
+ <property name="Condition (default JavaScript)" required="Yes">By default the condition is interpreted as <b>JavaScript</b> code that returns "<code>true</code>" or "<code>false</code>",
but this can be overridden (see below)</property>
<property name="Interpret Condition as Variable Expression?" required="Yes">If this is selected, then the condition must be an expression that evaluates to "<code>true</code>" (case is ignored).
For example, <code>${FOUND}</code> or <code>${__jexl3(${VAR} > 100)}</code>.
- Unlike the Javascript case, the condition is only checked to see if it matches "<code>true</code>" (case is ignored).
+ Unlike the JavaScript case, the condition is only checked to see if it matches "<code>true</code>" (case is ignored).
<note>Checking this and using <code><funclink name="__jexl3"/></code> or <code><funclink name="__groovy"/></code> function in Condition is advised for performances</note>
</property>
<property name="Evaluate for all children" required="Yes">
@@ -2280,13 +2280,13 @@ Please refer to the <complink name="Cons
If not checked, then the condition is only evaluated on entry.
</property>
</properties>
- <example title="Examples (Javascript)" anchor="example_if_javascript">
+ <example title="Examples (JavaScript)" anchor="example_if_javascript">
<ul>
<li><code>${COUNT} < 10</code></li>
<li><code>"${VAR}" == "abcd"</code></li>
</ul>
If there is an error interpreting the code, the condition is assumed to be <code>false</code>, and a message is logged in <code>jmeter.log</code>.
- <note>Note it is advised to avoid using Javascript mode for performances</note>
+ <note>Note it is advised to avoid using JavaScript mode for performances</note>
</example>
<example title="Examples (Variable Expression)" anchor="example_if_variable">
<ul>
@@ -2485,7 +2485,7 @@ otherwise a duplicate may be accidentall
<component name="Include Controller" index="§-num;.2.14" width="417" height="130" screenshot="includecontroller.png">
<description>
<p>
-The include controller is designed to use an external jmx file. To use it, create a Test Fragment
+The include controller is designed to use an external JMX file. To use it, create a Test Fragment
underneath the Test Plan and add any desired samplers, controllers etc. below it.
Then save the Test Plan. The file is now ready to be included as part of other Test Plans.
</p>
@@ -3039,7 +3039,7 @@ the graph as a PNG file.</description>
</p>
<figure width="1147" height="420" image="aggregate_graph_settings.png">Aggregate graph settings</figure>
</div>
-<note>Please note: All this parameters <em>aren't</em> saved in JMeter jmx script.</note>
+<note>Please note: All this parameters <em>aren't</em> saved in JMeter JMX script.</note>
<properties>
<property name="Column settings" required="Yes">
<ul>
@@ -3077,7 +3077,7 @@ If many samples exist for the same times
</div>
<note>Please note: All this parameters are saved in JMeter <code>.jmx</code> file.</note>
<properties>
- <property name="Interval (ms)" required="Yes">The time in milli-seconds for X axis interval. Samples are grouped according to this value.
+ <property name="Interval (ms)" required="Yes">The time in milliseconds for X axis interval. Samples are grouped according to this value.
Before display the graph, click on <code>Apply interval</code> button to refresh internal data.</property>
<property name="Sampler label selection" required="No">Filter by result label. A regular expression can be used, ex. <code>.*Transaction.*</code>.
Before display the graph, click on <code>Apply filter</code> button to refresh internal data.</property>
@@ -3572,7 +3572,7 @@ By default, a Graphite implementation is
<property name="Name" required="">Descriptive name for this element that is shown in the tree.</property>
<property name="Filename" required="Yes">Name of the file to be read.
<b>Relative file names are resolved with respect to the path of the active test plan.</b>
- <b>For distributed testing, the CSV file must be stored on the server host system in the correct relative directory to where the jmeter server is started.</b>
+ <b>For distributed testing, the CSV file must be stored on the server host system in the correct relative directory to where the JMeter server is started.</b>
Absolute file names are also supported, but note that they are unlikely to work in remote mode,
unless the remote server has the same directory structure.
If the same physical file is referenced in two different ways - e.g. <code>csvdata.txt</code> and <code>./csvdata.txt</code> -
@@ -3630,19 +3630,19 @@ By default, a Graphite implementation is
if you want to use this mapping.
</p>
<example title="Usage of static host table" anchor="static_host_table">
- <p>Say, you have a test server, that you want to reach with a name, that is not (yet) set up in your dns servers.
+ <p>Say, you have a test server, that you want to reach with a name, that is not (yet) set up in your DNS servers.
For our example, this would be <code>www.example.com</code> for the server name, which you want to reach at the
- ip of the server <code>a123.another.example.org</code>.
+ IP of the server <code>a123.another.example.org</code>.
</p>
<p>You could change your workstation and add an entry to your <code>/etc/hosts</code> file - or the equivalent for
your OS, or add an entry to the Static Host Table of the DNS Cache Manager.
</p>
<p>You would type <code>www.example.com</code> into the first column (<code>Host</code>) and
<code>a123.another.example.org</code> into the second column (<code>Hostname or IP address</code>).
- As the name of the second column implies, you could even use the ip address of your test server there.
+ As the name of the second column implies, you could even use the IP address of your test server there.
</p>
- <p>The ip address for the test server will be looked up by using the custom dns resolver. When none is given, the
- system dns resolver will be used.
+ <p>The IP address for the test server will be looked up by using the custom DNS resolver. When none is given, the
+ system DNS resolver will be used.
</p>
<p>Now you can use <code>www.example.com</code> in your HTTPClient4 samplers and the requests will be made against
<code>a123.another.example.org</code> with all headers set to <code>www.example.com</code>.
@@ -3729,14 +3729,14 @@ The Realm only applies to the HttpClient
</ul>
<p>
You can also configure those two properties in the file <code>bin/system.properties</code>.
-Look at the two sample configuration files (<code>krb5.conf</code> and <code>jaas.conf</code>) located in the jmeter <code>bin</code> folder
+Look at the two sample configuration files (<code>krb5.conf</code> and <code>jaas.conf</code>) located in the JMeter <code>bin</code> folder
for references to more documentation, and tweak them to match your Kerberos configuration.
</p>
<p>
When generating a SPN for Kerberos SPNEGO authentication IE and Firefox will omit the port number
from the URL. Chrome has an option (<code>--enable-auth-negotiate-port</code>) to include the port
number if it differs from the standard ones (<code>80</code> and <code>443</code>). That behavior
-can be emulated by setting the following jmeter property as below.
+can be emulated by setting the following JMeter property as below.
</p>
<p>
In <code>jmeter.properties</code> or <code>user.properties</code>, set:
@@ -3784,7 +3784,7 @@ be able to run it. However, you can use
<p>
The HTTP Cache Manager is used to add caching functionality to HTTP requests within its scope to simulate browser cache feature.
Each Virtual User thread has its own Cache. By default, Cache Manager will store up to 5000 items in cache per Virtual User thread, using LRU algorithm.
-Use property "<code>maxSize</code>" to modify this value. Note that the more you increase this value the more HTTP Cache Manager will consume memory, so be sure to adapt the <code>-Xmx</code> jvm option accordingly.
+Use property "<code>maxSize</code>" to modify this value. Note that the more you increase this value the more HTTP Cache Manager will consume memory, so be sure to adapt the <code>-Xmx</code> JVM option accordingly.
</p>
<p>
If a sample is successful (i.e. has response code <code>2xx</code>) then the <code>Last-Modified</code> and <code>Etag</code> (and <code>Expired</code> if relevant) values are saved for the URL.
@@ -3900,7 +3900,7 @@ All port values are treated equally; a s
<properties>
<property name="Name" required="No">Descriptive name for this element that is shown in the tree.</property>
- <property name="Server" required="No">Domain name or IP address of the web server. e.g. <code>www.example.com</code>. [Do not include the <code>http://</code> prefix.</property>
+ <property name="Server" required="No">Domain name or IP address of the web server. E.g. <code>www.example.com</code>. [Do not include the <code>http://</code> prefix.</property>
<property name="Port" required="No">Port the web server is listening to.</property>
<property name="Connect Timeout" required="No">Connection Timeout. Number of milliseconds to wait for a connection to open.</property>
<property name="Response Timeout" required="No">Response Timeout. Number of milliseconds to wait for a response.</property>
@@ -4215,7 +4215,7 @@ To make JMeter use more than one certifi
<property name="Re-use connection" required="Yes">If selected, the connection is kept open. Otherwise it is closed when the data has been read.</property>
<property name="Close connection" required="Yes">If selected, the connection will be closed after running the sampler.</property>
<property name="SO_LINGER" required="No">Enable/disable <code>SO_LINGER</code> with the specified linger time in seconds when a socket is created. If you set "<code>SO_LINGER</code>" value as <code>0</code>, you may prevent large numbers of sockets sitting around with a <code>TIME_WAIT</code> status.</property>
- <property name="End of line(EOL) byte value" required="No">Byte value for end of line, set this to a value outside the range <code>-128</code> to <code>+127</code> to skip eol checking. You may set this in <code>jmeter.properties</code> file as well with the <code>tcp.eolByte</code> property. If you set this in TCP Sampler Config and in <code>jmeter.properties</code> file at the same time, the setting value in the TCP Sampler Config will be used.</property>
+ <property name="End of line(EOL) byte value" required="No">Byte value for end of line, set this to a value outside the range <code>-128</code> to <code>+127</code> to skip EOL checking. You may set this in <code>jmeter.properties</code> file as well with the <code>tcp.eolByte</code> property. If you set this in TCP Sampler Config and in <code>jmeter.properties</code> file at the same time, the setting value in the TCP Sampler Config will be used.</property>
<property name="Connect Timeout" required="No">Connect Timeout (milliseconds, 0 disables).</property>
<property name="Response Timeout" required="No">Response Timeout (milliseconds, 0 disables).</property>
<property name="Set Nodelay" required="">Should the nodelay property be set?</property>
@@ -4869,7 +4869,7 @@ The JSR223 Assertion allows JSR223 scrip
<li><code>args</code> - String array containing parameters, split on white-space</li>
</ul></property>
<property name="Script file" required="No">A file containing the script to run, if a relative file path is used, then it will be relative to directory referenced by "<code>user.dir</code>" System property</property>
- <property name="Script compilation caching" required="No">Unique String across Test Plan that JMeter will use to cache result of Script compilation if language used supports <code><a href="https://docs.oracle.com/javase/8/docs/api/javax/script/Compilable.html">Compilable</a></code> interface (Groovy is one of these, java, beanshell and javascript are not)
+ <property name="Script compilation caching" required="No">Unique String across Test Plan that JMeter will use to cache result of Script compilation if language used supports <code><a href="https://docs.oracle.com/javase/8/docs/api/javax/script/Compilable.html">Compilable</a></code> interface (Groovy is one of these, java, BeanShell and JavaScript are not)
<note>See note in JSR223 Sampler Java System property if you're using Groovy without checking this option</note>
</property>
<property name="Script" required="Yes (unless script file is provided)">The script to run.</property>
@@ -5367,7 +5367,7 @@ If using distributed testing, ensure you
<p>User Variables can also be specified in the Test Plan but not specific to individual threads. This panel allows
you to specify a series of values for any User Variable. For each thread, the variable will be assigned one of the values from the series
in sequence. If there are more threads than values, the values get re-used. For example, this can be used to assign a distinct
-user id to be used by each thread. User variables can be referenced in any field of any jMeter Component.</p>
+user id to be used by each thread. User variables can be referenced in any field of any JMeter Component.</p>
<p>The variable is specified by clicking the <code>Add Variable</code> button in the bottom of the panel and filling in the Variable name in the '<code>Name:</code>' column.
To add a new value to the series, click the '<code>Add User</code>' button and fill in the desired value in the newly added column.</p>
@@ -5842,7 +5842,7 @@ extracting the node as text or attribute
<li><code>refName</code> - always set to the default value</li>
</ul>
<p>
- Note that the refName variable is always set to the default value in this case.
+ Note that the <code>refName</code> variable is always set to the default value in this case.
</p>
</component>
@@ -6209,7 +6209,7 @@ See <a href="get-started.html#classpath"
<component name="Thread Group" index="§-num;.9.2" width="706" height="407" screenshot="threadgroup.png">
<description>
-<p>A Thread Group defines a pool of users that will execute a particular test case against your server. In the Thread Group GUI, you can control the number of users simulated (num of threads), the ramp up time (how long it takes to start all the threads), the number of times to perform the test, and optionally, a start and stop time for the test.</p>
+<p>A Thread Group defines a pool of users that will execute a particular test case against your server. In the Thread Group GUI, you can control the number of users simulated (number of threads), the ramp up time (how long it takes to start all the threads), the number of times to perform the test, and optionally, a start and stop time for the test.</p>
<p>
See also <complink name="tearDown Thread Group"/> and <complink name="setUp Thread Group"/>.
</p>
@@ -6434,7 +6434,7 @@ As a consequence:
You will need to accept the certificate in order to allow the JMeter Proxy to intercept the SSL traffic in order to
record it.
However, do not accept this certificate permanently; it should only be accepted temporarily.
-Browsers only prompt this dialogue for the certificate of the main url, not for the resources loaded in the page, such as images, css or javascript files hosted on a secured external CDN.
+Browsers only prompt this dialogue for the certificate of the main URL, not for the resources loaded in the page, such as images, CSS or JavaScript files hosted on a secured external CDN.
If you have such resources (gmail has for example), you'll have to first browse manually to these other domains in order to accept JMeter's certificate for them.
Check in <code>jmeter.log</code> for secure domains that you need to register certificate for.
</li>