<?xml version="1.0"?>
<!--
  ~ Licensed to the Apache Software Foundation (ASF) under one or more
  ~ contributor license agreements.  See the NOTICE file distributed with
  ~ this work for additional information regarding copyright ownership.
  ~ The ASF licenses this file to you under the Apache License, Version 2.0
  ~ (the "License"); you may not use this file except in compliance with
  ~ the License.  You may obtain a copy of the License at
  ~
  ~ http://www.apache.org/licenses/LICENSE-2.0
  ~
  ~ Unless required by applicable law or agreed to in writing, software
  ~ distributed under the License is distributed on an "AS IS" BASIS,
  ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  ~ See the License for the specific language governing permissions and
  ~ limitations under the License.
  -->

<!DOCTYPE document
[
<!ENTITY sect-num '12'>
<!ENTITY hellip   "&#x02026;" >
<!ENTITY le       "&#x02264;" >
<!ENTITY nbsp     "&#x000A0;" >
<!ENTITY vellip   "&#x022EE;" >
]>

<document prev="build-jms-topic-test-plan.html" next="remote-test.html" id="$Id$">

<properties>
  <title>User's Manual: Listeners</title>
</properties>

<body>

<section name="&sect-num;. Introduction to listeners" anchor="intro">
<p>A listener is a component that shows the results of the
samples. The results can be shown in a tree, tables, graphs or simply written to a log
file. To view the contents of a response from any given sampler, add either of the Listeners "<code>View
Results Tree</code>" or "<code>View Results in table</code>" to a test plan. To view the response time graphically, add
graph results.
The <complink name="listeners">Listeners</complink>
section of the components page has full descriptions of all the listeners.</p>

<note>
Different listeners display the response information in different ways.
However, they all write the same raw data to the output file - if one is specified.
</note>
<p>
The "<code>Configure</code>" button can be used to specify which fields to write to the file, and whether to
write it as CSV or XML.
CSV files are much smaller than XML files, so use CSV if you are generating lots of samples.
</p>
<p>
The file name can be specified using either a relative or an absolute path name.
Relative paths are resolved relative to the current working directory (which defaults to the <code>bin/</code> directory).
JMeter also supports paths relative to the directory containing the current test plan (JMX file).
If the path name begins with "<code>~/</code>" (or whatever is in the <code>jmeter.save.saveservice.base_prefix</code> JMeter property),
then the path is assumed to be relative to the JMX file location.
</p>
<p>
If you only wish to record certain samples, add the Listener as a child of the sampler.
Or you can use a Simple Controller to group a set of samplers, and add the Listener to that.
The same filename can be used by multiple samplers - but make sure they all use the same configuration!
</p>
</section>

<section name="&sect-num;.1 Default Configuration" anchor="defaults">
<p>
The default items to be saved can be defined in the <code>jmeter.properties</code> (or <code>user.properties</code>) file.
The properties are used as the initial settings for the Listener Config pop-up, and are also
used for the log file specified by the <code>-l</code> command-line flag (commonly used for CLI mode test runs).
</p>
<p>To change the default format, find the following line in <code>jmeter.properties</code>:</p>
<source>jmeter.save.saveservice.output_format=</source>
<p>
The information to be saved is configurable.  For maximum information, choose "<code>xml</code>" as the format and specify "<code>Functional Test Mode</code>" on the Test Plan element.  If this box is not checked, the default saved
data includes a time stamp (the number of milliseconds since midnight,
January 1, 1970 UTC), the data type, the thread name, the label, the
response time, message, and code, and a success indicator.  If checked, all information, including the full response data will be logged.</p>
<p>
The following example indicates how to set
properties to get a vertical bar ("<code>|</code>") delimited format that will
output results like:.</p>
<source>
timeStamp|time|label|responseCode|threadName|dataType|success|failureMessage
02/06/03 08:21:42|1187|Home|200|Thread Group-1|text|true|
02/06/03 08:21:42|47|Login|200|Thread Group-1|text|false|Test Failed:
    expected to contain: password etc.
