毎秒のリクエスト数

/actuator/qps は、直近のウィンドウでサーバーが毎秒いくつのリクエストを受け取ったか、それらにどれだけ時間がかかったか、いくつ失敗したかを、すべての isolate についてと合計で応答します。Web スターターのデバッグ機能 qps の JSON であり、その機能がビルドに入っているときにだけ存在します。

使う理由

この機能は、ウィンドウごとに 1 行をログに出します。負荷テスト、ダッシュボード、スクリプトは、同じ数値をデータとして必要とし、しかも自分で選んだ時点で必要とします。10 秒ごとではなく、テストの各ステップの後です。

例

# lib/resources/application.yml
spring:
  web:
    debug:
      qps:
        enabled: true      # ビルドが読みます: 変更したら build_runner を実行します
management:
  endpoints:
    web:
      exposure:
        include: health,qps
$ curl localhost:8080/actuator/qps
{"seconds": 10.0, "qps": 1250.4, "requests": 12504, "errors": 0,
 "active": 14, "p50Micros": 1139, "p95Micros": 5767, "p99Micros": 8650,
 "isolates": {
   "main": {"qps": 412.0, "requests": 4120, "errors": 0, "active": 5,
            "p50Micros": 1139, "p95Micros": 5767, "p99Micros": 8650},
   "isolate-1": {"qps": 420.2, "...": "..."},
   "isolate-2": {"qps": 418.2, "...": "..."}}}

二つのリクエスト

リクエスト 応答
GET /actuator/qps 直近のウィンドウ。長さは spring.web.debug.qps.log-interval (10 秒) です。最初のウィンドウが過ぎるまでは {}
GET /actuator/qps/now ウィンドウを今終わらせ、それを応答します
GET /actuator/qps/<それ以外> 404

/now は、各ステップの後に読む負荷テストのためのものです。応答は、前回見たときからの時間をちょうどカバーします。

応答の内容

キー 意味
seconds ウィンドウの長さ
qps 毎秒のリクエスト数。小数第 1 位まで
requests ウィンドウの中で応答されたリクエスト
errors そのうち 5xx ステータスで応答されたもの、またはエラーで終わったもの
active ウィンドウの終わりの時点で実行中のリクエスト
p50Micros、p95Micros、p99Micros リクエストの半分、95 %、99 % がその値以下で応答されたレイテンシー。単位はマイクロ秒。リクエストがなければ省かれます
isolates 名前ごとの各 isolate についての同じ数値。最初の isolate が先頭です

パーセンタイルはレイテンシーのバケットの境界であり、正確な時間ではありません。値は、実際の値の最大で 1.5 倍です。何が数えられ、何が数えられないか (isolate を待つ時間、いっぱいで拒否されたリクエスト) は この機能のページ にあります。

isolate のプールがある場合

数値はすべての isolate のもので、最初の isolate で合計されます。エンドポイントはすべての isolate に存在し、最初の isolate に問い合わせます (primaryIsolate Bean、ハンドラー web.qps を通じて)。そのため、どの isolate がリクエストを受け取っても、応答は同じです。

/now は、どの isolate に問い合わせても、アプリケーションのただ一つのウィンドウを終わらせます。

公開

このエンドポイントは、ビルドにこの機能があるときに存在します (application.yml または application.properties の、プロファイルなしの spring.web.debug.qps.enabled: true)。その場合、デフォルトで有効ですが、health 以外のすべてのエンドポイントと同じく、qps が management.endpoints.web.exposure.include に入るまで HTTP では公開されません。

この機能がなければ、何を公開していても /actuator/qps は 404 です。qpsEndpoint Bean も、数えるコードもありません。

management.endpoint.qps.access=none はエンドポイントを無効にし、ログの行は残します。他のエンドポイントと同じように保護してください (セキュリティ を参照)。

Spring (Java) との対応

Spring Boot で対応するのは、Micrometer の http.server.requests タイマーを持つ metrics エンドポイントです。あちらはメトリクスのシステムで、こちらはデバッグ機能の直近のウィンドウです。

関連項目