UserGuide-JP.txt : 2005/12/06

==============================================
  mBench の動作方法
==============================================

[mBench概要]
mBenchは、ユーザが計測したいトランザクションで
負荷をかけるJavaのベンチマークフレームワークである。
固有のトランザクションを実装するだけで、
レスポンスタイムの計測が可能である。

** mBenchの詳細は、公開ドキュメントを参照して欲しい。

[必要環境の構築]
1.JVMが動作するOSをインストールする。
2.J2SDK 1.4.1 以上のJava開発環境をインストールする。


[ベンチマークの実行]
0. mBenchの構成
  mBenchには、以下の３種類の処理を実行する機能がある。
    - 前処理 (Initializer)
    - テストトランザクション (Benchmark)
    - 後処理 (Finalizer)

1. ベンチマーク処理の実装
  ３種類の処理は、mBench提供の各インターフェースの
  実装クラスとして実装する。上記処理に対応する、
  それぞれのインターフェースは次のとおりである。
    - jp.co.scs.mbench.Initializer
    - jp.co.scs.mbench.Benchmark
    - jp.co.scs.mbench.Finalizer

2. 定義ファイルへの登録
  実装したベンチマーク処理は、設定ファイル(conf/mbench.xml)に登録する。
  例：mbench.xml
    <benchmarks>
      <benchmark name="Sample-benchmark">
        <class>jp.co.scs.mbench.component.SampleBenchmark</class>
      </benchmark>
    </benchmarks>

3. ベンチマーク処理の実行
  ベンチマーク処理を実行するには、各処理に対応した、
  Mainクラスを使用する。
    - jp.co.scs.mbench.InitializeMain
    - jp.co.scs.mbench.BenchmarkMain
    - jp.co.scs.mbench.FinalizeMain
  MainクラスからXMLに登録した名前を起動オプションとして指定することにより、
  ユーザ固有の処理を実行する。
  BenchmarkMain クラスには、他にも以下の起動オプションを指定できる。
    - 同時接続数           (-t  --threadNumber)
        ==>  テストトランザクションの同時実行数を指定する。
    - 繰返し実行回数       (-r  --repeatNumber)
        ==>  １接続あたりの実行回数を指定する。
    - 総トランザクション数 (-T  --transactionNumber)
        ==>  全体で実行されるテストトランザクション数を指定する。
    - ベンチマーク終了時間 (  -e  --benchmarkEndTime)
        ==>  ベンチマークの終了時間を指定する。
  例：起動例
    CLASSPATH に{$mBench_install_dir}/binを追加し、
    {$mBench_install_dir}からjavaコマンドを実行する。
    java jp.co.scs.mbench.BenchmarkMain -t20 --repeatNumber=10 Sample-benchmark


4. 計測結果
  テストトランザクションを実行すると、
  ベンチマークトランザクションのディレクトリ直下に、
  以下 ２つの計測結果が出力される。
    - データファイル (ファイル名 : data_YYYYMMDD_hhmmss.csv)
    - 実行ログファイル (ファイル名 : log_YYYYMMDD_hhmmss.csv)


