Chapitre 9. Interroger les métriques
Vous pouvez interroger les métriques pour afficher des données sur les performances des composants de la grappe et de vos propres charges de travail.
9.1. A propos de l'interrogation des métriques
Le tableau de bord de surveillance d'OpenShift Container Platform vous permet d'exécuter des requêtes Prometheus Query Language (PromQL) pour examiner les mesures visualisées sur un graphique. Cette fonctionnalité fournit des informations sur l'état d'un cluster et de toute charge de travail définie par l'utilisateur que vous surveillez.
En tant que cluster administrator, vous pouvez interroger les métriques pour tous les projets principaux d'OpenShift Container Platform et les projets définis par l'utilisateur.
En tant que developer, vous devez spécifier un nom de projet lorsque vous interrogez les métriques. Vous devez disposer des privilèges requis pour afficher les métriques du projet sélectionné.
9.1.1. Interroger les métriques de tous les projets en tant qu'administrateur de cluster
En tant qu'administrateur de cluster ou en tant qu'utilisateur disposant de permissions de visualisation pour tous les projets, vous pouvez accéder aux métriques pour tous les projets par défaut d'OpenShift Container Platform et les projets définis par l'utilisateur dans l'interface utilisateur des métriques.
Conditions préalables
-
Vous avez accès au cluster en tant qu'utilisateur avec le rôle
cluster-admin
ou avec des permissions de visualisation pour tous les projets. -
Vous avez installé l'OpenShift CLI (
oc
).
Procédure
- Sélectionnez la perspective Administrator dans la console web de OpenShift Container Platform.
-
Sélectionnez Observe
Metrics. - Sélectionnez Insert Metric at Cursor pour afficher une liste de requêtes prédéfinies.
Pour créer une requête personnalisée, ajoutez votre requête Prometheus Query Language (PromQL) au champ Expression.
NoteLorsque vous saisissez une expression PromQL, des suggestions d'autocomplétion apparaissent dans une liste déroulante. Ces suggestions incluent des fonctions, des métriques, des étiquettes et des jetons de temps. Vous pouvez utiliser les flèches du clavier pour sélectionner l'un des éléments suggérés, puis appuyer sur Entrée pour l'ajouter à votre expression. Vous pouvez également déplacer le pointeur de votre souris sur un élément suggéré pour afficher une brève description de cet élément.
- Pour ajouter plusieurs requêtes, sélectionnez Add Query.
- Pour dupliquer une requête existante, sélectionnez à côté de la requête, puis choisissez Duplicate query.
- Pour supprimer une requête, sélectionnez à côté de la requête, puis choisissez Delete query.
- Pour empêcher l'exécution d'une requête, sélectionnez à côté de la requête et choisissez Disable query.
Pour exécuter les requêtes que vous avez créées, sélectionnez Run Queries. Les métriques des requêtes sont visualisées sur le graphique. Si une requête n'est pas valide, l'interface utilisateur affiche un message d'erreur.
NoteLes requêtes qui portent sur de grandes quantités de données peuvent dépasser le temps imparti ou surcharger le navigateur lors de l'affichage de graphiques de séries temporelles. Pour éviter cela, sélectionnez Hide graph et calibrez votre requête en utilisant uniquement le tableau des métriques. Ensuite, après avoir trouvé une requête réalisable, activez le tracé pour dessiner les graphiques.
- Facultatif : L'URL de la page contient maintenant les requêtes que vous avez exécutées. Pour réutiliser cet ensemble de requêtes à l'avenir, enregistrez cette URL.
Ressources supplémentaires
- Pour plus d'informations sur la création de requêtes PromQL, voir la documentation sur les requêtes Prometheus.
9.1.2. Interroger les métriques pour des projets définis par l'utilisateur en tant que développeur
Vous pouvez accéder aux métriques d'un projet défini par l'utilisateur en tant que développeur ou en tant qu'utilisateur disposant d'autorisations de visualisation du projet.
Dans la perspective Developer, l'interface utilisateur Metrics comprend des requêtes prédéfinies sur l'unité centrale, la mémoire, la bande passante et les paquets réseau pour le projet sélectionné. Vous pouvez également exécuter des requêtes Prometheus Query Language (PromQL) personnalisées pour l'unité centrale, la mémoire, la bande passante, les paquets réseau et les métriques d'application pour le projet.
Les développeurs ne peuvent utiliser que la perspective Developer et non la perspective Administrator. En tant que développeur, vous ne pouvez interroger les métriques que pour un seul projet à la fois dans la page Observe -→ Metrics de la console web pour votre projet défini par l'utilisateur.
Conditions préalables
- Vous avez accès au cluster en tant que développeur ou en tant qu'utilisateur disposant d'autorisations de visualisation pour le projet dont vous consultez les métriques.
- Vous avez activé la surveillance pour les projets définis par l'utilisateur.
- Vous avez déployé un service dans un projet défini par l'utilisateur.
-
Vous avez créé une définition de ressource personnalisée (CRD)
ServiceMonitor
pour le service afin de définir la manière dont le service est surveillé.
Procédure
- Sélectionnez la perspective Developer dans la console web de OpenShift Container Platform.
-
Sélectionnez Observe
Metrics. - Dans la liste Project:, sélectionnez le projet pour lequel vous souhaitez afficher les mesures.
- Sélectionnez une requête dans la liste Select query ou créez une requête PromQL personnalisée basée sur la requête sélectionnée en sélectionnant Show PromQL.
Optionnel : Sélectionnez Custom query dans la liste Select query pour saisir une nouvelle requête. Au fur et à mesure de la saisie, des suggestions d'autocomplétion apparaissent dans une liste déroulante. Ces suggestions comprennent des fonctions et des mesures. Cliquez sur un élément suggéré pour le sélectionner.
NoteDans la perspective Developer, vous ne pouvez exécuter qu'une seule requête à la fois.
Ressources supplémentaires
- Pour plus d'informations sur la création de requêtes PromQL, voir la documentation sur les requêtes Prometheus.
9.1.3. Exploration des métriques visualisées
Après l'exécution des requêtes, les mesures sont affichées sur un graphique interactif. L'axe X du graphique représente le temps et l'axe Y représente les valeurs des mesures. Chaque mesure est représentée par une ligne colorée sur le graphique. Vous pouvez manipuler le graphique de manière interactive et explorer les mesures.
Procédure
Dans la perspective de Administrator:
Initialement, toutes les mesures de toutes les requêtes activées sont affichées sur le graphique. Vous pouvez sélectionner les mesures à afficher.
NotePar défaut, le tableau des requêtes affiche une vue développée qui répertorie chaque mesure et sa valeur actuelle. Vous pouvez sélectionner ˅ pour réduire la vue développée d'une requête.
- Pour masquer toutes les mesures d'une requête, cliquez sur pour la requête et cliquez sur Hide all series.
- Pour masquer une mesure spécifique, allez dans le tableau de la requête et cliquez sur le carré coloré près du nom de la mesure.
Pour effectuer un zoom sur le graphique et modifier l'intervalle de temps, procédez de l'une des manières suivantes :
- Sélectionnez visuellement l'intervalle de temps en cliquant et en faisant glisser horizontalement le tracé.
- Utilisez le menu dans le coin supérieur gauche pour sélectionner l'intervalle de temps.
- Pour réinitialiser l'intervalle de temps, sélectionnez Reset Zoom.
- Pour afficher les résultats de toutes les requêtes à un moment précis, maintenez le curseur de la souris sur le graphique à ce moment-là. Les résultats de la requête apparaissent dans une fenêtre contextuelle.
- Pour masquer le tracé, sélectionnez Hide Graph.
Dans la perspective de Developer:
Pour effectuer un zoom sur le graphique et modifier l'intervalle de temps, procédez de l'une des manières suivantes :
- Sélectionnez visuellement l'intervalle de temps en cliquant et en faisant glisser horizontalement le tracé.
- Utilisez le menu dans le coin supérieur gauche pour sélectionner l'intervalle de temps.
- Pour réinitialiser l'intervalle de temps, sélectionnez Reset Zoom.
- Pour afficher les résultats de toutes les requêtes à un moment précis, maintenez le curseur de la souris sur le graphique à ce moment-là. Les résultats de la requête apparaissent dans une fenêtre contextuelle.
Ressources supplémentaires
- Pour plus d'informations sur l'utilisation de l'interface PromQL, voir la section Interrogation des métriques
- Pour plus de détails sur l'accès aux métriques de tous les projets en tant qu'administrateur, voir Interroger les mét riques de tous les projets en tant qu'administrateur.
- Pour plus d'informations sur l'accès aux métriques hors cluster en tant que développeur ou utilisateur privilégié, consultez la rubrique Interrogation des métriques pour les projets définis par l'utilisateur en tant que développeur.