旧バージョンのドキュメントを参照しています。 最新のドキュメントはこちらをご参照ください。

Rate Limiting

流量制限は、アップストリームサービスに送信されるリクエストレートを制御します。DoS攻撃を防止し、Webスクレイピングやその他の過剰使用を制限するために使用できます。流量制限を使用しない場合、クライアントはアップストリームのサービスに無制限にアクセスできますが、可用性に悪影響を及ぼす可能性があります。

Rate Limiting プラグイン

Kong Gatewayは、Rate Limitingプラグインを使用してクライアントに流量制限を課します。 流量制限を有効にすると、クライアントは設定可能な期間内に実行できるリクエストの数が制限されます。プラグインはクライアントをコンシューマとして識別するか、リクエストのクライアントIPアドレスによって識別することをサポートします。

このチュートリアルでは、Rate Limiting

Available in Enterprise Free mode (without a license)

プラグインを使用します。また、 Rate Limiting Advanced

Available with Kong Gateway Enterprise subscription - Contact Sales

プラグインも使用可能です。上級バージョンでは、スライディングウィンドウアルゴリズム のサポートや高度な Redis サポートなど、より高いパフォーマンスのための追加機能が提供されます。

流量制限の管理

次のチュートリアルでは、 Kong Gatewayのさまざまな側面における流量制限の管理について説明します。

前提条件

この章は、「 Get Started with Kong 」シリーズの一部です。最適な効果を得るために、シリーズを最初からご覧になることをお勧めします。

まずは、導入として Get Kong から始めましょう。ここには、ローカル Kong Gateway を実行するための前提のツールと手順が含まれています。

ガイドの手順2のサービスとルートには、このシリーズで使われているモックサービスのインストール方法が記載されています。

これらの手順をまだ完了していない場合は、続行する前に完了してください。

グローバル流量制限

プラグインをグローバルにインストールすると、Kong Gatewayへの すべて のプロキシリクエストが流量制限の実行対象となります。

1. 流量制限を有効にする

   レート制限プラグインはデフォルトでKong Gatewayにインストールされており、有効にすることができます。 Admin API のプラグインオブジェクトにPOSTリクエストを送信します。

   curl -i -X POST http://localhost:8001/plugins \
     --data name=rate-limiting \
     --data config.minute=5 \
     --data config.policy=local
   

   このコマンドは、すべてのルートおよびサービスに対して、クライアントIPアドレスごとに 1 分あたり最大 5 件のリクエストを課すようKong Gatewayに指示しました。

   policy 構成により、Kong Gateway 制限を取得し、増分させる場所が決まります。詳細については、すべてのプラグイン設定リファレンスを参照してください。

   次のような識別情報を含む、新しいプラグイン構成を持つ応答が表示されます。

   ...
   "id": "fc559a2d-ac80-4be8-8e43-cb705524be7f",
   "name": "rate-limiting",
   "enabled": true
   ...
   

2. 検証

   流量制限を設定したら、設定された制限時間内に許可される数よりも多くのリクエストを送信することで、 正しく構成され機能していると確認できます。

   Command Line

   Web browser

   次のコマンドを実行して、6 つの模擬リクエストをすばやく送信します。

   for _ in {1..6}; do curl -s -i localhost:8000/mock/anything; echo; sleep 1; done

   ブラウザでhttp://localhost:8000/mock/anythingを開き、1 分以内にページを6回更新します。

6 回目のリクエストの後、429「API レート制限を超えました」エラーを受け取ります。

{
   "message": "API rate limit exceeded"
}

サービスレベル流量制限

Rate Limitingプラグインは特定のサービスに対して有効にできます。リクエストは上記と同じです。 ただし、サービス URL に投稿されます。

curl -X POST http://localhost:8001/services/example_service/plugins \
   --data "name=rate-limiting" \
   --data config.minute=5 \
   --data config.policy=local

ルートレベルの流量制限

Rate Limitingプラグインは特定のルートに対して有効にすることができます。リクエストは上記と同じですが、 ルートURLに投稿されます。

curl -X POST http://localhost:8001/routes/example_route/plugins \
   --data "name=rate-limiting" \
   --data config.minute=5 \
   --data config.policy=local

コンシューマレベルの流量制限

コンシューマとはKong Gatewayでは、サービスのユーザーを定義する抽象的概念です。 コンシューマレベルの流量制限はコンシューマごとのリクエスト流量を制限するために使用できます。

1. コンシューマを作成する

   コンシューマは、Admin APIのコンシューマオブジェクトを使用して作成されます。

   curl -X POST http://localhost:8001/consumers/ \
     --data username=jsmith
   

2. コンシューマの流量制限を有効にする

   消費者IDを使用して、すべてのルートとサービスのレート制限を有効にします jsmith コンシューマー。

   curl -X POST http://localhost:8001/plugins \
      --data "name=rate-limiting" \
      --data "consumer.username=jsmith" \
      --data "config.second=5"
   

詳細な流量制限

大規模な本番シナリオでは、効果的な流量制限には高度な技術が必要になる場合があります。上記の基本的な流量制限プラグインでは、固定時間ウィンドウに対する制限のみを定義できます。固定時間ウィンドウは多くの場合において十分ですが、デメリットもあります。

• 固定ウィンドウの境時間近辺にリクエストが殺到すると、トラフィックの急増中にウィンドウカウンターがリセットされるためリソースの逼迫につながる場合があります。
• 複数のクライアントアプリケーションが、リクエストを再開するため 固定時間枠がリセットされるのを待っている可能性があります。固定ウィンドウがリセットされると、複数のクライアントによって システムにリクエストが殺到し、上流のサービスに多大な影響を与える可能性があります。

Rate Limiting Advanced