blob: b3d03aa9f51182557b793c5f8942022a0c7ec2ee [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html lang="en">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<title>org.eclipse.test.performance.ui readme</title>
<b><font size="+2">README</font></b><br>
Last updated: October 26, 2005<br>
<b>Introduction</b><br> <br> This readme describes how to
create performance charts and tables similar to those available on the
eclipse platform download pages using the stand-alone java program <b>org.eclipse.test.performance.ui.Main</b>
stored in this project. Although the program is currently geared to
generating results for the Eclipse Platform builds, the program may
work for you given the following conditions:
<li>The &quot;eclipse.perf.config&quot; system property used to
run tests used three keys config, build and jvm
<li>for example,
<br> <br>
<li>Values for the "build" key begin with either an 'I' or 'N'
with the exception of the reference builds (for example, 3.0).
<li>The line graphs plot the reference build, all builds
starting with 'I' and the seven 'N' builds preceding the current
<li>This can be overriden with the use of the
&quot;-current.prefix&quot; parameter where you can specify a
comma-separated list of prefixes for build ids to include in the
main line graph.<br> <br>
<li>Scenario names all contain a prefix
<li>For example, it is assumed that the scenario
belongs to the &quot;; component.</li>
<li>Unique scenario prefixes are derived from all the scenarios
in the database and are used to group results.</li>
<br> For purposes of this document, the term &quot;<a
href="images/descriptions.html#fp">fingerprint</a>&quot; will be used
to refer to a bar graph which represents the performance summary at a
global or component level for each test configuration.<br> <br>
The term &quot;<a href="images/descriptions.html#sst">scenario
status table</a>&quot; will be used to refer to a table of scenarios with
green checks and red x indicators below a component fingerprint. This
table gives an overall view of the status for all scenarios for a
component for all configurations.<br>
The term &quot;<a href="images/descriptions.html#sr">scenario
results</a>&quot; will be used to refer to a web page comparing current
performance measurements to the baseline measurements for one scenario
on one configuration. The web page displays the raw data for the
current and baseline measurements and also displays line graphs showing
the measured values over the course of builds between the current and
<br> <b>Requirements</b>
<li>Windows or Linux (x86) operating system</li>
<li>JVM 11 installed and on path</li>
<b>Running the program</b>
From a terminal or dos prompt,<br>
<LI>cd to
<LI>If running on Linux, execute &quot;chmod 755 genresults&quot;</LI>
<LI>Execute the following command:<b><br> <br>
genresults -baseline &lt;baseline build id&gt; -current &lt;current
build id&gt; -config &lt;comma-separated list of configs&gt; -jvm
&lt;jvm name&gt; -output &lt;output dir&gt; [
&lt;properties&gt;] [highlight &lt;buildid patterns&gt;]
[scenario.pattern &lt;scenario prefix patterns&gt;]
[-fingerprints][-scenarioresults][-current.prefix &lt;comma-separated
list of build id prefixes&gt;][-baseline.prefix &lt;comma-separated
list of build id prefixes&gt;]</b></LI>
<br> Parameter descriptions:
<li>-baseline - baseline build id. A previous value used in the
&quot;build&quot; key in the eclipse.perf.config system property or
the eclipse.perf.assertAgainst property.</li>
<li>-current - current build id. The value used in the
&quot;build&quot; key in the eclipse.perf.config system property.</li>
<li>-config - a comma-separated list of names of configurations
for which to produce results. The values used should be the same as
values specified for the &quot;config&quot; key in the
eclipse.perf.config system property.</li>
<li>-jvm -jvm
description. The value used in the &quot;jvm&quot; key in the
eclipse.perf.config system property.
<li>-output - path to an output directory for fingerprints and
scenarios for each configuration specified in -config parameter.
Fingerprint gifs and html files are generated in the directory
specified, configuration specific subdirectories are created to store
scenario results and line graphs.</li>
<br> Optional arguments:
<li> - semi-colon separated list of: config,
alternate config description. The value should be quoted if there are
spaces in the value.<BR>of builds which match any prefix in this
list. When omitted, a magenta line is draw on the graph which
represents the baseline value specified in the -baseline parameter.
<li>-highlight - Comma-separated list of build Id
prefixes(excluding 'I' and 'N'), which are used to add and highlight
the most recent matching buildId on line graphs.</li>
<li>-scenario.pattern - Scenario prefix pattern used to query
performance results database. Can be used to generate results for a
single component or subset of scenarios.</li>
<li>-fingerprints or -scenarioresults - use one or the other to
generate fingerprints or scenario results only. Not specifying either
will execute both.</li>
<li>-baseline.prefix - semi-colon separated list of: build id
prefixes used in eclipse.perf.assertAgainst property or
eclipse.perf.config system property. Values used to generate a second
line graph representing changes in repeated baseline test run.</li>
<li>-current.prefix - semi-colon separated list of: build id
prefixes used in eclipse.perf.config system property. Values here
used to override default of &quot;N,I&quot;. Used to select build
id's to include in main line graph.</li>