Can Jmeter Read Absolute Path in Preferences File

12. Introduction to listeners¶

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 "View Results Tree" or "View Results in table" to a test plan. To view the response time graphically, add graph results. The listeners section of the components page has total descriptions of all the listeners.

Unlike listeners display the response information in dissimilar means. However, they all write the same raw data to the output file - if one is specified.

The "Configure" button can be used to specify which fields to write to the file, and whether to write it as CSV or XML. CSV files are much smaller than XML files, and then use CSV if you are generating lots of samples.

The file proper noun tin be specified using either a relative or an accented path name. Relative paths are resolved relative to the current working directory (which defaults to the bin/ directory). JMeter besides supports paths relative to the directory containing the current test plan (JMX file). If the path name begins with "~/" (or whatever is in the jmeter.save.saveservice.base_prefix JMeter property), then the path is assumed to be relative to the JMX file location.

If you only wish to record certain samples, add together the Listener as a child of the sampler. Or you tin 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 certain they all use the same configuration!

12.1 Default Configuration¶

The default items to be saved can be defined in the jmeter.properties (or user.properties) file. The backdrop are used as the initial settings for the Listener Config pop-upwardly, and are also used for the log file specified past the -l control-line flag (commonly used for CLI manner test runs).

To change the default format, find the following line in jmeter.properties:

jmeter.save.saveservice.output_format=

The information to exist saved is configurable. For maximum information, cull "xml" every bit the format and specify "Functional Test Style" on the Test Plan element. If this box is non checked, the default saved information includes a time stamp (the number of milliseconds since midnight, January one, 1970 UTC), the data type, the thread proper noun, the label, the response time, message, and code, and a success indicator. If checked, all information, including the full response data volition be logged.

The following case indicates how to gear up properties to become a vertical bar ("|") delimited format that will output results like:.

timeStamp|time|label|responseCode|threadName|dataType|success|failureMessage 02/06/03 08:21:42|1187|Home|200|Thread Group-one|text|true| 02/06/03 08:21:42|47|Login|200|Thread Group-ane|text|faux|Test Failed:     expected to contain: password etc.

The corresponding jmeter.properties that need to be fix are shown beneath. One oddity in this example is that the output_format is prepare to csv, which typically indicates comma-separated values. However, the default_delimiter was prepare to be a vertical bar instead of a comma, then the csv tag is a misnomer in this instance. (Think of CSV as meaning grapheme separated values)

jmeter.save.saveservice.output_format=csv jmeter.relieve.saveservice.assertion_results_failure_message=truthful jmeter.relieve.saveservice.default_delimiter=|

The full set of properties that affect consequence file output is shown below.

#--------------------------------------------------------------------------- # Results file configuration #---------------------------------------------------------------------------  # This section helps determine how result data volition be saved. # The commented out values are the defaults.  # legitimate values: xml, csv, db.  Simply xml and csv are currently supported. #jmeter.save.saveservice.output_format=csv   # truthful when field should be saved; false otherwise  # assertion_results_failure_message only affects CSV output #jmeter.salve.saveservice.assertion_results_failure_message=truthful # # legitimate values: none, offset, all #jmeter.save.saveservice.assertion_results=none # #jmeter.save.saveservice.data_type=true #jmeter.salve.saveservice.characterization=true #jmeter.salve.saveservice.response_code=true # response_data is not currently supported for CSV output #jmeter.save.saveservice.response_data=imitation # Save ResponseData for failed samples #jmeter.relieve.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.salvage.saveservice.connect_time=true #jmeter.salvage.saveservice.samplerData=false #jmeter.save.saveservice.responseHeaders=fake #jmeter.relieve.saveservice.requestHeaders=false #jmeter.save.saveservice.encoding=false #jmeter.save.saveservice.bytes=true #jmeter.save.saveservice.sent_bytes=truthful #jmeter.salve.saveservice.url=fake #jmeter.relieve.saveservice.filename=simulated #jmeter.save.saveservice.hostname=simulated #jmeter.salvage.saveservice.thread_counts=true #jmeter.save.saveservice.sample_count=simulated #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.salve.saveservice.timestamp_format=ms #jmeter.salvage.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 two.3 one can use: #jmeter.save.saveservice.default_delimiter=\t  # Only applies to CSV format files: # Print field names equally first line in CSV #jmeter.save.saveservice.print_field_names=truthful  # Optional list of JMeter variable names whose values are to exist saved in the upshot data files. # Apply commas to split the names. For instance: #sample_variables=SESSION_ID,REFERENCE # N.B. The current implementation saves the values in XML equally attributes, # and 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 customer.  # Optional xml processing instruction for line 2 of the file: #jmeter.relieve.saveservice.xml_pi=<?xml-stylesheet type="text/xsl" href="sample.xsl"?>  # Prefix used to identify filenames that are relative to the current base #jmeter.salvage.saveservice.base_prefix=~/  # AutoFlush on each line written in XML or CSV output # Setting this to true will event in less test results information loss in example of Crash # but with impact on performances, specially for intensive tests (low or no pauses) # Since JMeter ii.10, this is false past default #jmeter.save.saveservice.autoflush=imitation  # Put the start time stamp in logs instead of the end sampleresult.timestamp.start=true  # Whether to utilise System.nanoTime() - otherwise just utilise System.currentTimeMillis() #sampleresult.useNanoTime=true  # Use a background thread to calculate the nanoTime offset # Set this to ≤ 0 to disable the background thread #sampleresult.nanoThreadSleep=5000

