UserGuide.txt(Draft):2005/12/06

==============================================
Running mBench
==============================================

[mBench Overview]
mBench is a Java-based benchmark framework.
You can implement any type of transaction as user component.
mBench log response time of each transaction.

mBench runs the following three parts;
1. Initializer
2. Benchmark
3. Finalizer

[Requirement]
J2SDK 1.4.1 or later

[Running mBench]
1. Implement user components which inherit the following interfaces;
- jp.co.scs.mbench.Initializer
- jp.co.scs.mbench.Benchmark
- jp.co.scs.mbench.Finalizer
2. Add user components to configuration file
User components you made should be add in conf/mbench.xml like;


jp.co.scs.mbench.component.SampleBenchmark


3. Run benchmark
To do benchmark, run main classes as the following with passing
user component name which you define in conf/mbench.xml file.
Main classes are the following;
- jp.co.scs.mbench.InitializeMain
- jp.co.scs.mbench.BenchmarkMain
- jp.co.scs.mbench.FinalizeMain

Other options of main classes are;
- Number of concurrent transactions (-t ?threadNumber)
Define the number of concurrent transaction (virtual clients)
- Number of repeat (-r ?repeatNumber)
Define the number of repeat which each thread conduct
- Time of benchmark (-e ?benchmarkEndTime)

(ex.)Add {$mBench_install_dir}/bin to CLASSPATH,
run java at {$mBench_install_dir};

java jp.co.scs.mbench.BenchmarkMain -t20 ?repeatNumber=10 Sample-benchmark
4. Log file
You will find the following data file and log file at {$mBench_install_dir}.
- Data file(data_YYYYMMDD_hhmmss.csv)
- Log file(log_YYYYMMDD_hhmmss.csv)
