JMeterでNestJS APIの負荷テストをする
作ったCRUD APIがどこまで耐えるか、JMeterでGET・POSTエンドポイントに負荷をかけてスループットとレスポンスタイムを計測する
NestJSでCRUD APIを作る(Prisma + SQLite)で作ったAPIが動いている前提で進める。
この記事では、そのAPIに対してJMeterで負荷をかけ、スループット(req/s)とレスポンスタイムを計測する。JMeterのインストールと基本的なTest Planの作り方はJMeterで負荷テストを始めるを参照。
この記事でやること
- NestJS CRUD APIをローカルで起動する
- GETエンドポイント(
/users)に20スレッドで負荷をかける - POSTエンドポイント(
/users)にCounterで連番メールを生成しながら負荷をかける - CLI実行でJMXを回す
- SQLiteの書き込み限界を実際の数値で確認する
APIを起動する
cd nestjs-practice/api-sample # 自分のプロジェクト名に合わせる
pnpm run start:devhttp://localhost:3000/users にアクセスしてJSONが返れば準備完了。
GETエンドポイントの負荷テスト
Thread Group設定
| 設定 | 値 |
|---|---|
| Number of Threads | 20 |
| Ramp-up Period | 2 秒 |
| Loop Count | 10 |
→ 20スレッド × 10ループ = 200リクエスト
HTTP Request設定
| 設定 | 値 |
|---|---|
| Server Name | localhost |
| Port | 3000 |
| Method | GET |
| Path | /users |
事前にユーザーをいくつかPOSTしておくと、レスポンスボディにデータが含まれ、より実際のAPIに近い計測になる。
curl -s -X POST http://localhost:3000/users \
-H "Content-Type: application/json" \
-d '{"email":"seed1@example.com","name":"Seed User 1"}'
curl -s -X POST http://localhost:3000/users \
-H "Content-Type: application/json" \
-d '{"email":"seed2@example.com","name":"Seed User 2"}'期待する結果
- Error %: 0% → 全リクエストが200を返している
- Throughput → SQLiteのローカル読み込みは速いため、数百 req/s 程度は出やすい
POSTエンドポイントの負荷テスト
同じメールアドレスを繰り返しPOSTすると一意制約でエラーになる。Config Element の Counter を使い、リクエストごとにユニークなメールを生成する。
Thread Group設定
| 設定 | 値 |
|---|---|
| Number of Threads | 10 |
| Ramp-up Period | 1 秒 |
| Loop Count | 10 |
→ 10スレッド × 10ループ = 100リクエスト
Counter設定
Thread Group を右クリック → Add → Config Element → Counter
| 設定 | 値 |
|---|---|
| Starting value | 1 |
| Increment | 1 |
| Reference Name | USER_NUM |
HTTP Request設定
| 設定 | 値 |
|---|---|
| Server Name | localhost |
| Port | 3000 |
| Method | POST |
| Path | /users |
Body Data(「Body Data」タブに記入):
{"email":"user${USER_NUM}@example.com","name":"User ${USER_NUM}"}${USER_NUM} がリクエストごとに 1, 2, 3 … と増えていく。
HTTP Header Managerの追加
HTTP RequestのBody DataにJSONを送るにはヘッダーが必要。
Thread Group を右クリック → Add → Config Element → HTTP Header Manager
| Name | Value |
|---|---|
Content-Type | application/json |
JMXファイル(そのまま使えるサンプル)
GUIでTest Planを組まずに試したい場合は、次のJMXをそのまま使える。nestjs-loadtest.jmx などの名前で保存する。
<?xml version="1.0" encoding="UTF-8"?>
<jmeterTestPlan version="1.2" properties="5.0">
<hashTree>
<TestPlan guiclass="TestPlanGui" testclass="TestPlan" testname="NestJS Load Test">
<elementProp name="TestPlan.user_defined_variables" elementType="Arguments">
<collectionProp name="Arguments.arguments"/>
</elementProp>
</TestPlan>
<hashTree>
<!-- GET /users -->
<ThreadGroup guiclass="ThreadGroupGui" testclass="ThreadGroup" testname="GET /users">
<intProp name="ThreadGroup.num_threads">20</intProp>
<intProp name="ThreadGroup.ramp_time">2</intProp>
<stringProp name="ThreadGroup.on_sample_error">continue</stringProp>
<elementProp name="ThreadGroup.main_controller" elementType="LoopController">
<boolProp name="LoopController.continue_forever">false</boolProp>
<intProp name="LoopController.loops">10</intProp>
</elementProp>
</ThreadGroup>
<hashTree>
<HTTPSamplerProxy guiclass="HttpTestSampleGui" testclass="HTTPSamplerProxy" testname="GET /users">
<stringProp name="HTTPSampler.domain">localhost</stringProp>
<intProp name="HTTPSampler.port">3000</intProp>
<stringProp name="HTTPSampler.path">/users</stringProp>
<stringProp name="HTTPSampler.method">GET</stringProp>
<boolProp name="HTTPSampler.follow_redirects">true</boolProp>
<boolProp name="HTTPSampler.use_keepalive">true</boolProp>
</HTTPSamplerProxy>
<hashTree/>
<ResultCollector guiclass="SummaryReport" testclass="ResultCollector" testname="Summary Report - GET">
<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>true</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>
<bytes>true</bytes>
<sentBytes>true</sentBytes>
<url>true</url>
<threadCounts>true</threadCounts>
<idleTime>true</idleTime>
<connectTime>true</connectTime>
</value>
</objProp>
<stringProp name="filename"></stringProp>
</ResultCollector>
<hashTree/>
</hashTree>
<!-- POST /users -->
<ThreadGroup guiclass="ThreadGroupGui" testclass="ThreadGroup" testname="POST /users">
<intProp name="ThreadGroup.num_threads">10</intProp>
<intProp name="ThreadGroup.ramp_time">1</intProp>
<stringProp name="ThreadGroup.on_sample_error">continue</stringProp>
<elementProp name="ThreadGroup.main_controller" elementType="LoopController">
<boolProp name="LoopController.continue_forever">false</boolProp>
<intProp name="LoopController.loops">10</intProp>
</elementProp>
</ThreadGroup>
<hashTree>
<CounterConfig guiclass="CounterConfigGui" testclass="CounterConfig" testname="Counter">
<stringProp name="CounterConfig.start">1</stringProp>
<stringProp name="CounterConfig.end"></stringProp>
<stringProp name="CounterConfig.incr">1</stringProp>
<stringProp name="CounterConfig.name">USER_NUM</stringProp>
<stringProp name="CounterConfig.format"></stringProp>
<boolProp name="CounterConfig.is_per_user">false</boolProp>
</CounterConfig>
<hashTree/>
<HTTPSamplerProxy guiclass="HttpTestSampleGui" testclass="HTTPSamplerProxy" testname="POST /users">
<stringProp name="HTTPSampler.domain">localhost</stringProp>
<intProp name="HTTPSampler.port">3000</intProp>
<stringProp name="HTTPSampler.path">/users</stringProp>
<stringProp name="HTTPSampler.method">POST</stringProp>
<boolProp name="HTTPSampler.follow_redirects">true</boolProp>
<boolProp name="HTTPSampler.use_keepalive">true</boolProp>
<boolProp name="HTTPSampler.postBodyRaw">true</boolProp>
<elementProp name="HTTPsampler.Arguments" elementType="Arguments">
<collectionProp name="Arguments.arguments">
<elementProp name="" elementType="HTTPArgument">
<boolProp name="HTTPArgument.always_encode">false</boolProp>
<stringProp name="Argument.value">{"email":"user${USER_NUM}@example.com","name":"User ${USER_NUM}"}</stringProp>
<stringProp name="Argument.metadata">=</stringProp>
</elementProp>
</collectionProp>
</elementProp>
</HTTPSamplerProxy>
<hashTree>
<HeaderManager guiclass="HeaderPanel" testclass="HeaderManager" testname="HTTP Header Manager">
<collectionProp name="HeaderManager.headers">
<elementProp name="" elementType="Header">
<stringProp name="Header.name">Content-Type</stringProp>
<stringProp name="Header.value">application/json</stringProp>
</elementProp>
</collectionProp>
</HeaderManager>
<hashTree/>
</hashTree>
<ResultCollector guiclass="SummaryReport" testclass="ResultCollector" testname="Summary Report - POST">
<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>true</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>
<bytes>true</bytes>
<sentBytes>true</sentBytes>
<url>true</url>
<threadCounts>true</threadCounts>
<idleTime>true</idleTime>
<connectTime>true</connectTime>
</value>
</objProp>
<stringProp name="filename"></stringProp>
</ResultCollector>
<hashTree/>
</hashTree>
</hashTree>
</hashTree>
</jmeterTestPlan>CLI実行
rm -rf ./report && jmeter -n -t nestjs-loadtest.jmx -l results.jtl -e -o ./report
open ./report/index.html # macOSGETとPOSTの Thread Group が両方含まれているため、実行すると順番に走る。HTMLレポートの Statistics タブで、GETとPOSTそれぞれの Throughput・Average・Error % を比較できる。
結果から読み取れること
| 観点 | 確認ポイント |
|---|---|
| GET の Error % | 0% であれば全件成功。0% でなければ View Results Tree で原因を確認する |
| GET の Throughput | 数百 req/s 程度は出やすい。SQLiteのローカル読み込みは速い |
| POST の Error % | Counter が正しく動いていれば一意制約エラーは起きない |
| POST の Throughput | スレッド数を増やしても頭打ちになる → SQLite書き込みの上限 |
| 90th pct | Average よりはるかに大きければ、一部リクエストに外れ値がある |
実装チェックリスト
- NestJS APIを起動して
GET /usersのレスポンスを確認する - シードデータをPOSTして、GETで取得できることを確認する
- GET /users のThread Groupを設定して実行する(Error % が 0 になることを確認)
- CounterとHTTP Header Managerを設定してPOST /users を実行する
- GETとPOSTのThroughputの差を確認し、SQLiteの書き込み特性を体感する
- CLIでJMXを実行してHTMLレポートを確認する