レートリミット

（本機能はExtensionsトライアルで試用可能です）

概要¶

「レートリミット機能」は、特定の利用者・IPアドレス・APIキー単位で、過剰なリクエスト（短時間の大量な画面操作や、エクスポート・インポートなどの重い処理の集中実行）を抑制し、システムの安定稼働を支える機能です。一時的なアクセス集中（バースト）の許容、一定時間内の実行回数制限、同時実行数制限などを柔軟に設定でき、利用環境に応じた負荷制御を実現します。

設定はパラメータファイルRateLimit.jsonで行います。各設定項目の詳細は、パラメータマニュアルRateLimit.jsonを参照してください。

制限事項¶

1. 既定では無効（Modeが"Off"）です。利用するにはRateLimit.jsonで有効化が必要です。
2. 本機能は、利用者・IPアドレス・APIキーなどの「単位ごと」に制限を行うものです。システム全体（全利用者の合算）のリクエスト総量を制限する機能ではありません。

動作モード¶

RateLimit.jsonのトップレベル「Mode」で、機能全体の動作を切り替えます。

導入時は、まず「LogOnly」で実際のアクセス傾向を観測して閾値を調整し、その後「On」に切り替える運用を推奨します。

制限の単位（パーティション）¶

制限は以下の「単位」ごとに、独立してカウントされます。

ポリシー一覧¶

プリザンターでは、機能カテゴリごとに「ポリシー」を定義し、それぞれに上限を設定します。各リクエストは、機能カテゴリに応じたポリシーと、全経路共通の上位ポリシー「GlobalLimiter」の両方の評価を受け、いずれかの上限を超えると遮断されます。

各ポリシーの役割と閾値調整の考え方は、「レートリミット機能：ポリシーと閾値の調整」を参照してください。

制限アルゴリズム¶

制限アルゴリズムとは、レートリミットにおいて一定時間内に行える操作の回数を制限するためのルールです。アルゴリズムごとにアクセスの判定方法や制限の特性が異なるため、利用シーンに応じて適切な方式を選択できます。

上限超過時の動作¶

RateLimit.jsonの「Mode」が「On」のとき、上限を超えたリクエストは「429 Too Many Requests」で遮断されます。応答の形式は、呼び出し元に応じて自動的に切り替わります。

• RateLimit.jsonの「RejectedResponse」の「IncludeRetryAfter」が true の場合、応答に「Retry-After」ヘッダ（再試行までの目安秒数）を付与します。
• 「RateLimit.json」の「RejectedResponse」の「LogRejected」が true の場合、「Mode」が「On」での実拒否が構造化ログ（logs/{年}/{月}/{日}/ratelimitlogs.json）に記録されます。false にしても件数（メトリクス）は常に記録され、「Mode」が「LogOnly」時の仮想拒否ログは本設定に関わらず常に出力されます。
• 拒否・仮想拒否の件数は、一定間隔（既定60秒）でポリシー別に集計され、同じログファイルに「RateLimitMetricsSnapshot」として記録されます。大量拒否で個別ログが間引かれても、件数はこの集計で把握できます。
• 既定ではログはファイルにのみ出力されます。Docker/Kubernetes など標準出力(stdout)でログを収集する環境向けの設定方法はレートリミット機能：拒否ログ・メトリクスの出力先設定を参照してください。

設定の流れ¶

1. パラメータファイルRateLimit.jsonを編集します（「Mode」や各ポリシーの上限値など）。

2. プリザンターを再起動します（「RateLimit.json」は起動時に読み込まれます）。

   • 「パラメータ管理機能」を有効にしている場合は、画面からの編集・再起動も可能です。詳細は「パラメータ管理機能」を参照してください。

3. 「LogOnly」で実際のアクセスを観測し、誤って制限してしまう箇所がないか確認します。

4. 閾値を調整したうえで「Mode」を「On」に切り替えます。

対応バージョン¶

関連情報¶

• レートリミット機能：拒否ログ・メトリクスの出力先設定