</source>
<p>
The corresponding <code>jmeter.properties</code> that need to be set are shown below.  One oddity
in this example is that the <code>output_format</code> is set to <code>csv</code>, which
typically
indicates comma-separated values.  However, the <code>default_delimiter</code> was
set to be a vertical bar instead of a comma, so the csv tag is a
misnomer in this case. (Think of CSV as meaning character separated values)</p>
<source>
jmeter.save.saveservice.output_format=csv
jmeter.save.saveservice.assertion_results_failure_message=true
jmeter.save.saveservice.default_delimiter=|
</source>
<p>
The full set of properties that affect result file output is shown below.
</p>
<source>
#---------------------------------------------------------------------------
# Results file configuration
#---------------------------------------------------------------------------

# This section helps determine how result data will be saved.
# The commented out values are the defaults.

# legitimate values: xml, csv, db.  Only xml and csv are currently supported.
#jmeter.save.saveservice.output_format=csv


# true when field should be saved; false otherwise

# assertion_results_failure_message only affects CSV output
#jmeter.save.saveservice.assertion_results_failure_message=true
#
# legitimate values: none, first, all
#jmeter.save.saveservice.assertion_results=none
#
#jmeter.save.saveservice.data_type=true
#jmeter.save.saveservice.label=true
#jmeter.save.saveservice.response_code=true
# response_data is not currently supported for CSV output
#jmeter.save.saveservice.response_data=false
# Save ResponseData for failed samples
#jmeter.save.saveservice.response_data.on_error=false
#jmeter.save.saveservice.response_message=true
#jmeter.save.saveservice.successful=true
#jmeter.save.saveservice.thread_name=true
#jmeter.save.saveservice.time=true
#jmeter.save.saveservice.subresults=true
#jmeter.save.saveservice.assertions=true
#jmeter.save.saveservice.latency=true
#jmeter.save.saveservice.connect_time=true
#jmeter.save.saveservice.samplerData=false
#jmeter.save.saveservice.responseHeaders=false
#jmeter.save.saveservice.requestHeaders=false
#jmeter.save.saveservice.encoding=false
#jmeter.save.saveservice.bytes=true
#jmeter.save.saveservice.sent_bytes=true
#jmeter.save.saveservice.url=false
#jmeter.save.saveservice.filename=false
#jmeter.save.saveservice.hostname=false
#jmeter.save.saveservice.thread_counts=true
#jmeter.save.saveservice.sample_count=false
#jmeter.save.saveservice.idle_time=true

# Timestamp format - this only affects CSV output files
# legitimate values: none, ms, or a format suitable for SimpleDateFormat
#jmeter.save.saveservice.timestamp_format=ms
#jmeter.save.saveservice.timestamp_format=yyyy/MM/dd HH:mm:ss.SSS

# For use with Comma-separated value (CSV) files or other formats
# where the fields' values are separated by specified delimiters.
# Default:
#jmeter.save.saveservice.default_delimiter=,
# For TAB, since JMeter 2.3 one can use:
#jmeter.save.saveservice.default_delimiter=\t

# Only applies to CSV format files:
# Print field names as first line in CSV
#jmeter.save.saveservice.print_field_names=true

# Optional list of JMeter variable names whose values are to be saved in the result data files.
# Use commas to separate the names. For example:
#sample_variables=SESSION_ID,REFERENCE
# N.B. The current implementation saves the values in XML as attributes,
# so the names must be valid XML names.
# JMeter sends the variable to all servers
# to ensure that the correct data is available at the client.

# Optional xml processing instruction for line 2 of the file:
#jmeter.save.saveservice.xml_pi=&lt;?xml-stylesheet type="text/xsl" href="sample.xsl"?&gt;

# Prefix used to identify filenames that are relative to the current base
#jmeter.save.saveservice.base_prefix=~/

# AutoFlush on each line written in XML or CSV output
# Setting this to true will result in less test results data loss in case of Crash
# but with impact on performances, particularly for intensive tests (low or no pauses)
# Since JMeter 2.10, this is false by default
#jmeter.save.saveservice.autoflush=false

# Put the start time stamp in logs instead of the end
sampleresult.timestamp.start=true

# Whether to use System.nanoTime() - otherwise only use System.currentTimeMillis()
#sampleresult.useNanoTime=true

