GROUND REPORT CONFIGURATION
ENVIRONMENT PROPERTIES FILE
$GROUNDREPORT_HOME/etc/environment.properties
| Option | Value | Comment |
|---|---|---|
| GROUNDREPORT_HOME | string | set the absolute path to the directory in which ground report is installed. |
| JAVA_HOME | string | set the absolute path to the JVM installation to be used |
| JAVA_ARGS | string | set the JVM runtime options |
| JYTHON_HOME | string | set the absolute path to the Jython installation to be used |
NB.: Set the size of the JVM relevant to the size of report and the report output type.
For a report containing approximately 2000 elements and of PDF output type a JVM size of 512MB is recommended.
For a report containing svg graphs and of PDF output type a JVM size greater than 512MB may be required .
Playing with other JVM parameters may well improve post processing performance.
DATABASE PROPERTIES FILE
$GROUNDREPORT_HOME/etc/database.properties
| Option | Value | Comment |
|---|---|---|
| jdbc.server | string | set the Database server IP Address or hostname |
| jdbc.port | integer | set the Database server port number |
| jdbc.database | string | set the Database Name (SID) |
| jdbc.user | string | set the Database user |
| jdbc.pass | string | set the Database user password |
| jdbc.driver | string | set the Database driver |
DATA PROPERTIES FILE
$GROUNDREPORT_HOME/etc/data.properties
| Option | Value | Comment |
|---|---|---|
| fileType | data || descr | select the type of file you are uploading |
| dataType | http || norm | select the type of data contained within the data files and therefore database |
| fileList | ["/path/to/data/data.log"] | enter the list of files that you'd like to upload. Jython list. |
NB : ensure that filenames are enclosed in quotes
ensure that fileList list is encapsulated with a pair of [] braces
separate filenames with a comma "," and no whitespaces
ensure that you always use a "/" for a directory separator even on Windows
GROUND REPORT PROPERTIES FILE
$GROUNDREPORT_HOME/etc/groundReport.properties
Data options:
| Option | Value | Comment |
|---|---|---|
| load run | integer | select which load run you'd like to report or graph |
| loadRunList | [1,2,3] | enter the list of load runs you want to compare. Jython list. |
| test | integer | select which test/element you would like to produce an individual test/element graph or report. |
| pagePair | [100,200] | set Page Pair List (for individual page graphs and reports). Jython list. |
NB: First member of the pagePair is the target page for graphing/reporting (eg. 100)
Second member of pair is the test number denoting the next page (eg. 200)
If target page is last page in load run then enter "end" as second member of pair.
Output options:
| Option | Value | Comment |
|---|---|---|
| project | string | Set the name of the project. |
| outputFormat | pdf || rtf || xml || xhtml | Set Article/Report Format |
| lang | en | Set Article/Report Language |
| archive | y || n | Set Article/Report Archiving |
| useWatermark | y || n | Set use of watermark (pdf and rtf output formats only) |
| watermarkImage | string | Set image to use as watermark. Image file must be in $GROUNDREPORT_HOME/watermark directory |
| imageFormat | svg || png | Set image output format |
Article/Report types:
| Option | Value | Comment |
|---|---|---|
| SummaryArticle | y || n | Gives an overview of the test data and a table similar to the table in the grinder console. It tries to identify the worst performing tests in the load run. It gives information on time/date of test, TPS, bandwidth, response time, # of concurrent users etc. This information is mostly aggregate data for all the tests combined. |
| IndividualTestArticle | y || n | This gives a summary report on a specific test that was in the load run. All the data and graphs are specific to that test. |
| IndividualPageArticle | y || n | This gives a summary report on a composite test (representative of an html page) containing a number of individual tests (elements). It details all the information for the individual tests and attempts to give a picture of the performance of the page. All the data and graphs are specific to that composite test (page). |
| PageBreakdownArticle | y || n | This gives a summary report for all the composite tests (pages) within a particular load run and follows that by a page by page breakdown of elements and relevant information. |
| LoadRunComparisonArticle | y || n | This report compares the results of various load runs of the same suite of tests against a baseline set of results. It shows the differences and attempts to work out of there is any statistical significance in the change observed by using effect size. |
The format of a report/article is of a DocBook 5 XML article.
This XML format can be transformed into a number of other formats, such as pdf, xhtml and rtf.
All reports are generated in the following location:
$GROUNDREPORT_HOME/output/reports
If report archiving has been enabled the archives are stored in the following location:
$GROUNDREPORT_HOME/output/archives
The text for titles and labels is stored in the following file in the following location:
$GROUNDREPORT_HOME/includes/en/standardArticle.txt
Graph Types:
There are 5 categories of graph:
Summary
Breakdown
Individual
Comparison
Load Run Comparison
Those graphs with "HTTP" in their name are valid only for the http data type.
Hopefully the naming of the graphs gives you a clue as to what they display.
Summary graphs:
| Option | Value | Comment |
|---|---|---|
| TPSChart | y || n | This option will produce a graph which shows the overall Transactions Per Second profile for all elements for the specified load run. Plotted against concurrent user load. |
| ConcurrentUsersChart | y || n | This option will produce a graph which shows the concurrent user profile (load) for the specified load run. |
| TotalBandwidthChart | y || n | This option will produce a graph which shows the overall Bandwidth Per Second profile for all elements for the specified load run. |
| TotalResponseTimeChart | y || n | This option will produce a graph which shows the overall mean Response Time profile for all elements for the specified load run. Plotted against concurrent user load. |
| ElementHeatChart | y || n | This option will produce a graph which shows the Response Time profile for all elements for the specified load run by means of a heat map. |
| StaticElementHeatHTTPChart | y || n | This option will produce a graph which shows the Response Time profile for all static elements for the specified load run by means of a heat map. |
| DynamicElementHeatHTTPChart | y || n | This option will produce a graph which shows the Response Time profile for all dynamic elements for the specified load run by means of a heat map. |
| PageHeatHTTPChart | y || n | This option will produce a graph which shows the Response Time profile for all pages for the specified load run by means of a heat map. |
| PPSHTTPChart | y || n | This option will produce a graph which shows the overall Pages Per Second profile for the specified load run. Plotted against concurrent user load. |
| PageResponseTimeHTTPChart | y || n | This option will produce a graph which shows the overall mean Response Time profile for all pages for the specified load run. Plotted against concurrent user load. |
| SummaryHTTPBarChart | y || n | This option will produce a bar chart which shows the timing breakdowns of the worst performing elements in the specified load run. |
| StaticTPSHTTPChart | y || n | This option will produce a graph which shows the overall Transactions Per Second profile for all static elements for the specified load run. Plotted against concurrent user load. |
| DynamicTPSHTTPChart | y || n | This option will produce a graph which shows the overall Transactions Per Second profile for all dynamic elements for the specified load run. Plotted against concurrent user load. |
| StaticBandwidthHTTPChart | y || n | This option will produce a graph which shows the overall Bandwidth Per Second profile for all static elements for the specified load run. |
| DynamicBandwidthHTTPChart | y || n | This option will produce a graph which shows the overall Bandwidth Per Second profile for all dynamic elements for the specified load run. |
| StaticResponseTimeHTTPChart | y || n | This option will produce a graph which shows the overall mean Response Time profile for all static elements for the specified load run. Plotted against concurrent user load. |
| DynamicResponseTimeHTTPChart | y || n | This option will produce a graph which shows the overall mean Response Time profile for all dynamic elements for the specified load run. Plotted against concurrent user load. |
Breakdown graphs:
| Option | Value | Comment |
|---|---|---|
| PerElementBandwidthChart | y || n | This option will produce Bandwidth profile charts for all elements within the specified load run. |
| PerElementResponseTimeChart | y || n | This option will produce Response Time profile charts for all elements within the specified load run. |
| PerPageResponseTimeHTTPChart | y || n | This option will produce Bandwidth profile charts for all pages within the specified load run. |
| PerPageSummaryHTTPBarChart | y || n | This option will produce Timing Breakdown bar charts for all pages within the specified load run. |
Individual graphs:
| Option | Value | Comment |
|---|---|---|
| IndividualElementBandwidthChart | y || n | This option will produce a Bandwidth profile chart for the specified element for the specified load run. |
| IndividualElementResponseTimeChart | y || n | This option will produce a Response Time profile chart for the specified element for the specified load run. |
| IndividualElement95ResponseTimeChart | y || n | This option will produce a Response Time profile chart at the 95% confidence level for the specified element for the specified load run. |
| IndividualElementResponseTimeDistributionChart | y || n | This option will produce a Distribution chart of Response Time for the specified element for the specified load run. |
| IndividualPageResponseTimeHTTPChart | y || n | This option will produce a Response Time profile chart for the specified page for the specified load run. |
| IndividualPageResponseTimeDistributionHTTPChart | y || n | This option will produce a Distribution chart of Response Time for the specified page for the specified load run. |
| IndividualPageSummaryHTTPBarChart | y || n | This option will produce Timing Breakdown bar charts for the specified page within the specified load run. |
Comparison graphs:
| Option | Value | Comment |
|---|---|---|
| TPSVsPPSHTTPChart | y || n | This option will produce a graph that plots the TPS profile against the PPS profile for the specified load run. |
| TotalResponseTimeVsPageResponseTimeHTTPChart | y || n | This option will produce a graph that plots the overall element Response Time profile against the overall page Response Time profile for the specified load run. |
| StaticVsDynamicResponseTimeHTTPChart | y || n | This option will produce a graph that plots the static element Response Time profile against the dynamic element Response Time profile for the specified load run. |
| StaticVsDynamicBandwidthHTTPChart | y || n | This option will produce a graph that plots the static element Bandwidth profile against the dynamic element Bandwidth profile for the specified load run. |
| StaticVsDynamicTPSHTTPChart | y || n | This option will produce a graph that plots the static element TPS profile against the dynamic element TPS profile for the specified load run. |
Load run comparison graphs:
| Option | Value | Comment |
|---|---|---|
| LoadRunComparisonTPSChart | y || n | This option will produce a graph that plots the TPS profiles for all specified load runs. |
| LoadRunComparisonBandwidthChart | y || n | This option will produce a graph that plots the Bandwidth profiles for all specified load runs. |
| LoadRunComparisonResponseTimeChart | y || n | This option will produce a graph that plots the overall element Response Time profiles for all specified load runs. |
| LoadRunComparisonPPSHTTPChart | y || n | This option will produce a graph that plots the PPS profiles for all specified load runs. |
| LoadRunComparisonPageResponseTimeHTTPChart | y || n | This option will produce a graph that plots the page Response Time profiles for all specified load runs. |
All graphs are generated in the following location:
$GROUNDREPORT_HOME/output/images
The text for titles and labels is stored in the following file in the following location:
$GROUNDREPORT_HOME/includes/en/standardGrapher.txt