Apache Jmeter入門

Apache Jmeter は 100% pure Java で作られたデスクトップ・アプリケーションで、 Webアプリに代表されるようなクライアント／サーバ側ソフトウェアの 負荷テストを行うためのツールです。 静的ファイル、Java サーブレット、CGI スクリプト、Java オブジェクト、 データベース、FTP サーバといった、静的および動的なリソースに関する パフォーマンスを測定するのに利用できます。さらに、 高負荷状態のサーバ／ネットワーク／オブジェクトをシミュレートしながら それらの性能を測定したり、 システム全体のパフォーマンスを分析するのにも使えます。

また Jmeter では、 あなたの作ったアプリケーションが期待する結果を返しているかを検証するための アサーション（成立条件チェック）やテストスクリプトを組み込むことで、 アプリケーションのリグレッション（回帰）テストを行うことができます。 柔軟性を十分に発揮できるように、Jmeter では正規表現を使ってこれらの アサーションを作成できます。

ただし、あくまでも Jmeter はブラウザではなく、 （HTTP 等の）プロトコルレベルで動作するツールです。

ホームに戻る

目次

• Jmeterのインストール
• アーカイブの内容(bin)
• Jmeterの起動
• • テスト計画とワークベンチ
• テンプレートの内容(bin/templates)
• テンプレート１(build-web-test-plan)の実行
• • グローバル定義画面
  • スレッドグループ定義画面
  • HTTPリクエスト初期値設定
  • HTTPリクエスト
  • • 自動リダイレクトにおける注意事項
• テスト計画に追加できるコンポーネント
• • Threads(Users)
  • Test Fragment
  • 設定エレメント
  • タイマ
  • 前処理
  • 後処理
  • アサーション - 成立条件チェック
  • リスナー（テスト結果の閲覧、レポート）
• スレッドグループに追加できるコンポーネント
• • ロジックコントローラ
  • サンプラー - 実際にリクエストを出すもの
• トラブル対応
• • Out of Memory
• 実践例

Jmeterのインストール

Apache Jmeterのダウンロードページ からApache Jmeter 2.11(zip)をダウンロードし、 Windows ならデスクトップ、Linux ならホームディレクトリ直下に展開します。 Windows で普段使っていたLhaplus 1.59では解凍時に警告が出たので （解凍後のパスが長すぎるから？） ALZip（アルジップ）無料バージョン 8.61.1.0 というのを入れて無事に解凍OK。これでインストールは完了です。

なお Jmeter は Java アプリなので、 事前にJRE/JDKあたりを入れておく必要があります。

アーカイブの内容(bin)

使っていくにつれて bin 配下が汚れがちになるので、 解凍直後の状態を参考までに記載しておきます。 bin には以下のファイルが入っています。

以下は今後作成するテスト計画の内容を保存するファイルです。

以下は実行時に生成されるファイルです。トラブル時に役立ちます。 不要なら消しても構いません。

Jmeterの起動

テンプレートの内容(bin/templates)

ここでは標準で用意されているテンプレートシナリオを元に、 Jmeter の機能を概観しています。 「ファイル」＞「開く」で bin/templates を開いてみてください。 以下のファイルが入っています。

テンプレート１(build-web-test-plan)の実行

グローバル定義画面(build-web-test-plan)

スレッドグループ定義画面(JMeter Users)

名前

スレッドグループの名前。内部的には連番で管理されているようです。

コメント

詳細な説明を入れておきましょう。

サンプラーエラー後のアクション

サンプラーはクライアントからの何らかのアクションです。 たとえばWebサーバのテストであれば、 あるURLをリクエストするためのサンプラーとして 「HTTPリクエスト」を選択します。 サンプラー追加の際は、スレッドグループで右クリックして＞追加＞サンプラー＞ HTTPリクエストの順に選択します。他にも様々なサンプラーがあるので 覗いてみてください。
　この例では "Jmeter Users" というスレッドグループにぶら下がっている "Home Page" と "Changes"がサンプラーです。 それぞれ、ホームページと Changes ページへのリクエスト（表示要求）です。

ここでは、たとえばサーバがエラーを返してきた場合など、 リクエストが何らかの原因でエラーになった際どうするかを選択できます。

続行

