Elasticsearch:Use the cluster throttling plug-in (aliyun-qos)

最新の V7.10 バージョン

その他のバージョン

PUT _cluster/settings
{
  "persistent": {
    "apack.qos.limiter.enabled": true
  }
}

PUT _cluster/settings
{
  "persistent": {
    "apack.qos.ratelimit.enabled": "true"
  }
}

メソッド

最新の V7.10 バージョン

その他のバージョン

リミッターパラメーターを `false` に設定

PUT _cluster/settings
{
  "persistent": {
    "apack.qos.limiter.enabled": false
  }
}

PUT _cluster/settings
{
  "persistent": {
    "apack.qos.ratelimit.enabled": "false"
  }
}

リミッターパラメーターを `null` に設定

PUT _cluster/settings
{
  "persistent": {
    "apack.qos.limiter.enabled": null
  }
}

PUT _cluster/settings
{
  "persistent": {
    "apack.qos.ratelimit.enabled": null
  }
}

パラメーター

説明

値

action

速度制限の対象となるアクション。異なるタイプのリクエストを制限するために使用されます。

• write： ドキュメントの書き込みリクエスト。`index` および `create` 操作を含みます。

• update： ドキュメントの更新リクエスト。

• delete： ドキュメントの削除リクエスト。

• search： クエリリクエスト。

• search_shards： インデックスのシャード総数をクエリするリクエスト。

limiter_type

速度制限タイプ。レート、同時実行数、リクエストごとの制限の 3 つのカテゴリがサポートされています。

• rate： レート制限。整数のみ受け付けます。

• qps： クエリレート。整数のみ受け付けます。

• tps： 書き込みレート。整数のみ受け付けます。

• throughput： データスループット。`write`、`update`、`delete` アクションでのみサポートされます。単位は GB、MB、KB があります。最大値は 2 GB です。

• thread_count： 同時リクエスト数を制限します。

• concurrent_count： リクエストの同時実行数。リクエスト内の特定の操作に基づいて計算されます。たとえば、search_shards.concurrent_count:20 は、最大 20 の同時シャードクエリを許可します。

• max_per_request： 1 つのリクエスト内の特定のタイプの操作の最大数。たとえば、update.max_per_request:10 は、1 つの Bulk リクエストで最大 10 の更新操作を許可します。

• max_size_per_request： 1 つのリクエストの最大サイズ。`write`、`update`、`delete` アクションでのみサポートされます。

threshold

速度制限のしきい値。

-1 以上の整数。

一部のタイプは単位付きの文字列をサポートしています。詳細については、`limiter_type` の説明をご参照ください。

tagName

タグ名。

• node： 現在のノードの名前。

• is_master： 現在のノードがマスターノードであるかどうかを指定します。対応するタグ値は `true` または `false` です。

• index： インデックス名。複数のインデックスの場合は、配列を使用します。エイリアスが渡された場合、実際のインデックス名に解決されます。このタグは `IndicesRequest` のサブクラスでのみ使用可能です。

• shard： シャード名。`index[id]` の形式です。例： `test[0]`。このタグは `ReplicationRequest` のサブクラスでのみ使用可能です。

• index_in_url： URL からのインデックス文字列。エイリアスが渡された場合、このタグはエイリアスを保持します。このタグは `IndicesRequest` のサブクラスでのみ使用可能です。

tagValue

タグ値。

文字列または文字列の配列。配列が使用された場合、タグは配列内のいずれかの値に一致します。完全一致、ワイルドカード付きのプレフィックス一致、およびすべての値がサポートされています。例：

• 完全一致： "abc"

• プレフィックス一致： "ab*"

• すべての値： "**"

  ワイルドカード値を使用すると、デフォルトのスロットラーが定義されます。これは、このタグの任意の値に対して特定のスロットラーが生成されることを意味します。たとえば、index:"**",search.tps:1 を指定すると、各インデックスの検索レートは、合計検索レートが 1 に制限されるのではなく、デフォルトで 1 に制限されます。

priority

リミッターの優先度。

整数。デフォルト値： 0。

値が大きいほど優先度が高くなります。リクエストが複数のデフォルトリミッターに一致する場合、最も優先度の高いものだけが有効になります。

params

高度なパラメーター。

watchMode： 監視モードを有効にするかどうかを指定します。有効な値： `true` および `false` (デフォルト)。`true` に設定すると、Elasticsearch は拒否されたリクエスト数をメトリクスに記録しますが、制限は強制しません。これにより、ルールを適用する前にその効果をプレビューでき、設定ミスを防ぐことができます。API の詳細については、よくある質問のセクションをご参照ください。

アクション

最新の V7.10 バージョン

その他のバージョン

すべてのリミッター設定の取得

GET /_qos/limiter

GET /_qos/_ratelimit

指定した単一のリミッター設定の取得

GET /_qos/limiter/<limiterName>

GET /_qos/_ratelimit/<limiterName>

指定した複数のリミッター設定の取得。複数のリミッター名はカンマ (,) で区切ります。ワイルドカードはサポートされていません。

GET /_qos/limiter/<limiterName1,limiterName2>

GET /_qos/_ratelimit/<limiterName1,limiterName2>

アクション

最新の V7.10 バージョン

その他のバージョン

指定した単一のリミッター設定の削除

DELETE /_qos/limiter/<limiterName>

DELETE /_qos/_ratelimit/<limiterName>

指定した複数のリミッター設定の削除。複数のリミッター名はカンマ (,) で区切ります。ワイルドカードはサポートされていません。

DELETE /_qos/limiter/<limiterName1,limiterName2>

DELETE /_qos/_ratelimit/<limiterName1,limiterName2>