よっしー
こんにちは。よっしーです(^^)
今日は、Docker環境でJMeterの実行環境を構築する方法について解説しています。
スポンサーリンク
背景
JMeterを利用した負荷試験をする機会がありましたので、その時の内容を備忘として記事に残しました。
前回記事の内容
前回は、下記のファイル一覧の Makefile を解説しました。本記事では、jmeter/tests/trivial/plan.jmx について解説しています。
new file: jmeter/Dockerfile
new file: jmeter/entrypoint.sh
new file: jmeter/test.sh
new file: jmeter/tests/trivial/plan.jmx
new file: Makefile
new file: compose.yml
jmeter/tests/trivial/plan.jmx
このXMLコードは、Apache JMeterのテストプランの設定を表しています。JMeterは、主にウェブアプリケーションのパフォーマンステストや負荷テストに使用されるオープンソースのソフトウェアツールです。以下に、コードの各部分の解説を示します。
<?xml version="1.0" encoding="UTF-8"?>
<jmeterTestPlan version="1.2" properties="3.1" jmeter="3.1 r1770033">
<hashTree>
<TestPlan guiclass="TestPlanGui" testclass="TestPlan" testname="TrivialTest" enabled="true">
<!-- TestPlan.comments: テストプランに関するコメントを追加するためのプロパティです。 -->
<stringProp name="TestPlan.comments"></stringProp>
<!-- TestPlan.functional_mode: テストプランが機能テストモードで実行されるかどうかを指定します。falseの場合は非機能テストモードです。 -->
<boolProp name="TestPlan.functional_mode">false</boolProp>
<!-- TestPlan.serialize_threadgroups: スレッドグループがシリアライズされるかどうかを指定します。falseの場合は、スレッドグループは並列に実行されます。 -->
<boolProp name="TestPlan.serialize_threadgroups">false</boolProp>
<!-- TestPlan.user_defined_variables: テスト中に使用されるユーザー定義変数を設定します。 -->
<elementProp name="TestPlan.user_defined_variables" elementType="Arguments" guiclass="ArgumentsPanel" testclass="Arguments" testname="User Defined Variables" enabled="true">
<collectionProp name="Arguments.arguments"/>
</elementProp>
<!-- TestPlan.user_define_classpath: JMeterがテストを実行する際に使用するクラスパスを指定します。 -->
<stringProp name="TestPlan.user_define_classpath"></stringProp>
</TestPlan>
</hashTree>
</jmeterTestPlan>
jmeterTestPlan: これはJMeterのテストプラン全体を囲むルート要素です。hashTree: JMeterのテスト要素の階層構造を表します。TestPlan: 実際のテストプランを定義する要素です。testname属性でテストプランの名前を指定します。stringPropやboolProp: テストプランの様々な設定を定義するプロパティです。
このテストプランは、名前が「TrivialTest」という単純なテストで、ユーザー定義変数や追加のクラスパスが特に設定されていない基本的な構成を持っています。
このXMLコードは、Apache JMeterのスレッドグループ設定を表しています。スレッドグループは、ユーザーのシナリオを模倣する仮想ユーザーのグループを定義します。以下に、コードの各部分の解説を示します。
<hashTree>
<ThreadGroup guiclass="ThreadGroupGui" testclass="ThreadGroup" testname="Scenario 1" enabled="true">
<!-- ThreadGroup.on_sample_error: サンプルエラーが発生した場合の動作を指定します。'continue'はエラーが発生してもテストを続行することを意味します。 -->
<stringProp name="ThreadGroup.on_sample_error">continue</stringProp>
<!-- ThreadGroup.main_controller: スレッドグループの実行を制御するループコントローラーを定義します。 -->
<elementProp name="ThreadGroup.main_controller" elementType="LoopController" guiclass="LoopControlPanel" testclass="LoopController" testname="Loop Controller" enabled="true">
<!-- LoopController.continue_forever: ループを無限に続けるかどうかを指定します。falseの場合は、指定された回数だけループします。 -->
<boolProp name="LoopController.continue_forever">false</boolProp>
<!-- LoopController.loops: ループの回数を指定します。ここでは2回ループする設定です。 -->
<stringProp name="LoopController.loops">2</stringProp>
</elementProp>
<!-- ThreadGroup.num_threads: スレッドグループに含まれるスレッド（仮想ユーザー）の数を指定します。ここでは変数${THREADS}を使用しています。 -->
<stringProp name="ThreadGroup.num_threads">${THREADS}</stringProp>
<!-- ThreadGroup.ramp_time: スレッドが開始するまでの時間を秒単位で指定します。ここでは2秒です。 -->
<stringProp name="ThreadGroup.ramp_time">2</stringProp>
<!-- ThreadGroup.start_time と ThreadGroup.end_time: スケジューラーが有効な場合、テストの開始時間と終了時間をエポックタイム（ミリ秒）で指定します。 -->
<longProp name="ThreadGroup.start_time">1373789594000</longProp>
<longProp name="ThreadGroup.end_time">1373789594000</longProp>
<!-- ThreadGroup.scheduler: スケジューラーを使用してテストの実行時間を制御するかどうかを指定します。trueの場合はスケジューラーが有効です。 -->
<boolProp name="ThreadGroup.scheduler">true</boolProp>
<!-- ThreadGroup.duration: スケジューラーが有効な場合、テストの実行時間を秒単位で指定します。ここでは60秒（1分）です。 -->
<stringProp name="ThreadGroup.duration">60</stringProp>
<!-- ThreadGroup.delay: スケジューラーが有効な場合、テスト開始前の遅延時間を秒単位で指定します。ここでは5秒です。 -->
<stringProp name="ThreadGroup.delay">5</stringProp>
<!-- TestPlan.comments: テストプランに関するコメントを追加するためのプロパティです。ここではシナリオ1を実行する仮想ユーザーについての説明があります。 -->
<stringProp name="TestPlan.comments">Virtual Users Running Scenario 1.
Make test last 1 minute (see Scheduler)</stringProp>
</ThreadGroup>
</hashTree>
この設定では、”Scenario 1″という名前のスレッドグループが定義されており、2回のループでテストを実行し、スレッド数は${THREADS}変数で指定されます。スケジューラーは有効になっており、テストは60秒間実行され、5秒の遅延後に開始されます。
このXMLコードは、Apache JMeterのHTTPリクエストデフォルト設定を表しています。これは、HTTPリクエストを送信する際のデフォルトの設定値を定義するために使用されます。以下に、コードの各部分の解説を示します。
<hashTree>
<ConfigTestElement guiclass="HttpDefaultsGui" testclass="ConfigTestElement" testname="HTTP Request Defaults" enabled="true">
<!-- HTTPsampler.Arguments: HTTPリクエストに含める引数（パラメータ）を定義します。 -->
<elementProp name="HTTPsampler.Arguments" elementType="Arguments" guiclass="HTTPArgumentsPanel" testclass="Arguments" testname="User Defined Variables" enabled="true">
<collectionProp name="Arguments.arguments"/>
</elementProp>
<!-- HTTPSampler.domain: HTTPリクエストを送信する対象のドメインを指定します。 -->
<stringProp name="HTTPSampler.domain">${TARGET_HOST}</stringProp>
<!-- HTTPSampler.port: 対象のポート番号を指定します。 -->
<stringProp name="HTTPSampler.port">${TARGET_PORT}</stringProp>
<!-- HTTPSampler.connect_timeout: 接続タイムアウトの時間をミリ秒で指定します。ここでは5000ミリ秒（5秒）です。 -->
<stringProp name="HTTPSampler.connect_timeout">5000</stringProp>
<!-- HTTPSampler.response_timeout: レスポンスタイムアウトの時間をミリ秒で指定します。ここでは30000ミリ秒（30秒）です。 -->
<stringProp name="HTTPSampler.response_timeout">30000</stringProp>
<!-- HTTPSampler.protocol: 使用するプロトコルを指定します。空の場合はHTTPが使用されます。 -->
<stringProp name="HTTPSampler.protocol"></stringProp>
<!-- HTTPSampler.contentEncoding: リクエストのコンテンツエンコーディングを指定します。 -->
<stringProp name="HTTPSampler.contentEncoding"></stringProp>
<!-- HTTPSampler.path: HTTPリクエストを送信するパスを指定します。 -->
<stringProp name="HTTPSampler.path">${TARGET_PATH}</stringProp>
<!-- HTTPSampler.implementation: HTTPリクエストを送信するために使用するHTTPクライアントの実装を指定します。ここではHttpClient4が使用されます。 -->
<stringProp name="HTTPSampler.implementation">HttpClient4</stringProp>
<!-- TestPlan.comments: テストプランに関するコメントを追加するためのプロパティです。ここではタイムアウトの設定についての注意が記載されています。 -->
<stringProp name="TestPlan.comments">Notice Timeouts:
Read to 30s
Connect to 5s</stringProp>
<!-- HTTPSampler.concurrentPool: 同時に実行されるHTTPリクエストの最大数を指定します。ここでは4です。 -->
<stringProp name="HTTPSampler.concurrentPool">4</stringProp>
</ConfigTestElement>
<hashTree/>
</hashTree>
この設定では、HTTPリクエストのデフォルトのドメイン、ポート、パスが変数で指定されており、接続とレスポンスのタイムアウトがそれぞれ5秒と30秒に設定されています。また、HTTPクライアントとしてHttpClient4が使用され、同時に実行されるリクエストの最大数が4に設定されています。これらの設定は、テストプラン内のすべてのHTTPリクエストに適用されます。
このXMLコードは、Apache JMeterのHTTPサンプラーの設定を表しています。HTTPサンプラーは、HTTPリクエストを送信し、レスポンスを受け取るために使用されます。以下に、コードの各部分の解説を示します。
<HTTPSamplerProxy guiclass="HttpTestSampleGui" testclass="HTTPSamplerProxy" testname="HTML Page Test" enabled="true">
<!-- HTTPsampler.Arguments: HTTPリクエストに含める引数（パラメータ）を定義します。 -->
<elementProp name="HTTPsampler.Arguments" elementType="Arguments" guiclass="HTTPArgumentsPanel" testclass="Arguments" testname="Variables pré-définies" enabled="true">
<collectionProp name="Arguments.arguments"/>
</elementProp>
<!-- HTTPSampler.domain: HTTPリクエストを送信する対象のドメインを指定します。 -->
<stringProp name="HTTPSampler.domain"></stringProp>
<!-- HTTPSampler.port: 対象のポート番号を指定します。 -->
<stringProp name="HTTPSampler.port"></stringProp>
<!-- HTTPSampler.connect_timeout: 接続タイムアウトの時間をミリ秒で指定します。 -->
<stringProp name="HTTPSampler.connect_timeout"></stringProp>
<!-- HTTPSampler.response_timeout: レスポンスタイムアウトの時間をミリ秒で指定します。 -->
<stringProp name="HTTPSampler.response_timeout"></stringProp>
<!-- HTTPSampler.protocol: 使用するプロトコルを指定します。 -->
<stringProp name="HTTPSampler.protocol"></stringProp>
<!-- HTTPSampler.contentEncoding: リクエストのコンテンツエンコーディングを指定します。 -->
<stringProp name="HTTPSampler.contentEncoding"></stringProp>
<!-- HTTPSampler.path: HTTPリクエストを送信するパスを指定します。ここではルートディレクトリ('/')が指定されています。 -->
<stringProp name="HTTPSampler.path">/</stringProp>
<!-- HTTPSampler.method: HTTPリクエストのメソッドを指定します。ここでは'GET'メソッドが指定されています。 -->
<stringProp name="HTTPSampler.method">GET</stringProp>
<!-- HTTPSampler.follow_redirects: リダイレクトに自動的に従うかどうかを指定します。 -->
<boolProp name="HTTPSampler.follow_redirects">true</boolProp>
<!-- HTTPSampler.auto_redirects: JMeterが自動的にリダイレクトを処理するかどうかを指定します。 -->
<boolProp name="HTTPSampler.auto_redirects">false</boolProp>
<!-- HTTPSampler.use_keepalive: HTTP Keep-Aliveを使用して接続を維持するかどうかを指定します。 -->
<boolProp name="HTTPSampler.use_keepalive">true</boolProp>
<!-- HTTPSampler.DO_MULTIPART_POST: マルチパート形式のPOSTリクエストを使用するかどうかを指定します。 -->
<boolProp name="HTTPSampler.DO_MULTIPART_POST">false</boolProp>
<!-- HTTPSampler.monitor: モニタリング用のリクエストかどうかを指定します。 -->
<boolProp name="HTTPSampler.monitor">false</boolProp>
<!-- HTTPSampler.embedded_url_re: リクエストに埋め込まれたURLに適用する正規表現を指定します。 -->
<stringProp name="HTTPSampler.embedded_url_re"></stringProp>
</HTTPSamplerProxy>
このHTTPサンプラーは「HTML Page Test」という名前で、GETメソッドを使用してルートディレクトリ(‘/’)にリクエストを送信します。リダイレクトには従いますが、JMeterが自動的にリダイレクトを処理する設定にはなっていません。Keep-Aliveを使用して接続を維持し、マルチパート形式のPOSTリクエストやモニタリング用のリクエストは使用しません。
<hashTree>
<ResponseAssertion guiclass="AssertionGui" testclass="ResponseAssertion" testname="Test-Keyword" enabled="true">
<collectionProp name="Asserion.test_strings">
<stringProp name="-1283727093">${TARGET_KEYWORD}</stringProp>
</collectionProp>
<stringProp name="Assertion.test_field">Assertion.response_data</stringProp>
<boolProp name="Assertion.assume_success">false</boolProp>
<intProp name="Assertion.test_type">16</intProp>
<stringProp name="TestPlan.comments">Test if HTML page contains keyword string</stringProp>
</ResponseAssertion>
<hashTree/>
</hashTree>
<TestAction guiclass="TestActionGui" testclass="TestAction" testname="ThinkTime1s" enabled="true">
<intProp name="ActionProcessor.action">1</intProp>
<intProp name="ActionProcessor.target">0</intProp>
<stringProp name="ActionProcessor.duration">0</stringProp>
</TestAction>
<hashTree>
<UniformRandomTimer guiclass="UniformRandomTimerGui" testclass="UniformRandomTimer" testname="URT" enabled="true">
<stringProp name="ConstantTimer.delay">1000</stringProp>
<stringProp name="RandomTimer.range">100.0</stringProp>
</UniformRandomTimer>
<hashTree/>
</hashTree>このJMeterの設定コードは、負荷テスト中に特定の条件をテストするためのものです。以下に各コンポーネントの詳細を説明します：
- ResponseAssertion:
testname="Test-Keyword": このアサーションの名前は「Test-Keyword」です。enabled="true": このアサーションは有効になっています。${TARGET_KEYWORD}: テスト対象のキーワード。実際のテスト時には、この変数に具体的な値が入ります。Assertion.test_field: テストするフィールドはレスポンスデータです。Assertion.test_type: アサーションのタイプは16で、これは「contains」を意味し、レスポンスデータに指定されたキーワードが含まれているかをチェックします。TestPlan.comments: コメントには「HTMLページにキーワード文字列が含まれているかテストする」と記載されています。
- TestAction (
ThinkTime1s):ActionProcessor.action: アクションタイプは「1」で、これは「停止」を意味します。ActionProcessor.target: ターゲットは「0」で、これは「現在のスレッド」を意味します。ActionProcessor.duration: 期間は「0」で、これはデフォルトの待機時間を意味します。
- UniformRandomTimer (
URT):ConstantTimer.delay: 一定の遅延時間は「1000」ミリ秒（1秒）です。RandomTimer.range: ランダムな範囲は「100.0」ミリ秒です。これは、指定された遅延時間にランダムに0から100ミリ秒を加えることを意味します。
これらの設定は、テストの実行中に特定のキーワードがレスポンスに含まれているかを確認し、その後に一定時間待機し、さらにランダムな時間だけ待機するように設計されています。これにより、テストのリアルタイム性を高め、サーバーの応答をより現実的な状況でテストすることができます。
<Arguments guiclass="ArgumentsPanel" testclass="Arguments" testname="User Defined Variables" enabled="true">
<collectionProp name="Arguments.arguments">
<elementProp name="TARGET_HOST" elementType="Argument">
<stringProp name="Argument.name">TARGET_HOST</stringProp>
<stringProp name="Argument.value">${__P(TARGET_HOST,www.kadaster.nl)}</stringProp>
<stringProp name="Argument.desc">target server domain/IP for testing</stringProp>
<stringProp name="Argument.metadata">=</stringProp>
</elementProp>
<elementProp name="TARGET_PORT" elementType="Argument">
<stringProp name="Argument.name">TARGET_PORT</stringProp>
<stringProp name="Argument.value">${__P(TARGET_PORT,80)}</stringProp>
<stringProp name="Argument.desc">target port on TARGET_HOST for testing</stringProp>
<stringProp name="Argument.metadata">=</stringProp>
</elementProp>
<elementProp name="TARGET_PATH" elementType="Argument">
<stringProp name="Argument.name">TARGET_PATH</stringProp>
<stringProp name="Argument.value">${__P(TARGET_PATH,/zakelijk)}</stringProp>
<stringProp name="Argument.desc">target path on target server</stringProp>
<stringProp name="Argument.metadata">=</stringProp>
</elementProp>
<elementProp name="TARGET_KEYWORD" elementType="Argument">
<stringProp name="Argument.name">TARGET_KEYWORD</stringProp>
<stringProp name="Argument.value">${__P(TARGET_KEYWORD,Zakelijk)}</stringProp>
<stringProp name="Argument.desc">keyword string present in repsonse</stringProp>
<stringProp name="Argument.metadata">=</stringProp>
</elementProp>
<elementProp name="THREADS" elementType="Argument">
<stringProp name="Argument.name">THREADS</stringProp>
<stringProp name="Argument.value">${__P(THREADS,1)}</stringProp>
<stringProp name="Argument.desc">Number of concurrent threads</stringProp>
<stringProp name="Argument.metadata">=</stringProp>
</elementProp>
</collectionProp>
<stringProp name="TestPlan.comments">Example using UDV for symbolic names test target and response to test</stringProp>
</Arguments>
<hashTree/>
</hashTree>このJMeterの設定コードは、ユーザー定義変数を設定するためのものです。各要素はテスト実行時に使用される変数を定義しています。以下に各変数の詳細を説明します：
- TARGET_HOST:
Argument.name: 変数の名前は「TARGET_HOST」です。Argument.value: 変数の値は${__P(TARGET_HOST,www.kadaster.nl)}で、これはJMeterのプロパティ関数__Pを使用しています。これにより、テスト実行時にTARGET_HOSTという名前のプロパティが指定されていない場合、デフォルト値としてwww.kadaster.nlが使用されます。Argument.desc: この変数はテスト対象のサーバーのドメインまたはIPアドレスを指定するために使用されます。
- TARGET_PORT:
Argument.name: 変数の名前は「TARGET_PORT」です。Argument.value: 変数の値は${__P(TARGET_PORT,80)}で、デフォルトのポート番号は80です。Argument.desc: この変数はTARGET_HOSTで指定されたサーバーのテスト対象ポートを指定するために使用されます。
- TARGET_PATH:
Argument.name: 変数の名前は「TARGET_PATH」です。Argument.value: 変数の値は${__P(TARGET_PATH,/zakelijk)}で、デフォルトのパスは/zakelijkです。Argument.desc: この変数はサーバー上のテスト対象パスを指定するために使用されます。
- TARGET_KEYWORD:
Argument.name: 変数の名前は「TARGET_KEYWORD」です。Argument.value: 変数の値は${__P(TARGET_KEYWORD,Zakelijk)}で、デフォルトのキーワードはZakelijkです。Argument.desc: この変数はレスポンスに含まれているべきキーワード文字列を指定するために使用されます。
次のJMeterの設定コードは、ユーザー定義変数（UDV）のTHREADSを設定するためのものです。以下にその詳細を説明します：
<elementProp name="THREADS" elementType="Argument">
<stringProp name="Argument.name">THREADS</stringProp>
<stringProp name="Argument.value">${__P(THREADS,1)}</stringProp>
<stringProp name="Argument.desc">Number of concurrent threads</stringProp>
<stringProp name="Argument.metadata">=</stringProp>
</elementProp>Argument.name: 変数の名前は「THREADS」です。Argument.value: 変数の値は${__P(THREADS,1)}で、これはJMeterのプロパティ関数__Pを使用しています。これにより、テスト実行時にTHREADSという名前のプロパティが指定されていない場合、デフォルト値として1が使用されます。Argument.desc: この変数は同時に実行されるスレッドの数を指定するために使用されます。
TestPlan.commentsには「UDVを使用してテスト対象とテストのためのレスポンスにシンボリック名を使用する例」と記載されており、これはテスト計画における変数の使用例を示しています。
この設定は、テストの実行時にスレッド数を柔軟に変更できるようにするために重要です。特に、負荷テストやパフォーマンステストを行う際に、異なるスレッド数でテストを実行してシステムの挙動を観察することが一般的です。__P関数は、コマンドラインからまたは外部の設定ファイルから値を注入することを可能にし、テストの再利用性と柔軟性を向上させます。
<ResultCollector guiclass="ViewResultsFullVisualizer" testclass="ResultCollector" testname="View Results Tree" enabled="true">
<boolProp name="ResultCollector.error_logging">false</boolProp>
<objProp>
<name>saveConfig</name>
<value class="SampleSaveConfiguration">
<time>true</time>
<latency>true</latency>
<timestamp>true</timestamp>
<success>true</success>
<label>true</label>
<code>true</code>
<message>true</message>
<threadName>true</threadName>
<dataType>false</dataType>
<encoding>false</encoding>
<assertions>true</assertions>
<subresults>true</subresults>
<responseData>false</responseData>
<samplerData>false</samplerData>
<xml>false</xml>
<fieldNames>true</fieldNames>
<responseHeaders>false</responseHeaders>
<requestHeaders>false</requestHeaders>
<responseDataOnError>false</responseDataOnError>
<saveAssertionResultsFailureMessage>true</saveAssertionResultsFailureMessage>
<assertionsResultsToSave>0</assertionsResultsToSave>
<bytes>true</bytes>
<threadCounts>true</threadCounts>
<idleTime>true</idleTime>
<connectTime>true</connectTime>
</value>
</objProp>
<stringProp name="TestPlan.comments">For scripting only</stringProp>
<stringProp name="filename"></stringProp>
</ResultCollector>
<hashTree/>
</hashTree>
</hashTree>
</jmeterTestPlan>このコードは、Apache JMeterのテストプランの一部で、ResultCollectorという要素の設定をXML形式で記述しています。ResultCollectorは、テスト実行中に収集されたサンプルデータ（テスト結果）を保存するためのコンポーネントです。具体的には、以下の設定が含まれています：
- error_logging: エラーロギングを行うかどうかの設定。ここでは
falseに設定されているため、エラーログは記録されません。 - saveConfig: どのテスト結果の情報を保存するかを指定する設定。例えば、
time、latency、timestampなどがtrueに設定されており、これらの情報がログに含まれます。一方で、responseDataやrequestHeadersはfalseに設定されているため、これらの情報は含まれません。 - TestPlan.comments: テストプランに関するコメント。ここでは「For scripting only」と記述されています。
- filename: 結果を保存するファイル名。ここでは空の文字列が設定されているため、ファイル名は指定されていません。
この設定は、JMeterのGUIモードで「View Results Tree」というリスナーを使用する際に適用されるもので、テスト結果を視覚的に表示し、指定された情報をログファイルに保存するためのものです1。
詳細な解説や使用方法については、Apache JMeterの公式ドキュメントや関連する技術記事を参照すると良いでしょう。
おわりに
今日は、Docker環境でJMeterの実行環境を構築する方法について解説しました。
よっしー
何か質問や相談があれば、コメントをお願いします。また、エンジニア案件の相談にも随時対応していますので、お気軽にお問い合わせください。
それでは、また明日お会いしましょう(^^)
コメント