エラーを無視してテストを続行

Start Next Loop

エラーを無視して次のループの最初から続行

スレッド停止

現在のスレッドを終了

テスト停止

いずれかのサンプルの終了をもってテスト全体が停止

Stop Test Now

即座にテスト全体を停止。 可能であれば現在実行中のサンプルが割り込まれる。

スレッド数 *

同時に何スレッド動かすか（≒最大同時セッション数）
あるユーザの、あるブラウザの１つのタブが１スレッドに相当します。

Ramp-Up期間(秒) *

このスレッドグループについて、１回のテストを回すのに何秒かけるか （スレッドの起動間隔を決定するための係数）。
スレッド数30、Ramp-up期間が120であれば、 各スレッドはおおむね4秒おきに起動されます。
Ramp-up期間が短すぎると、テストの開始時にサーバに高負荷がかかります。

ループ回数 (*)

テストの実行回数。[無限ループ]にチェックを入れると無限にテストします。

スケジューラ (*)

有効にすると、Jmeter が終了する契機が、指定のループ回数終了時、 終了時刻に達した時、持続時間に達した時のうちいずれか早いものになります。 条件チェックは各サンプル間でのみ行われます。 終了条件に達したらスレッドは停止します。 Jmeter は応答を待っているサンプラーには割り込まないので、 実際の終了は状況次第で遅れる場合があります。

開始時刻

スケジューラが有効の場合、この時刻が来るまでテストの実施を待つ。
ただし後述の起動遅延の指定があれば、そちらが優先される。

終了時刻

スケジューラが有効の場合、この時刻までテストが行われる。
ただし後述の持続時間の指定があれば、そちらが優先される。

持続時間

テストをこの時間だけ実行する

起動遅延

この秒数だけテストの実行を遅延する

HTTPリクエスト初期値設定(HTTP Request Defaults)

HTTPリクエスト(Home Page)

名前

HTTPリクエスト識別子。

コメント

詳細な説明を入れておきましょう。

Webサーバ

サーバ名またはIP (*)

リクエスト先のサーバの指定。 http:// は不要（書くとエラーになるので注意）。

ポート番号

リクエスト先のポート番号。デフォルトは80。

Timeouts(millisecond)

Connect

接続タイマー

Response

応答タイマー。応答が分割して送られてくる場合は総応答時間が このタイマー値を越える場合があります。"Duration Assertion" （追加＞アサーション＞アサーションの持続）設定により、 応答時間がかかり過ぎるのを監視できます。

HTTPリクエスト

Implementation

Java, HttpClient3.1, HttpClient4.
（ここでもHTTPリクエスト初期値設定でも）指定がない場合は、 デフォルト値は Jmeter の jmeter.httpsampler プロパティの値に依存する。 これも取得できない場合は HttpClient4 実装が使われる。

プロトコル

HTTP/HTTPS/FILEのいずれか。デフォルトはHTTP

メソッド *

GET, POST, HEAD, TRACE, OPTIONS, PUT, DELETE, PATCH
JAVA 実装ではサポートされない。

Content encoding

（POST, PUT, PATCH, FILE に対して）使われるContent encoding。
文字のエンコーディングとして使われ、HTTP の Content-Encoding ヘッダには影響しない

パス *

リソースへのパス（例：/servlets/myServlet）。
リソースにクエリー文字列パラメータを付加したい場合は 後述の「リクエストで送るパラメータ」に記載すること。 特別なケースとして、パスが "http://" または "https://" で始まっている場合、完全な URL として使われる。 この場合、サーバ／ポート番号／プロトコルの各項目は無視される。 GET および DELETE の場合もパラメータは無視される。
パスはエンコードされないので注意。空白は %20 で記載すること。 また危険な文字はエンコードしておかないと URISyntaxException といったエラーになる場合がある。

自動リダイレクト

利用中の http プロトコルハンドラがリダイレクトに自動追従するようにする。 このためこれらは Jmeter からは見えず、またサンプルとして現れなくなる。 GET と HEAD リクエストの場合にのみ指定すること。 HttpClient サンプラーは POST および PUT についてはこの利用を拒否する。 警告：クッキーとヘッダーの扱いについては後述している。

リダイレクトに対応

