Utiliser l’API des métriques
L’API des métriques permet de surveiller et de gérer les applications et l’infrastructure. L’API des métriques active l’agrégation et la collecte de données en temps réel et fournit une vue d’ensemble des performances de votre système. En outre, les équipes DevOps peuvent utiliser l’API pour configurer des alertes, résoudre des problèmes et optimiser l’allocation des ressources. L’exposition de ces métriques de performances vous permet de mieux détecter les anomalies et les goulets d’étranglement et d’être plus proactif en termes de maintenance du système. Enfin, l’API des métriques permet l’intégration d’un large éventail d’outils de surveillance et de visualisation, ce qui optimise l’observation de systèmes complexes.
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.
L’API des métriques collecte des informations sur les services, utilisateurs et éléments de contenu. Le système de surveillance Prometheus est utilisé par l’API des métriques pour conserver les informations collectées dans une base de données chronologique.
Reportez-vous à la rubrique Métriques de service pour plus d’informations sur l’utilisation de l’API des métriques pour optimiser et dépanner les services. Reportez-vous à la rubrique Afficher les métriques pour plus d’informations sur la visualisation des informations collectées par l’API des métriques.
Accéder à l’API des métriques
L’API des métriques est exposée dans l’API usagestatistics dans le répertoire administrateur d’ArcGIS Enterprise. Pour accéder à l’API des métriques, procédez comme suit :
Accédez à l’API usagestatistics dans le répertoire administrateur :
https://organization.example.com/<context>/admin/usagestatistics.Cliquez sur Rest Metrics API (API des métriques REST).
L’application de l’API des métriques s’ouvre dans un nouvel onglet.
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.
Informations présentées par l’API des métriques
Vous pouvez utiliser Prometheus pour récupérer les métriques d’ArcGIS Enterprise. Les tableaux suivants résument les métriques et les étiquettes disponibles, que vous pouvez utiliser dans les requêtes PromQL et les filtres de résultats pour accéder aux informations dont vous avez besoin.
Les métriques avec le suffixe _created reflètent le temps Unix (secondes) des histogrammes et des résumés à partir de la première collecte de la métrique correspondante. Cette valeur offre un aperçu du cycle de vie d’une métrique. Ces métriques ne figurent pas dans les tableaux ci-dessous.
Métriques de service
Les métriques de service sont signalées pour chaque service publié.
|
Nom |
Description |
Type |
Étiquettes |
|---|---|---|---|
|
requests_failed_total |
Nombre de demandes ayant échoué |
counter |
apiType, folderName, instance, instancePool, job, nodeName, operation, podName, responseCached, serviceName, serviceType, username |
|
requests_response_time_seconds_bucket |
Nombre cumulé de requêtes observées terminées dans un délai inférieur ou égal à la limite supérieure du compartiment en secondes |
histogramme |
apiType, folderName, instance, instancePool, job, le, nodeName, operation, podName, responseCached, serviceName, serviceType |
|
requests_response_time_seconds_count |
Nombre total de temps de réponse de requête observés dans tous les compartiments |
histogramme |
apiType, folderName, instance, instancePool, job, nodeName, operation, podName, responseCached, serviceName, serviceType |
|
requests_response_time_seconds_sum |
Temps de réponse cumulé de toutes les requêtes observées, en secondes |
histogramme |
apiType, folderName, instance, instancePool, job, nodeName, operation, podName, responseCached, serviceName, serviceType |
|
requests_response_time_seconds_counter_total |
Somme de temps de réponse des requêtes en secondes |
counter |
apiType, folderName, instance, instancePool, job, nodeName, operation, podName, responseCached, serviceName, serviceType, username |
|
requests_succeeded_total |
Nombre de requêtes réussies |
counter |
apiType, folderName, instance, instancePool, job, nodeName, operation, podName, responseCached, serviceName, serviceType |
|
requests_total |
Nombre de requêtes |
counter |
apiType, folderName, instance, instancePool, job, nodeName, operation, podName, responseCached, serviceName, serviceType, username |
|
requests_usage_timedout_total |
Nombre de requêtes arrivées à expiration en dépassant le temps d’utilisation maximal |
counter |
apiType, folderName, nodeName, operation, podName, serviceName, serviceType, username |
|
requests_wait_time_seconds_bucket |
Nombre cumulé de requêtes en attente de traitement pendant un délai inférieur ou égal à la limite supérieure du compartiment, en secondes |
counter |
apiType, folderName, instance, instancePool, job, le, nodeName, podName, serviceName, serviceType |
|
requests_wait_time_seconds_count |
Nombre total de temps d’attente de requête observés dans tous les compartiments |
counter |
apiType, folderName, instance, instancePool, job, nodeName, podName, serviceName, serviceType |
|
requests_wait_time_seconds_sum |
Temps d’attente cumulé de toutes les requêtes observées, en secondes |
counter |
apiType, folderName, instance, instancePool, job, nodeName, podName, serviceName, serviceType |
|
requests_wait_timedout_total |
Nombre de requêtes arrivées à expiration en dépassant le temps d’attente maximal |
counter |
apiType, folderName, nodeName, operation, podName, serviceName, serviceType, username |
|
up |
Pods en cours d’exécution |
counter |
instance, job |
Métriques d’organisation
|
Nom |
Description |
Type |
Étiquettes |
|---|---|---|---|
|
items_added_total |
Nombre total d’éléments ajoutés |
counter |
componentName, instance, job, nodeName |
|
items_count |
Nombre total d’éléments |
jauge |
componentName, instance, job, nodeName |
|
items_deleted_total |
Nombre total d’éléments supprimés |
counter |
componentName, instance, job, nodeName |
|
items_updated_total |
Nombre total d’éléments mis à jour |
counter |
componentName, instance, job, nodeName |
|
items_viewed_total |
Nombre total de tous les éléments affichés |
counter |
componentName, instance, job, nodeName |
|
users_added_total |
Nombre total d’utilisateurs ajoutés |
counter |
componentName, instance, job, nodeName |
|
users_count |
Nombre total d’utilisateurs |
jauge |
componentName, instance, job, nodeName |
|
users_login_total |
Nombre total de connexions d’utilisateur |
counter |
componentName, instance, job, nodeName |
|
users_logout_total |
Nombre total de déconnexions d’utilisateur |
counter |
componentName, instance, job, nodeName |
Remarque :
La métrique items_count n’inclut pas les éléments de contenu Esri, tels que le contenu Living Atlas.
Description des étiquettes
| Nom d’étiquette | Description |
|---|---|
| apiType | API dans laquelle la métrique est collectée. |
| folderName | Nom du dossier dans lequel le service est créé. |
| instance | Adresse IP du cluster et port du pode de service traitant la requête. |
| instancePool | Pool d’instances utilisé par le service, partagé ou dédié. |
| tâche | Nom de tâche défini dans la configuration Prometheus. |
| le | Limite supérieure d’un compartiment dans une métrique d’histogramme |
| nodeName | Nom de la machine sur laquelle se trouve le service qui gère la requête. |
| opération | Opération demandée, par exemple, une requête ou une exportation. Les informations de l’opération sont disponibles uniquement pour les demandes REST. Les requêtes SOAP renvoient uniquement la valeur soap. |
| podName | Nom du pod de service gérant la demande. |
| responseCached | Booléen indiquant si la réponse a été extraite du cache. |
| serviceName | Nom du service, incluant le nom du dossier dans lequel se trouve le service. |
| serviceType | Type de service, par exemple, MapService ou FeatureService. |
| nom d’utilisateur | Nom d’utilisateur de l’utilisateur à l’origine de la demande. |