Elasticsearch:aliyun-qosプラグインを使用する

方法

Elasticsearch V7.10クラスターにインストールされているプラグインの最新バージョンのコード

他のバージョンのElasticsearchクラスターにインストールされているプラグインのコード

調整機能に関連するパラメーターを 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：ドキュメントの書き込み操作。ドキュメントのインデックス作成または作成が含まれます。

• update：ドキュメントの更新操作。

• delete：ドキュメントの削除操作。

• search：クエリ操作。

• search_shards：インデックスのプライマリおよびレプリカシャードの総数をクエリするために使用されるクエリ操作。

limiter_type

調整タイプ。次の調整タイプがサポートされています。

• レート

• 同時スレッド数

• 単一リクエスト

• rate：レート。このパラメーターを rate に設定した場合、threshold パラメーターは整数にのみ設定できます。

• qps：QPS。このパラメーターを qps に設定した場合、threshold パラメーターは整数にのみ設定できます。

• tps：1秒あたりのトランザクション数（TPS）。このパラメーターを tps に設定した場合、threshold パラメーターは整数にのみ設定できます。

• throughput：スループット。 action パラメーターを write、update、または delete に設定した場合にのみ、このパラメーターを throughput に設定できます。このパラメーターを throughput に設定した場合、threshold パラメーターでサポートされる単位は GB、MB、KB であり、threshold パラメーターの最大値は 2 GB です。

• thread_count：リクエストに使用できる同時スレッド数。デフォルトでは、1つのリクエストに1つのスレッドが使用されます。

• concurrent_count：リクエストに使用できる同時スレッド数。このパラメーターを concurrent_count に設定した場合、threshold パラメーターの値は、リクエストで指定された操作に基づいて計算されます。たとえば、limiters 構成項目で search_shards.concurrent_count:20 を指定した場合、最大 20 の同時スレッドを使用して、インデックスのプライマリまたはレプリカシャードの数をクエリできます。

• max_per_request：単一のリクエストで特定の種類の操作の実行が許可される最大回数。たとえば、update.max_per_request:10 を指定した場合、書き込みリクエストでは最大 10 の更新操作が許可されます。

• max_size_per_request：単一のリクエストで許可される操作の最大数。 action パラメーターを write、update、または delete に設定した場合にのみ、このパラメーターを max_size_per_request に設定できます。

threshold

調整しきい値。

-1以上の整数。

tagName

タグキー。

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

• is_master：現在のノードが専用マスターノードであるかどうかを指定します。 tagName パラメーターをこの値に設定した場合、tagValue パラメーターの値は true または false です。

• index：インデックスの名前。複数のインデックス名を指定する場合は、tagValue パラメーターをインデックス名で構成される配列に設定します。 tagValue パラメーターをインデックスのエイリアスに設定した場合、aliyun-qosプラグインはインデックスの実際の名前を解析し、実際の名前に基づいてインデックスの調整を実行します。 tagName パラメーターは、IndicesRequest タイプのサブリクエストに対してのみこの値に設定できます。

• shard：プライマリまたはレプリカシャードの名前。このパラメーターを shard に設定した場合、tagValue パラメーターを test[0] などの index[id] 形式の値に設定する必要があります。 tagName パラメーターは、ReplicationRequest タイプのサブリクエストに対してのみこの値に設定できます。

• index_in_url：URL内のインデックス名の文字列。 tagValue パラメーターをインデックスのエイリアスに設定した場合、aliyun-qosプラグインはエイリアスで示されたインデックスの調整を実行します。 tagName パラメーターは、IndicesRequest タイプのサブリクエストに対してのみこの値に設定できます。

tagValue

タグ値。

文字列または配列。配列が指定されている場合、調整は配列内のいずれかの要素に一致するリソースに適用されます。タグ値には、完全一致、あいまい一致、およびすべての値がサポートされています。例：

• 完全一致："abc"

• あいまい一致："ab*"

• すべての値："**"

  説明

  tagValue パラメーターを "**" に設定すると、デフォルトリミッターが使用されます。これは、タグに一致する各リソースに対してリミッターが生成されることを示します。たとえば、index:"**",search.tps:1 を指定した場合、すべてのインデックスではなく、各インデックスの検索速度はデフォルトで 1 に制限されます。

priority

優先度。

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

params

詳細パラメーター。

watchMode：監視モードを有効にするかどうかを指定します。有効な値：true および false。デフォルト値：false。 watchMode パラメーターを true に設定すると、Elasticsearch は関連するメトリックで拒否されたリクエストの数のみを記録し、調整は実行しません。 API を呼び出してメトリックの監視データを表示し、事前に調整効果を確認できます。これにより、不適切な構成によって引き起こされる予期しない調整効果を防ぎます。詳細については、FAQ をご参照ください。

操作

Elasticsearch V7.10クラスターにインストールされているプラグインの最新バージョンのコード

他のバージョンのElasticsearchクラスターにインストールされているプラグインのコード

特定のインデックスのQPSの調整を構成する

PUT /_qos/limiter/<limiterName>
{
  "limiters": {
    "search.qps": "1000"
  },
  "tags": {
    "index": "twitter"
  }
}

PUT _qos/_ratelimit/<limiterName>
{
   "search.index_patterns" : "twitter",
   "search.max_queries_per_sec" : 1000
}

名前に特定のプレフィックスが付いているインデックスのQPSの調整を構成する

PUT /_qos/limiter/<limiterName>
{
  "limiters": {
    "search.qps": "1000"
  },
  "tags": {
    "index": "nginx-log-*"
  }
}

PUT _qos/_ratelimit/<limiterName>
{
   "search.index_patterns" : "nginx-log-*",
   "search.max_queries_per_sec" : 1000
}

任意のインデックスのQPSの調整を構成する

PUT /_qos/limiter/<limiterName>
{
  "limiters": {
    "search.qps": "1000"
  },
  "tags": {
    "index": "**"
  }
}

サポートされていません

すべてのインデックスの合計QPSの調整を構成する

PUT /_qos/limiter/<limiterName>
{
  "limiters": {
    "search.qps": "1000"
  },
  "tags": {
    "index": "*"
  }
}

PUT _qos/_ratelimit/<limiterName>
{
   "search.index_patterns" : "*",
   "search.max_queries_per_sec" : 1000
}

操作

Elasticsearch V7.10クラスターにインストールされているプラグインの最新バージョンのコード

他のバージョンのElasticsearchクラスターにインストールされているプラグインのコード

すべてのリミッターをクエリする

GET _qos/limiter

GET _qos/_ratelimit

特定のリミッターをクエリする

GET _qos/limiter/<limiterName>

GET _qos/_ratelimit/<limiterName>

複数のリミッターをクエリする

GET _qos/limiter/<limiterName1,limiterName2>

GET _qos/_ratelimit/<limiterName1,limiterName2>

操作

Elasticsearch V7.10クラスターにインストールされているプラグインの最新バージョンのコード

他のバージョンのElasticsearchクラスターにインストールされているプラグインのコード

特定のリミッターを削除する

DELETE _qos/limiter/<limiterName>

DELETE _qos/_ratelimit/<limiterName>

複数のリミッターを削除する

DELETE _qos/limiter/<limiterName1,limiterName2>

DELETE _qos/_ratelimit/<limiterName1,limiterName2>