Accéder à l’API des métriques

En tant qu’administrateur, vous pouvez utiliser l’API des métriques avec des requêtes PromQL pour interroger directement et obtenir des métriques brutes qui peuvent être utilisées par des utilisateurs tiers dotés d’un rôle de consultation ou des applications graphiques, comme Grafana, susceptibles de s’exécuter à l’intérieur ou à l’extérieur de votre cluster.

Le système de surveillance Prometheus est utilisé par l’API des métriques pour collecter ces métriques à partir de chaque pod de service SIG et conserver les informations dans une base de données chronologique. La visionneuse de métriques inscrit l’API des métriques en tant que data store pour pouvoir l’interroger afin d’obtenir les statistiques d’utilisation.

L’API des métriques est exposée dans l’API usagestatistics dans le répertoire administrateur. Pour accéder à l’API des métriques, procédez comme suit :

1. Accédez à l’API usagestatistics dans le répertoire administrateur : https://organization.example.com/<context>/admin/usagestatistics.
2. Cliquez sur Rest Metrics API (API des métriques REST).

   L’application de l’API des métriques s’ouvre dans un nouvel onglet.

3. Connectez-vous à la page Web Prometheus.

   Par défaut, les identifiants de connexion générés par le système sont utilisés pour la connexion. Avant de vous connecter au tableau de bord Prometheus, configurez votre organisation et mettez à jour vos identifiants de connexion. Pour mettre à jour ces identifiants de connexion, utilisez l’opération Update Credentials (Mettre à jour les identifiants de connexion) dans admin/usagestatistics. Le nouveau mot de passe doit comporter huit caractères au minimum et contenir au moins un caractère de chacun des types suivants :

   • Lettres ASCII comprises entre A et Z (majuscules et minuscules)
   • Chiffres de 0 à 9
   • Caractères spéciaux pris en charge ( # ! % & , - . / : ; < = > @ _ ` ~ et espace)

     • Attention :

       Les caractères spéciaux suivants ne sont pas pris en charge : ^ ? \ * + \ | $

Métriques brutes collectées par l’API des métriques

Les métriques brutes collectées par l’API des métriques sont décrites dans le tableau suivant :

Numéro	Nom de la métrique	Description	Type
1	requests	Demandes pouvant être utilisées pour établir le taux des demandes.	Compteur
2	requests_succeeded	Demandes ayant abouti pouvant être utilisées pour établir le taux de réussite des demandes.	Compteur
3	requests_failed	Demandes ayant échoué pouvant être utilisées pour établir le taux d’échec des demandes.	Compteur
4	requests_usage_timedout	Demandes dont l’utilisation a expiré pouvant être utilisées pour établir le taux des demandes dont le temps d’utilisation a expiré.	Compteur
5	requests_wait_timedout	Demandes dont le temps d’attente a expiré pouvant être utilisées pour établir le taux des demandes dont le temps d’attente a expiré.	Compteur
6	requests_response_time_seconds	Temps de réponse en secondes. Les échantillons, les observations et les décomptes sont inclus dans des paquets de : 0,05, 0,1, 0,25, 0,5, 0,75, 1, 2,5, 5, 7,5, 10 et Inf.	Histogramme
7	gp_job_wait_time_seconds	Temps, en nombre de secondes, pour qu’une tâche de géotraitement soit sélectionnée en vue de son exécution. Les échantillons, les observations et les décomptes sont inclus dans des paquets de : 0,05, 0,1, 0,25, 0,5, 0,75, 1, 2,5, 5, 7,5, 10 et Inf.	Histogramme

Étiquettes capturées par l’API des métriques

Pour chaque métrique brute collectée par l’API, les étiquettes suivantes sont également collectées ; elles permettent d’interroger les métriques à partir de l’API des métriques à l’aide de requêtes PromQL et de filtres de résultats :

Nom d’étiquette	Description
nodeName	Nom de la machine sur laquelle le pod de service gère la demande.
podName	Nom du pod de service gérant la demande.
apiType	API dans laquelle la métrique est collectée. La valeur possible actuelle est service, ce qui représente une demande de service.
folderName	Nom du dossier dans lequel le service est créé.
serviceName	Nom du service, incluant le nom du dossier dans lequel se trouve le service.
serviceType	Type de service, par exemple, MapService ou FeatureService.
Opération	Opération demandée, par exemple, une requête ou une exportation. Remarque : Les informations de l’opération sont disponibles uniquement pour les demandes REST. Les demandes SOAP renvoient uniquement une valeur soap.
orgId	ID de l’organisation.
nom d’utilisateur	Nom d’utilisateur de l’utilisateur à l’origine de la demande.