The date format to be used for the timestamp_format is described in SimpleDateFormat. The timestamp format is used for both writing and reading files. If the format is set to "ms", and the column does not parse as a long integer, JMeter (two.9+) will endeavor the post-obit formats:

yyyy/MM/dd HH:mm:ss.SSS
yyyy/MM/dd HH:mm:ss
yyyy-MM-dd HH:mm:ss.SSS
yyyy-MM-dd HH:mm:ss
MM/dd/yy HH:mm:ss (this is for compatibility with previous versions; information technology is not recommended as a format)

Matching is now also strict (non-lenient). JMeter 2.viii and earlier used lenient mode which could result in timestamps with wrong dates (times were ordinarily correct).

12.1.ane Sample Variables¶

JMeter supports the sample_variables property to define a listing 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. Come across to a higher place for an example.

12.1.two Sample Issue Salve Configuration¶

Listeners tin can be configured to salve different items to the effect log files (JTL) past using the Config popup as shown below. The defaults are defined as described in the Listener Default Configuration section above. Items with (CSV) after the name only use to the CSV format; items with (XML) only apply to XML format. CSV format cannot currently be used to save whatsoever items that include line-breaks.

Notation that cookies, method and the query string are saved as part of the "Sampler Data" pick.

12.2 CLI mode (batch) examination runs¶

When running in CLI mode, the -l flag can be used to create a top-level listener for the test run. This is in addition to any Listeners defined in the test program. The configuration of this listener is controlled by entries in the file jmeter.properties as described in the previous section.

This feature can be used to specify different data and log files for each test run, for instance:

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

Note that JMeter logging letters are written to the file jmeter.log by default. This file is recreated each time, so if you desire to keep the log files for each run, you will need to rename it using the -j pick equally above.

JMeter supports variables in the log file name. If the filename contains paired single-quotes, then the name is processed as a SimpleDateFormat format applied to the current date, for example: log_file='jmeter_'yyyyMMddHHmmss'.tmp'. This tin be used to generate a unique name for each test run.

12.3 Resource usage¶

Listeners tin apply a lot of memory if at that place are a lot of samples.

Most of the listeners currently go along a copy of every sample they display, autonomously from:

Simple Data Author
BeanShell/JSR223 Listener
Mailer Visualizer
Monitor Results
Summary Report

The following Listeners no longer need to continue copies of every single sample. Instead, samples with the same elapsed fourth dimension are aggregated. Less memory is at present needed, particularly if most samples only have a second or two at most.

Amass Report
Aggregate Graph

To minimize the amount of retention needed, employ the Simple Information Writer, and use the CSV format.

12.4 CSV Log format¶

The CSV log format depends on which data items are selected in the configuration. Just the specified data items are recorded in the file. The order of appearance of columns is stock-still, and is as follows:

timeStamp - in milliseconds since ane/one/1970
elapsed - in milliseconds
label - sampler label
responseCode - e.g. 200, 404
responseMessage - e.g. OK
threadName
dataType - eastward.g. text
success - true or faux
failureMessage - if any
bytes - number of bytes in the sample
sentBytes - number of bytes sent for the sample
grpThreads - number of active threads in this thread grouping
allThreads - full number of active threads in all groups
URL
Filename - if Save Response to File was used
latency - fourth dimension to offset response
connect - fourth dimension to establish connexion
encoding
SampleCount - number of samples (i, unless multiple samples are aggregated)
ErrorCount - number of errors (0 or 1, unless multiple samples are aggregated)
Hostname - where the sample was generated
IdleTime - number of milliseconds of 'Idle' time (unremarkably 0)
Variables, if specified

12.5 XML Log format ii.i¶

The format of the updated XML (2.one) is as follows (line breaks will exist unlike):

