Elasticsearch:Observation CAT

Les requêtes CAT sur les Slices interrogent les données et comptent les documents. Elles peuvent exécuter des recherches et des agrégations sur plusieurs Backings. N'appelez pas CAT Slice depuis les flux de démarrage ou d'initialisation de l'application, depuis les chemins de requête de l'application ni depuis des tâches d'inspection fréquentes. Lors du dépannage, spécifiez un seul Slice ou Backing chaque fois que possible et limitez la fréquence des requêtes. Le paramètre h filtre uniquement les colonnes renvoyées. Même si docs.count n'est pas affiché, le serveur compte toujours les documents. Si vous avez seulement besoin d'une liste de Slices, utilisez l'opération Parcourir les Slices par pagination, qui ne compte pas les documents.

Colonnes par défaut :

Paramètres de requête courants :

Pour un traitement programmatique, utilisez format=json et spécifiez explicitement les colonnes au lieu de compter sur la stabilité des colonnes par défaut :

GET /_cat/slice_collection/knowledge-chunks?format=json&h=collection,state,backings,slices,docs.count,dataset.size

Comportement et limites des Collections et Backings

• Syntaxe de chemin — Dans l'API Collection, {name} accepte un nom exact, une liste séparée par des virgules ou un caractère générique. {collection} dans les API CAT Backing et Slice doit être un nom exact.

• Sémantique des colonnes — dataset.size correspond à la somme des tailles de jeu de données des shards primaires de tous les Backings. Seuls les shards primaires sont comptés, donc la valeur n'est pas multipliée par le nombre de réplicas.

• Sémantique des colonnes — La valeur remaining d'un Backing n'équivaut pas nécessairement au nombre de Slices que le Backing allouera. Si assign=disabled, le Backing n'accepte pas de nouveaux Slices même si remaining est supérieur à 0.

• Sémantique des colonnes — Si tous les shards primaires ne sont pas démarrés, docs.count et pri.store.size peuvent être vides. Interprétez ces valeurs conjointement avec health et unassigned, et ne considérez pas une valeur vide comme égale à 0.

• Sémantique des colonnes — pri.store.size et store.size indiquent la taille des données indexées. Elles ne correspondent pas à l'utilisation du disque local des nœuds sans état et n'incluent pas les données historiques en attente de nettoyage dans le stockage objet.

• Limite — Si un résumé de Collection ou une liste de Backings s'étend à plus de 10 000 Backings, la requête renvoie HTTP 400. Utilisez une étendue de Collection plus restreinte.

Paramètres spécifiques à la liste des Slices

Le filtrage des Slices par shard s'effectue en deux étapes. Commencez par lister les Backings de la Collection. Dans cette requête, v renvoie les en-têtes de colonne afin que vous puissiez identifier le nom complet du Backing dans la réponse :

GET /_cat/slice_collection/knowledge-chunks/backings?v

Filtrez ensuite les Slices par shard. Remplacez l'espace réservé dans la requête suivante par le nom complet du Backing issu de la colonne backing de la première réponse :

GET /_cat/slice_collection/knowledge-chunks/slices?backing=<complete-backing-name>&shard=0,1&h=slice,backing,shardIds&format=json

Le nom backing s'applique uniquement à cette tâche de filtrage opérationnel. Les applications continuent de lire et d'écrire des données via la Collection et, au niveau du Slice, via _slice.

shard doit se situer dans la plage allant de 0 à index.number_of_shards moins 1. Pour une valeur hors de cette plage, la requête renvoie HTTP 400. Si vous spécifiez shard sans backing, la requête renvoie également HTTP 400. Plusieurs ID de shard sont mis en correspondance avec une sémantique OU. Si docs.count, ou son alias dc, est le premier champ de tri de s, vous ne pouvez pas utiliser shard conjointement avec ce tri.

s=docs.count trie par ordre croissant par défaut. Tant que docs.count est le premier champ de tri, le tri ascendant et descendant agrège les données sur les Backings cibles avant de sélectionner les résultats. Si backing n'est pas spécifié, la requête analyse tous les Backings de la Collection et renvoie HTTP 400 sauf si allow_expensive_search=true est explicitement défini. Ce paramètre s'applique uniquement à la requête actuelle. Lorsqu'un autre champ est le premier champ de tri, le tri s'applique uniquement aux résultats déjà sélectionnés par nom de Slice et ne produit pas de classement global.

Un Slice avec un nombre de documents égal à 0 n'apparaît pas dans les résultats triés par nombre de documents, mais il figure toujours dans la liste par défaut ou dans une requête exacte de Slice.

Comportement CAT et recommandations d'utilisation

• Si le résultat dépasse la limite de lignes côté serveur, CAT n'effectue pas de pagination. La réponse renvoie le nombre maximal de lignes autorisé et utilise l'en-tête HTTP Warning pour indiquer que le résultat est incomplet.

• Le tri par nombre de documents repose sur une agrégation distribuée, de sorte que l'ordre et les nombres de documents peuvent être inexacts. Lorsque le résultat risque d'être inexact, la réponse inclut l'en-tête HTTP Warning pour expliquer la raison.

• CAT offre une vue quasi temps réel. Les documents récemment écrits mais pas encore actualisés peuvent ne pas être comptés dans docs.count.

• CAT ne fournit pas la taille de stockage d'un seul Slice et ne prend pas en charge le tri par taille de stockage de Slice. Pour obtenir le nombre de documents d'un seul Slice sans exécuter de requête CAT Slice, utilisez Interroger un seul Slice avec include_doc_count=true.

• Lorsque vous utilisez Branch Slice (Bêta), les listes CAT qui renvoient plusieurs lignes et le tri par nombre de documents n'incluent pas entièrement les données héritées. Suivez les instructions de cette rubrique pour interroger séparément le nombre de documents du Slice cible.

  Pour les métriques de surveillance au niveau de l'instance et le point d'entrée de la console, consultez Surveillance du cluster.