Elasticsearch:Utiliser le plug-in de limitation de débit du cluster (aliyun-qos)

Dernière version V7.10

Autres versions

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

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

Méthode

Dernière version V7.10

Autres versions

Définir le paramètre limiter sur false

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

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

Définir le paramètre limiter sur null

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

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

Paramètre

Description

Valeur

action

L'action à limiter. Ce paramètre sert à limiter différents types de requêtes.

• write : Requêtes d'écriture de documents, y compris les opérations index et create.

• update : Requêtes de mise à jour de documents.

• delete : Requêtes de suppression de documents.

• search : Requêtes de recherche.

• search_shards : Requêtes permettant d'interroger le nombre total de shards d'un index.

limiter_type

Le type de limitation. Trois catégories sont prises en charge : débit, concurrence et limites par requête.

• rate : Limite de débit. Accepte uniquement des entiers.

• qps : Taux de requêtes. Accepte uniquement des entiers.

• tps : Taux d'écriture. Accepte uniquement des entiers.

• throughput : Débit de données. Pris en charge uniquement pour les actions write, update et delete. Les unités incluent Go, Mo et Ko. La valeur maximale est de 2 Go.

• thread_count : Limite le nombre de requêtes simultanées.

• concurrent_count : Concurrence des requêtes, calculée en fonction des opérations spécifiques d'une requête. Par exemple, search_shards.concurrent_count:20 autorise un maximum de 20 requêtes de shards simultanées.

• max_per_request : Nombre maximal d'opérations d'un certain type au sein d'une seule requête. Par exemple, update.max_per_request:10 autorise un maximum de 10 opérations de mise à jour dans une seule requête Bulk.

• max_size_per_request : Taille maximale d'une seule requête. Pris en charge uniquement pour les actions write, update et delete.

threshold

Le seuil de limitation.

Un entier supérieur ou égal à -1.

Certains types acceptent des chaînes avec des unités. Pour plus d'informations, consultez la description de limiter_type.

tagName

Le nom du tag.

• node : Le nom du nœud actuel.

• is_master : Indique si le nœud actuel est un nœud maître. La valeur de tag correspondante est true ou false.

• index : Le nom de l'index. Pour plusieurs index, utilisez un tableau. Si un alias est transmis, il est résolu en nom d'index réel. Ce tag est disponible uniquement pour les sous-classes de IndicesRequest.

• shard : Le nom du shard, au format index[id], par exemple test[0]. Ce tag est disponible uniquement pour les sous-classes de ReplicationRequest.

• index_in_url : La chaîne d'index issue de l'URL. Si un alias est transmis, ce tag conserve l'alias. Ce tag est disponible uniquement pour les sous-classes de IndicesRequest.

tagValue

La valeur du tag.

Une chaîne ou un tableau de chaînes. Si un tableau est utilisé, le tag correspond à n'importe quelle valeur du tableau. La correspondance exacte, la correspondance par préfixe avec un caractère générique et toutes les valeurs sont prises en charge. Exemples :

• Correspondance exacte : « abc »

• Correspondance par préfixe : « ab* »

• Toutes les valeurs : « ** »

  L'utilisation d'une valeur générique définit un limiteur par défaut, ce qui signifie qu'un limiteur spécifique est généré pour toute valeur de ce tag. Par exemple, si vous spécifiez index:"**",search.tps:1, le taux de recherche pour chaque index est limité à 1 par défaut, plutôt que de limiter le taux de recherche total à 1.

priority

La priorité du limiteur.

Un entier. Valeur par défaut : 0.

Une valeur plus élevée indique une priorité plus grande. Lorsqu'une requête correspond à plusieurs limiteurs par défaut, seul celui ayant la priorité la plus élevée prend effet.

params

Paramètres avancés.

watchMode : Indique s'il faut activer le mode de surveillance. Valeurs valides : true et false (par défaut). Lorsqu'elle est définie sur true, Elasticsearch enregistre les nombres de requêtes rejetées dans les métriques, mais n'applique pas les limites. Cela vous permet de prévisualiser l'effet d'une règle avant de l'appliquer, évitant ainsi les mauvaises configurations. Pour plus d'informations sur les API, consultez la section FAQ.

Actions

Dernière version V7.10

Autres versions

Obtenir toutes les configurations de limiteur

GET /_qos/limiter

GET /_qos/_ratelimit

Obtenir une configuration de limiteur spécifique unique

GET /_qos/limiter/<limiterName>

GET /_qos/_ratelimit/<limiterName>

Obtenir plusieurs configurations de limiteur spécifiques. Séparez plusieurs noms de limiteurs par des virgules (,). Les caractères génériques ne sont pas pris en charge.

GET /_qos/limiter/<limiterName1,limiterName2>

GET /_qos/_ratelimit/<limiterName1,limiterName2>

Actions

Dernière version V7.10

Autres versions

Supprimer une configuration de limiteur spécifique unique

DELETE /_qos/limiter/<limiterName>

DELETE /_qos/_ratelimit/<limiterName>

Supprimer plusieurs configurations de limiteur spécifiques. Séparez plusieurs noms de limiteurs par des virgules (,). Les caractères génériques ne sont pas pris en charge.

DELETE /_qos/limiter/<limiterName1,limiterName2>

DELETE /_qos/_ratelimit/<limiterName1,limiterName2>