これは「自動リダイレクト」が無効の場合にのみ意味を持つ。 セットされた場合、Jmeter のサンプラーは応答がリダイレクトかどうかを チェックし、そうであればそれに従う。 最初のリダイレクトとその後の応答は追加サンプルとして現れる。 親サンプルの URL と データフィールドは最後の（リダイレクトでない） サンプルから取られるが、親のバイトカウントと実行時間は全サンプルの 分を含んでいる。バージョン 2.3.4 以降、初回応答に対しては遅延が 行われるようになった（それ以前はゼロ）。
HttpClient サンプラーが "Redirect requested but followRedirects is disabled" というログメッセージを出すことがあるが、これは無視して良い。
バージョン 2.3.4 以降、Jmeter は '/../segment' 形式のパスについて 絶対および相対リダイレクト URL のいずれにおいても縮める。 たとえば http://host/one/../two は http://host/two にする。 もし必要であれば、Jmeter のプロパティで httpsampler.redirect.removeslashdotdot=false とすることによりこの動作を抑制できる。

KeepAliveを有効にする

Jmeter に Connection: keep-alive ヘッダをセットさせる。 これはデフォルトの HTTP 実装では正しく動作しない。 これは、接続の再利用がユーザ制御配下にないためである。 Apache HttpComponents の HttpClient 実装であれば正しく動作する。

Use multipart/form-data for POST

multipart/form-data もしくは application/x-www-form-urlencoded を使った POST リクエストを使用する。

Browser-compatible headers

multipart/form-data を使う際、Content-Type および Content-Transfer-Encoding ヘッダを使わず、Content-Disposition ヘッダだけを送る。

リクエストで送るパラメータ

パラメータを指定する。

リクエストと一緒に送信されるファイル

アップロードするファイルを指定する。

Proxy Server

サーバ名またはIP

リクエスト先のプロキシサーバの指定。 http:// は不要（書くとエラーになるので注意）。

ポート番号 (*)

リクエスト先のポート番号。デフォルトは80。

ユーザー名

プロキシサーバのユーザー名（オプション）

パスワード

プロキシサーバのパスワード（オプション）

Embedded Resources from HTML Files

全てのイメージとアプレットを繰り返しダウンロードする(HTMLファイルのみ)

Jmeter に HTML ファイルをパースさせ、そのファイルが参照している すべての画像, Javaアプレット, JavaScript, CSS 等についての HTTP/HTTPS リクエストを送る。詳細は後述。

Use concurrent pool.

同時並行コネクションプールを使って埋め込みリソースを取得する。

Size:

埋め込みリソースを取得するための同時並行コネクションプールのサイズ

URLs must match

埋め込み URL としてマッチさせたいものを正規表現で指定する。 たとえば http://example.com/ にある埋め込みリソースのみを ダウンロードした場合は http://example\.com/.* のように指定する。

Source address

(ソースアドレスの型)

[ HTTPClient 実装における HTTP リクエストのみ ] ソースアドレスの値を区別するために型を選択する。

(ソースアドレスの値)

[ HTTPClient 実装における HTTP リクエストのみ ] このサンプルにおける デフォルトのローカル IP アドレスをオーバーライドする。 この場合、Jmeter ホストは（ IP エイリアス、 ネットワークインターフェイスデバイス等により IP を複数 持っている必要がある。 この値はホスト名、IPアドレス、もしくは "eth0", "lo", "wlan0" といったネットワークインターフェイスデバイスを指定可能。 httpclient.localaddress プロパティが設定されている場合は、 すべての HttpClient リクエストについてこの値が使われる。

オプションタスク

モニタとして使用

モニタ結果リスナー（右クリック＞追加＞リスナー＞モニタ結果） で使用する。

Save response as MD5 Hash?

これにチェックを入れると、応答はサンプル結果には格納されない。 その代わり、そのデータの 32 文字の MD5 ハッシュが計算されて格納される。 これは大量データのテストをする場合を意図したものである。

自動リダイレクトにおける注意事項

「自動リダイレクト」を有効にしている場合、クッキーは最初の URL に対してのみ送られる。このため、ローカルサーバへのリダイレクトをする Web サイトが予期しない動作を起こすことがある。