# Use a background thread to calculate the nanoTime offset
# Set this to &le;&nbsp;0 to disable the background thread
#sampleresult.nanoThreadSleep=5000
</source>
<p>
The date format to be used for the <code>timestamp_format</code> is described in <a
HREF="http://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html">
<b>SimpleDateFormat</b></a>.
The timestamp format is used for both writing and reading files.
If the format is set to "<code>ms</code>", and the column does not parse as a long integer,
JMeter (2.9+) will try the following formats:
<ul>
<li><code>yyyy/MM/dd HH:mm:ss.SSS</code></li>
<li><code>yyyy/MM/dd HH:mm:ss</code></li>
<li><code>yyyy-MM-dd HH:mm:ss.SSS</code></li>
<li><code>yyyy-MM-dd HH:mm:ss</code></li>
<li><code>MM/dd/yy HH:mm:ss</code> (this is for compatibility with previous versions; it is not recommended as a format)</li>
</ul>
Matching is now also strict (non-lenient).
JMeter 2.8 and earlier used lenient mode which could result in timestamps with incorrect dates
(times were usually correct).</p>
<subsection name="&sect-num;.1.1 Sample Variables" anchor="sample_variables">
<p>
JMeter supports the <code>sample_variables</code>
property to define a list of additional JMeter variables which are to be saved with
each sample in the JTL files. The values are written to CSV files as additional columns,
and as additional attributes in XML files. See above for an example.
</p>
</subsection>

<subsection name="&sect-num;.1.2 Sample Result Save Configuration" anchor="sample_configuration">
<p>
Listeners can be configured to save different items to the result log files (JTL) by using the Config popup as shown below.
The defaults are defined as described in  the <a href="#defaults">Listener Default Configuration</a> section above.
Items with (CSV) after the name only apply to the CSV format; items with (XML) only apply to XML format.
CSV format cannot currently be used to save any items that include line-breaks.
</p>
<figure image="sample_result_config.png"><br/><b>Configuration dialogue</b></figure>
</subsection>
<p>
Note that cookies, method and the query string are saved as part of the "<code>Sampler Data</code>" option.
</p>
</section>

<section name="&sect-num;.2 CLI mode (batch) test runs" anchor="batch">
<p>
When running in CLI mode, the <code>-l</code> flag can be used to create a top-level listener for the test run.
This is in addition to any Listeners defined in the test plan.
The configuration of this listener is controlled by entries in the file <code>jmeter.properties</code>
as described in the previous section.
</p>
<p>
This feature can be used to specify different data and log files for each test run, for example:
</p>
<source>
jmeter -n -t testplan.jmx -l testplan_01.jtl -j testplan_01.log
jmeter -n -t testplan.jmx -l testplan_02.jtl -j testplan_02.log
</source>
<p>
Note that JMeter logging messages are written to the file <code>jmeter.log</code> by default.
This file is recreated each time, so if you want to keep the log files for each run,
you will need to rename it using the <code>-j</code> option as above.
</p>
<p>JMeter supports variables in the log file name.
If the filename contains  paired single-quotes, then the name is processed
as a <code>SimpleDateFormat</code> format applied to the current date, for example:
<code>log_file='jmeter_'yyyyMMddHHmmss'.tmp'</code>.
This can be used to generate a unique name for each test run.
</p>
</section>

<section name="&sect-num;.3 Resource usage" anchor="resources">
<note> Listeners can use a lot of memory if there are a lot of samples.</note>
<p>
Most of the listeners currently keep a copy of every sample they display, apart from:
</p>
<ul>
<li>Simple Data Writer</li>
<li>BeanShell/JSR223 Listener</li>
<li>Mailer Visualizer</li>
<li>Monitor Results</li>
<li>Summary Report</li>
</ul>
<p>
The following Listeners no longer need to keep copies of every single sample.
Instead, samples with the same elapsed time are aggregated.
Less memory is now needed, especially if most samples only take a second or two at most.
</p>
<ul>
<li>Aggregate Report</li>
<li>Aggregate Graph</li>
</ul>
<p>To minimize the amount of memory needed, use the Simple Data Writer, and use the CSV format.</p>
</section>

