Package perffmwk

This framework makes it easy to archive, report, and compare performance statistics.

See: Description

Interface Summary

Interface	Description
ComparisonConstants
RemotePerfStatMgr	This is the interface for the remote RemotePerfStatMgrImpl object.
TestComparison	Represents the results of comparing statistic values of a number of test runs to a "base" test run.

Class Summary

Class	Description
BaseComparison	Contains data and behavior common to all TestComparisons.
Expr	Holds an individual statistics specification expression.
Formatter	Contains common code used to format reports.
HistogramStats	Implements a histogram with configurable bin values.
HistogramStatsPrms
PerfComparer	Generates performance comparisons for the specified test container directories.
PerfFilter
PerformanceStatistics	An instance of a performance statistics type.
PerfReporter	Generates performance reports for specified test directories.
PerfReportPrms	A class used to store keys for performance report generator configuration settings.
PerfSorter	Sorts a list of test directories into subdirectories based on their comparison keys, specified using the test configuration variable PerfSorter.COMPARISON_KEY_PROP.
PerfStatMgr	A PerfStatMgr provides runtime support for the internal management, trim interval settings, and queries on statistics, whether system or application-defined.
PerfStatReader	Reads statistics from statarchive files.
PerfStatValue	Contains the value of a statistic.
RatioComparison	A TestComparison whose data table contains values that are ratio comparisons to a base value.
RawComparison	A TestComparison whose data table consists of raw statistics values obtained directly from the PerfStatValue.
RemotePerfStatMgrImpl	This class implements a remote object for aggregating information about performance.
RuntimeStatSpec	Holds an individual statistics specification generated at runtime.
StatConfig	A StatConfig contains a statistics specification, trim specification, and latest properties.
StatSpec	Holds an individual statistics specification.
StatSpecId	Holds the components of an individual statistics specification id.
StatSpecParser	Parses statistics specification files.
StatSpecTokens	Holds tokens for the statistics specification grammar.
Test	Represents a test directory.
TestContainer	Represents a test container directory.
TrimInterval	An instance of a trim interval.
TrimSpec	An instance of a trim specification.
TrimSpecParser	Parses trim specification files.
TrimSpecTokens	Holds tokens for the trim specification grammar.
ValueComparator	Represents the statistics-related information from a test run.

Exception Summary

Exception	Description
PerfComparisonException
PerfStatException
StatConfigException

Package perffmwk Description

This framework makes it easy to archive, report, and compare performance statistics.

REPORTING

There are two ways to generate a performance report, at runtime and post-mortem.

RUNTIME REPORTING

The hydra master controller will, upon request, autogenerate a performance report at the end of a test run. This is controlled via the configuration parameter:

    perffmwk.PerfReportPrms-generatePerformanceReport = <boolean>;

The report is written to "perfreport.txt" in the test directory. It is based on statistics and trim specification files autogenerated by the framework.

The autogenerated statistics specification file is written to "statistics.spec" in the test directory. By default, it contains default specifications for any user-defined statistics created by the test code at runtime, along with a pointer to the default specification file $JTESTS/perffmwk/statistics.spec containing common system statistics. A test can optionally specify its own statistics specification file, using:

    perffmwk.PerfReportPrms-statisticsSpecification = <filename>;

In this case, the autogenerated "statistics.spec" file will simply contain a pointer to the specified file. See statspec_grammar.txt for details on how to construct a statistics specification file. Tokens for the grammar are defined in StatSpecTokens.

The autogenerated trim specification file is written to "trim.spec" in the test directory. It contains endpoints for named trim intervals specified by the test code at runtime, if any. Trim intervals with default endpoints are omitted.

POST_MORTEM REPORTING

The post-mortem reporting tool has the system property "perffmwk.statisticsSpecification", which defaults to "statistics.spec" in the test directory. The trim specification used is always "trim.spec" in the test directory.

The statistics and trim specification files in individual test directories can also be modified in place before invoking post-mortem tool.

See statspec_grammar.txt and trimspec_grammar.txt for details on how to construct specifications.

For how to run the post-mortem performance reporter, see PerfReporter.