たとえば、www.example.com が www.example.co.uk にリダイレクトするケースを考えてみる。この場合、サーバはおそらく両方の URL に対するクッキーを返す。しかし JMeter には最後のホストの分、すなわち www.example.co.uk のクッキーしか見えない。もしテスト計画にある次のリクエストが www.example.co.uk ではなく www.example.com を使っている場合、 正しいクッキーを受け取れなくなる。同様に、 ヘッダは最初のリクエストに対して送られ、リダイレクトに対しては送られない。

マニュアルでテスト計画を作成する場合、この動作は一般的に問題となる。 一方レコーダーを使って作成されたテスト計画であれば、 リダイレクトされた URL からテストが続けられる。

テスト計画に追加できるコンポーネント

ここまでで、ある程度どんなことができそうかが見えてきたと思います。 これまでは HTTP リクエストにに関することがほとんどでしたが、 Jmeter は汎用的に作られており、HTTP 以外にもいろいろな設定が可能です。

ここからは、テスト計画に対して 右クリック＞追加 から追加できる様々な コンポーネントについて見ていくことにします。 設定項目名のリンク先は本家の（英語）ドキュメントを向けています。

Threads(Users)

Test Fragment

設定エレメント

タイマ

前処理

後処理

アサーション（成立条件チェック）

リスナー（テスト結果の閲覧、レポート）

スレッドグループに追加できるコンポーネント

これまでは、テスト計画全体に対して追加できるコンポーネントについて説明しました。 ここからは、スレッドグループに対して 右クリック＞追加 から追加できる様々な コンポーネントについて見ていくことにします。

テスト計画全体と重複しているコンポーネントについては前述の説明を参照してください。 なお、設定項目名のリンク先は本家の（英語）ドキュメントを向けています。

ロジックコントローラ

ロジックコントローラはループや条件分岐など、 複雑な制御を行うためのコンポーネントです。

サンプラー

サンプラーはサーバなどの試験対象に対して、 何らかの指示やリクエストを行うためのコンポーネント。 サンプラーによりサンプル結果が生成され、 それらの結果はリスナーにより参照できる。

トラブル対応

Out of Memory

Uncaught Exception java.lang.OutOfMemoryError: OutOfMemoryError. See log file for details.

2014/09/08 10:17:04 ERROR - jmeter.JMeter: Uncaught exception:  java.lang.OutOfMemoryError: OutOfMemoryError
    at sun.awt.windows.WToolkit.eventLoop(Native Method)
    at sun.awt.windows.WToolkit.run(Unknown Source)
    at java.lang.Thread.run(Unknown Source)

テストで使用中の端末にメモリの余裕があれば、jmeter{,.bat}ファイルの以下の行でヒープ領域が増やせます。

set HEAP=-Xms512m -Xmx512m

-Xms はメモリ割り当てプールの初期サイズ、-Xmx が最大サイズです。 デフォルトでは、いずれも 512m(512MB) になっています。

実践例

筆者が行った実践例を参考までにご紹介します。 この設定では、実行中に Jmeter がメモリ不足で異常終了したため、 ヒープを 1GB(1024MB) に増やして実行しました。

想定するシナリオとしては以下のようになります。

• 高負荷時にサーバでエラーが起こらないことを確認するため、 エラーが発生したら即終了とする。
• 20秒間に400個のスレッド起動（400ユーザからの同時アクセスのシミュレート）を行う。
• 各スレッド（ユーザ）の初回アクセス時は、 （ブラウザにキャッシュがないので） html だけでなく画像などもすべてロードする。
• それ以降、各スレッドはトップページに何かが掲載されるのを、 F5 リロードで待つ。
  F5 を押す間隔はまちまちだが、最大 5 秒以内にリトライが行われる。
• リロード時はブラウザのキャッシュが効いているので、 画像等のリロードは行われない。
• 10回のリトライでやっと目的のコンテンツが表示され、 そのユーザからのアクセスは終了する。
• Jmeter を動かしているクライアント側に余計な負荷を与えないように、
  クライアント側に負荷をかけるリスナー （結果をツリーで表示、結果を表で表示）等は一時的に無効にしておく。

ページの先頭に戻る

ここもわかりやすそうです（英語）： How to use Controllers in JMeter

サイトトップに戻る