<section name="&sect-num;.4 CSV Log format" anchor="csvlogformat">
<p>
The CSV log format depends on which data items are selected in the configuration.
Only the specified data items are recorded in the file.
The order of appearance of columns is fixed, and is as follows:
</p>
<ul>
<li><code>timeStamp</code> - in milliseconds since 1/1/1970</li>
<li><code>elapsed</code> - in milliseconds</li>
<li><code>label</code> - sampler label</li>
<li><code>responseCode</code> - e.g. <code>200</code>, <code>404</code></li>
<li><code>responseMessage</code> - e.g. <code>OK</code></li>
<li><code>threadName</code></li>
<li><code>dataType</code> - e.g. <code>text</code></li>
<li><code>success</code> - <code>true</code> or <code>false</code></li>
<li><code>failureMessage</code> - if any</li>
<li><code>bytes</code> - number of bytes in the sample</li>
<li><code>sentBytes</code> - number of bytes sent for the sample</li>
<li><code>grpThreads</code> - number of active threads in this thread group</li>
<li><code>allThreads</code> - total number of active threads in all groups</li>
<li><code>URL</code></li>
<li><code>Filename</code> - if <code>Save Response to File</code> was used</li>
<li><code>latency</code> - time to first response</li>
<li><code>connect</code> - time to establish connection</li>
<li><code>encoding</code></li>
<li><code>SampleCount</code> - number of samples (1, unless multiple samples are aggregated)</li>
<li><code>ErrorCount</code> - number of errors (0 or 1, unless multiple samples are aggregated)</li>
<li><code>Hostname</code> - where the sample was generated</li>
<li><code>IdleTime</code> - number of milliseconds of 'Idle' time (normally 0)</li>
<li><code>Variables</code>, if specified</li>
</ul>

</section>

<section name="&sect-num;.5 XML Log format 2.1" anchor="xmlformat2.1">
<p>
The format of the updated XML (2.1) is as follows (line breaks will be different):
</p>
<source>
&lt;?xml version="1.0" encoding="UTF-8"?&gt;
&lt;testResults version="1.2"&gt;

-- HTTP Sample, with nested samples

&lt;httpSample t="1392" lt="351" ts="1144371014619" s="true"
     lb="HTTP Request" rc="200" rm="OK"
     tn="Listen 1-1" dt="text" de="iso-8859-1" by="12407"&gt;
  &lt;httpSample t="170" lt="170" ts="1144371015471" s="true"
        lb="http://www.apache.org/style/style.css" rc="200" rm="OK"
        tn="Listen 1-1" dt="text" de="ISO-8859-1" by="1002"&gt;
    &lt;responseHeader class="java.lang.String"&gt;HTTP/1.1 200 OK
Date: Fri, 07 Apr 2006 00:50:14 GMT
&vellip;
Content-Type: text/css
&lt;/responseHeader&gt;
    &lt;requestHeader class="java.lang.String"&gt;MyHeader: MyValue&lt;/requestHeader&gt;
    &lt;responseData class="java.lang.String"&gt;body, td, th {
    font-size: 95%;
    font-family: Arial, Geneva, Helvetica, sans-serif;
    color: black;
    background-color: white;
}
&vellip;
&lt;/responseData&gt;
    &lt;cookies class="java.lang.String"&gt;&lt;/cookies&gt;
    &lt;method class="java.lang.String"&gt;GET&lt;/method&gt;
    &lt;queryString class="java.lang.String"&gt;&lt;/queryString&gt;
    &lt;url&gt;http://www.apache.org/style/style.css&lt;/url&gt;
  &lt;/httpSample&gt;
  &lt;httpSample t="200" lt="180" ts="1144371015641" s="true"
     lb="http://www.apache.org/images/asf_logo_wide.gif"
     rc="200" rm="OK" tn="Listen 1-1" dt="bin" de="ISO-8859-1" by="5866"&gt;
    &lt;responseHeader class="java.lang.String"&gt;HTTP/1.1 200 OK
