Configuration des métriques de cluster

Article
12/04/2024

Quand l’utilisateur déploie un cluster, un ensemble standard de métriques est activé pour la collecte. Pour obtenir la liste des métriques, consultez Liste des métriques collectées.

Les utilisateurs ne peuvent pas contrôler le comportement (activer ou désactiver) de la collecte de ces métriques standard incluses. Toutefois, les utilisateurs peuvent contrôler la collecte de certaines métriques facultatives qui ne font pas partie du lien vers la liste. Pour activer cette expérience, les utilisateurs doivent créer et mettre à jour une ressource MetricsConfiguration pour un cluster. Par défaut, la création de cette ressource MetricsConfiguration ne change pas la collecte de métriques. L’utilisateur doit mettre à jour la ressource pour activer ou désactiver la collecte de ces métriques facultatives.

Remarque

Pour un cluster, au maximum, une seule ressource MetricsConfiguration peut être créée.
Les utilisateurs doivent créer une ressource MetricsConfiguration pour vérifier la liste des métriques facultatives qui peuvent être contrôlées.
La suppression de la ressource MetricsConfiguration entraîne la restauration de l’ensemble standard de métriques.

Comment gérer la configuration des métriques de cluster

Pour prendre en charge le cycle de vie des configurations de métriques de cluster, les interactions suivantes permettent de créer et gérer les configurations de métriques d’un cluster.

Création d’une configuration de métriques

Utilisez la commande az network cluster metricsconfiguration create pour créer la configuration de métriques pour le cluster. Si vous avez plusieurs abonnements Azure, l’utilisateur doit indiquer l’ID d’abonnement en utilisant l’indicateur --subscription <SUBSCRIPTION_ID> dans la commande CLI ou en sélectionnant l’ID d’abonnement approprié avec la commande az account set.

az networkcloud cluster metricsconfiguration create \
 --cluster-name "<CLUSTER>" \
 --extended-location name="<CLUSTER_EXTENDED_LOCATION_ID>" type="CustomLocation" \
 --location "<LOCATION>" \
 --collection-interval <COLLECTION_INTERVAL (1-1440)> \
 --enabled-metrics "<METRIC_TO_ENABLE_1>" "<METRIC_TO_ENABLE_2>" \
 --tags <TAG_KEY1>="<TAG_VALUE1>" <TAG_KEY2>="<TAG_VALUE2>" \
 --resource-group "<RESOURCE_GROUP>"

Remplacez les valeurs dans < > par vos informations spécifiques.
Interrogez la ressource de cluster et recherchez la valeur de <CLUSTER-EXTENDED-LOCATION-ID> dans properties.clusterExtendedLocation
Le champ collection-interval est un champ obligatoire et enabled-metrics est un champ facultatif.

Les opérateurs peuvent également fournir la liste des métriques activées dans un fichier json ou yaml.

Exemple : fichier enabled-metrics.json

[
   "metric_1",
   "metric_2"
]

Exemple : fichier enabled-metrics.yaml

- "metric_1"
- "metric_2"

Exemple de commande pour utiliser le fichier enabled-metrics json/yaml :

az networkcloud cluster metricsconfiguration create \
 --cluster-name "<CLUSTER>" \
 --extended-location name="<CLUSTER_EXTENDED_LOCATION_ID>" type="CustomLocation" \
 --location "<LOCATION>" \
 --collection-interval <COLLECTION_INTERVAL (1-1440)> \
 --enabled-metrics <path-to-yaml-or-json-file> \
 --tags <TAG_KEY1>="<TAG_VALUE1>" <TAG_KEY2>="<TAG_VALUE2>" \
 --resource-group "<RESOURCE_GROUP>"

Ici, <path-to-yaml-or-json-file> peut être ./enabled-metrics.json ou ./enabled-metrics.yaml (placez le fichier sous le répertoire de travail actuel) avant d’effectuer l’action.

Pour voir tous les paramètres disponibles et leur description, exécutez la commande :

az networkcloud cluster metricsconfiguration create --help

Éléments de configuration de métriques

Nom du paramètre	Description
CLUSTER	Nom de ressource du cluster
LOCATION	Région Azure où le cluster est déployé
CLUSTER_EXTENDED_LOCATION_ID	Emplacement étendu du cluster dans le portail Azure
COLLECTION_INTERVAL	Fréquence de collecte des métriques standard par défaut
RESOURCE_GROUP	Le nom du groupe de ressources du cluster
TAG_KEY1	Tag1 facultatif à passer à MetricsConfiguration create
TAG_VALUE1	Valeur de tag1 facultatif à passer à MetricsConfiguration create
TAG_KEY2	Tag2 facultatif à passer à MetricsConfiguration create
TAG_VALUE2	Valeur de tag2 facultatif à passer à MetricsConfiguration create
METRIC_TO_ENABLE_1	Métrique facultative « METRIC_TO_ENABLE_1 » activée en plus des métriques par défaut
METRIC_TO_ENABLE_2	Métrique facultative « METRIC_TO_ENABLE_2 » activée en plus des métriques par défaut

La spécification des options --no-wait --debug dans une commande az provoque l’exécution asynchrone de cette commande. Pour obtenir plus d’informations, consultez comment effectuer le suivi des opérations asynchrones.

Remarque

L’intervalle de collecte des métriques par défaut pour l’ensemble standard de métriques est défini sur toutes les 5 minutes. Le changement de collectionInterval impacte aussi la fréquence de collecte des métriques standard par défaut.
Il ne peut y avoir qu’un seul ensemble de configuration de métriques défini par cluster. La ressource est créée avec le nom default.

Lister la configuration de métriques

Vous pouvez vérifier la ressource de configuration de métriques pour un cluster spécifique avec la commande az networkcloud cluster metricsconfiguration list :

az networkcloud cluster metricsconfiguration list \
 --cluster-name "<CLUSTER>" \
 --resource-group "<RESOURCE_GROUP>"

Récupération d’une configuration de métriques

Après la création d’une configuration de métriques, les opérateurs peuvent vérifier les détails de la ressource avec la commande az networkcloud cluster metricsconfiguration show :

az networkcloud cluster metricsconfiguration show \
 --cluster-name "<CLUSTER>" \
 --resource-group "<RESOURCE_GROUP>"

Cette commande renvoie une représentation JSON de la configuration de métriques. Vous pouvez observer la liste des métriques activées et désactivées en plus de la fréquence de collecte dans la sortie de cette commande.

Mise à jour d’une configuration de métriques

Tout comme pour la création d’une configuration de métriques, les opérateurs peuvent effectuer une action de mise à jour pour changer la configuration ou mettre à jour les étiquettes attribuées à la configuration de métriques.

az networkcloud cluster metricsconfiguration update \
 --cluster-name "<CLUSTER>" \
 --collection-interval <COLLECTION_INTERVAL (1-1440)> \
 --enabled-metrics "<METRIC_TO_ENABLE_1>" "<METRIC_TO_ENABLE_2>" \
 --tags <TAG_KEY1>="<TAG_VALUE1>" <TAG_KEY2>="<TAG_VALUE2>" \
 --resource-group "<RESOURCE_GROUP>"

Les opérateurs peuvent mettre à jour collection-interval indépendamment de la liste enabled-metrics. Omettez les champs qui ne sont pas modifiés.

Suppression d’une configuration de métriques

La suppression de la configuration de métriques renvoie le cluster à une configuration inchangée. Pour supprimer une configuration de métriques, utilisez la commande :

az networkcloud cluster metricsconfiguration delete \
 --cluster-name "<CLUSTER>" \
 --resource-group "<RESOURCE_GROUP>"

Partager via