<?xml version="1.0" encoding="UTF-8"?> <testResults version="1.2">  -- HTTP Sample, with nested samples  <httpSample t="1392" lt="351" ts="1144371014619" s="true"      lb="HTTP Request" rc="200" rm="OK"      tn="Mind 1-1" dt="text" de="iso-8859-1" by="12407">   <httpSample t="170" lt="170" ts="1144371015471" s="true"         lb="http://world wide web.apache.org/way/way.css" rc="200" rm="OK"         tn="Listen ane-1" dt="text" de="ISO-8859-1" by="1002">     <responseHeader class="java.lang.String">HTTP/1.1 200 OK Date: Fri, 07 Apr 2006 00:50:14 GMT ⋮ Content-Type: text/css </responseHeader>     <requestHeader class="java.lang.Cord">MyHeader: MyValue</requestHeader>     <responseData class="java.lang.Cord">body, td, th {     font-size: 95%;     font-family: Arial, Geneva, Helvetica, sans-serif;     color: black;     background-color: white; } ⋮ </responseData>     <cookies class="java.lang.Cord"></cookies>     <method class="coffee.lang.String">Go</method>     <queryString class="java.lang.Cord"></queryString>     <url>http://www.apache.org/style/fashion.css</url>   </httpSample>   <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 one-1" dt="bin" de="ISO-8859-1" by="5866">     <responseHeader class="coffee.lang.String">HTTP/1.ane 200 OK Appointment: Friday, 07 Apr 2006 00:50:14 GMT ⋮ Content-Type: paradigm/gif </responseHeader>     <requestHeader grade="java.lang.String">MyHeader: MyValue</requestHeader>     <responseData form="coffee.lang.String">http://www.apache.org/asf.gif</responseData>       <responseFile class="java.lang.String">Mixed1.html</responseFile>     <cookies class="java.lang.String"></cookies>     <method class="coffee.lang.String">Become</method>     <queryString class="coffee.lang.String"></queryString>     <url>http://www.apache.org/asf.gif</url>   </httpSample>   <responseHeader form="java.lang.String">HTTP/ane.1 200 OK Appointment: Fri, 07 Apr 2006 00:50:thirteen GMT ⋮ Content-Type: text/html; charset=ISO-8859-1 </responseHeader>   <requestHeader class="java.lang.String">MyHeader: MyValue</requestHeader>   <responseData class="java.lang.String"><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML ane.0 Transitional//EN"                "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> ⋮ <html>  <head> ⋮  </caput>  <trunk> ⋮  </body> </html> </responseData>   <cookies class="java.lang.String"></cookies>   <method class="java.lang.String">Go</method>   <queryString course="java.lang.String"></queryString>   <url>http://world wide web.apache.org/</url> </httpSample>  -- non HTTP Sample  <sample t="0" lt="0" ts="1144372616082" south="true" lb="Example Sampler"     rc="200" rm="OK" tn="Listen 1-1" dt="text" de="ISO-8859-1" by="10">   <responseHeader class="java.lang.Cord"></responseHeader>   <requestHeader class="java.lang.String"></requestHeader>   <responseData grade="java.lang.String">Listen 1-1</responseData>   <responseFile grade="java.lang.String">Mixed2.unknown</responseFile>   <samplerData course="java.lang.Cord">ssssss</samplerData> </sample>  </testResults>

Note that the sample node name may be either "sample" or "httpSample".

12.6 XML Log format 2.2¶

The format of the JTL files is identical for 2.2 and 2.1. Format 2.2 only affects JMX files.

12.7 Sample Attributes¶

The sample attributes have the post-obit meaning:

Aspect	Content
past	Bytes
sby	Sent Bytes
de	Data encoding
dt	Data type
ec	Error count (0 or ane, unless multiple samples are aggregated)
hn	Hostname where the sample was generated
it	Idle Fourth dimension = fourth dimension not spent sampling (milliseconds) (generally 0)
lb	Characterization
lt	Latency = time to initial response (milliseconds) - not all samplers support this
ct	Connect Time = time to establish the connection (milliseconds) - non all samplers support this
na	Number of agile threads for all thread groups
ng	Number of active threads in this grouping
rc	Response Code (e.g. 200)
rm	Response Message (e.g. OK)
s	Success flag (true/false)
sc	Sample count (1, unless multiple samples are aggregated)
t	Elapsed time (milliseconds)
tn	Thread Name
ts	timeStamp (milliseconds since midnight Jan 1, 1970 UTC)
varname	Value of the named variable

JMeter allows additional variables to be saved with the test plan. Currently, the variables are saved equally additional attributes. The testplan variable proper noun is used as the aspect proper noun. See Sample variables (in a higher place) for more than data.

12.8 Saving response information¶

Every bit shown above, the response data tin can exist saved in the XML log file if required. Even so, this can make the file rather large, and the text has to be encoded so that information technology is still valid XML. Also, images cannot be included. Only sample responses with the blazon TEXT can be saved.
Another solution is to use the Post-Processor Save_Responses_to_a_file. 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.

12.9 Loading (reading) response data¶

To view an existing results file, you lot tin employ the File "Browse…" push to select a file. If necessary, just create a dummy testplan with the advisable Listener in information technology.

Results tin can be read from XML or CSV format files. When reading from CSV results files, the header (if present) is used to decide which fields were saved. In order to interpret a header-less CSV file correctly, the appropriate JMeter properties must be ready.

JMeter does non clear any current data before loading the new file thus allowing files to be merged. If you desire to clear the current data, use the carte du jour item: or before loading the file.

12.10 Saving Listener GUI data¶

JMeter is capable of saving any listener equally a PNG file. To practise and so, select the listener in the left panel. Click . A file dialog will appear. Enter the desired name and save the listener.

The Listeners which generate output as tables tin also be saved using Copy/Paste. Select the desired cells in the table, and use the OS Copy curt-cut (normally Ctrl +C ). The data will be saved to the clipboard, from where it tin be pasted into another application, eastward.grand. a spreadsheet or text editor.

Go to top

zinkpontliatich.blogspot.com

Source: https://jmeter.apache.org/usermanual/listeners.html