Date: Fri, 07 Apr 2006 00:50:14 GMT
&vellip;
Content-Type: image/gif
&lt;/responseHeader&gt;
    &lt;requestHeader class="java.lang.String"&gt;MyHeader: MyValue&lt;/requestHeader&gt;
    &lt;responseData class="java.lang.String"&gt;http://www.apache.org/asf.gif&lt;/responseData&gt;
      &lt;responseFile class="java.lang.String"&gt;Mixed1.html&lt;/responseFile&gt;
    &lt;cookies class="java.lang.String"&gt;&lt;/cookies&gt;
    &lt;method class="java.lang.String"&gt;GET&lt;/method&gt;
    &lt;queryString class="java.lang.String"&gt;&lt;/queryString&gt;
    &lt;url&gt;http://www.apache.org/asf.gif&lt;/url&gt;
  &lt;/httpSample&gt;
  &lt;responseHeader class="java.lang.String"&gt;HTTP/1.1 200 OK
Date: Fri, 07 Apr 2006 00:50:13 GMT
&vellip;
Content-Type: text/html; charset=ISO-8859-1
&lt;/responseHeader&gt;
  &lt;requestHeader class="java.lang.String"&gt;MyHeader: MyValue&lt;/requestHeader&gt;
  &lt;responseData class="java.lang.String"&gt;&lt;!DOCTYPE html PUBLIC &quot;-//W3C//DTD XHTML 1.0 Transitional//EN&quot;
               &quot;http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd&quot;&gt;
&vellip;
&lt;html&gt;
 &lt;head&gt;
&vellip;
 &lt;/head&gt;
 &lt;body&gt;
&vellip;
 &lt;/body&gt;
&lt;/html&gt;
&lt;/responseData&gt;
  &lt;cookies class="java.lang.String"&gt;&lt;/cookies&gt;
  &lt;method class="java.lang.String"&gt;GET&lt;/method&gt;
  &lt;queryString class="java.lang.String"&gt;&lt;/queryString&gt;
  &lt;url&gt;http://www.apache.org/&lt;/url&gt;
&lt;/httpSample&gt;

-- non HTTP Sample

&lt;sample t="0" lt="0" ts="1144372616082" s="true" lb="Example Sampler"
    rc="200" rm="OK" tn="Listen 1-1" dt="text" de="ISO-8859-1" by="10"&gt;
  &lt;responseHeader class="java.lang.String"&gt;&lt;/responseHeader&gt;
  &lt;requestHeader class="java.lang.String"&gt;&lt;/requestHeader&gt;
  &lt;responseData class="java.lang.String"&gt;Listen 1-1&lt;/responseData&gt;
  &lt;responseFile class="java.lang.String"&gt;Mixed2.unknown&lt;/responseFile&gt;
  &lt;samplerData class="java.lang.String"&gt;ssssss&lt;/samplerData&gt;
&lt;/sample&gt;

&lt;/testResults&gt;
</source>
<p>
Note that the sample node name may be either "<code>sample</code>" or "<code>httpSample</code>".
</p>
</section>

<section name="&sect-num;.6 XML Log format 2.2" anchor="xmlformat2.2">
<p>
The format of the JTL files is identical for 2.2 and 2.1. Format 2.2 only affects JMX files.
</p>
</section>

<section name="&sect-num;.7 Sample Attributes" anchor="attributes">
<p>
The sample attributes have the following meaning:
</p>
<table>
<tr><th>Attribute</th><th>Content</th></tr>
<tr><td><code>by</code></td><td>Bytes</td></tr>
<tr><td><code>sby</code></td><td>Sent Bytes</td></tr>
<tr><td><code>de</code></td><td>Data encoding</td></tr>
<tr><td><code>dt</code></td><td>Data type</td></tr>
<tr><td><code>ec</code></td><td>Error count (0 or 1, unless multiple samples are aggregated)</td></tr>
<tr><td><code>hn</code></td><td>Hostname where the sample was generated</td></tr>
<tr><td><code>it</code></td><td>Idle Time = time not spent sampling (milliseconds) (generally 0)</td></tr>
<tr><td><code>lb</code></td><td>Label</td></tr>
<tr><td><code>lt</code></td><td>Latency = time to initial response (milliseconds) - not all samplers support this</td></tr>
<tr><td><code>ct</code></td><td>Connect Time = time to establish the connection (milliseconds) - not all samplers support this</td></tr>
<tr><td><code>na</code></td><td>Number of active threads for all thread groups</td></tr>
<tr><td><code>ng</code></td><td>Number of active threads in this group</td></tr>
<tr><td><code>rc</code></td><td>Response Code (e.g. <code>200</code>)</td></tr>
<tr><td><code>rm</code></td><td>Response Message (e.g. <code>OK</code>)</td></tr>
<tr><td> <code>s</code></td><td>Success flag (<code>true</code>/<code>false</code>)</td></tr>
<tr><td><code>sc</code></td><td>Sample count (1, unless multiple samples are aggregated)</td></tr>
<tr><td> <code>t</code></td><td>Elapsed time (milliseconds)</td></tr>
<tr><td><code>tn</code></td><td>Thread Name</td></tr>
<tr><td><code>ts</code></td><td>timeStamp (milliseconds since midnight Jan 1, 1970 UTC)</td></tr>
<tr><td><code>varname</code></td><td>Value of the named variable</td></tr>
</table>

<note>
JMeter allows additional variables to be saved with the test plan.
Currently, the variables are saved as additional attributes.
The testplan variable name is used as the attribute name.
See <a href="#sample_variables">Sample variables</a> (above) for more information.
</note>
</section>

<section name="&sect-num;.8 Saving response data" anchor="saving">
<p>
As shown above, the response data can be saved in the XML log file if required.
However, this can make the file rather large, and the text has to be encoded so
that it is still valid XML. Also, images cannot be included.
Only sample responses with the type <code>TEXT</code> can be saved.
<br/>
Another solution is to use the Post-Processor <complink name="Save_Responses_to_a_file">Save Responses to a file</complink>.
This generates a new file for each sample, and saves the file name with the sample.
The file name can then be included in the sample log output.
The data will be retrieved from the file if necessary when the sample log file is reloaded.
</p>
</section>
<section name="&sect-num;.9 Loading (reading) response data" anchor="loading">
<p>To view an existing results file, you can use the File "<code>Browse&hellip;</code>" button to select a file.
If necessary, just create a dummy testplan with the appropriate Listener in it.
</p>
<p>Results can be read from XML or CSV format files.
When reading from CSV results files, the header (if present) is used to determine which fields were saved.
<b>In order to interpret a header-less CSV file correctly, the appropriate JMeter properties must be set.</b>
</p>
<note>
JMeter does not clear any current data before loading the new file thus allowing files to be merged.
If you want to clear the current data, use the menu item:
  <menuchoice>
    <guimenuitem>Run</guimenuitem>
    <guimenuitem>Clear</guimenuitem>
    <shortcut>
      <keycombo>
        <keysym>Ctrl</keysym>
        <keysym>Shift</keysym>
        <keysym>E</keysym>
      </keycombo>
    </shortcut>
  </menuchoice>
or
  <menuchoice>
    <guimenuitem>Run</guimenuitem>
    <guimenuitem>Clear All</guimenuitem>
    <shortcut>
      <keycombo>
        <keysym>Ctrl</keysym>
        <keysym>E</keysym>
      </keycombo>
    </shortcut>
  </menuchoice>
before loading the file.
</note>
</section>
<section name="&sect-num;.10 Saving Listener GUI data" anchor="screencap">
<p>JMeter is capable of saving any listener as a PNG file. To do so, select the
listener in the left panel. Click
  <menuchoice>
    <guimenuitem>Edit</guimenuitem>
    <guimenuitem>Save Node As Image</guimenuitem>
  </menuchoice>.
A file dialog will
appear. Enter the desired name and save the listener.
</p>
<p>
The Listeners which generate output as tables can also be saved using Copy/Paste.
Select the desired cells in the table, and use the OS Copy short-cut (normally <keycombo><keysym>Ctrl</keysym><keysym>C</keysym></keycombo>).
The data will be saved to the clipboard, from where it can be pasted into another application,
e.g. a spreadsheet or text editor.
</p>
<figure image="save_image.png">Figure 1 - <menuchoice><guimenuitem>Edit</guimenuitem><guimenuitem>Save Node As Image</guimenuitem></menuchoice></figure>

</section>
</body>
</document>
