Configurer l’accès aux métriques

L’API des métriques capture des informations sur les composants d’ArcGIS Enterprise et les machines sur lesquelles ces composants s’exécutent. Pour exploiter les informations présentées par l’API des métriques, vous devrez créer une clé ou un jeton pour autoriser l’accès aux métriques, configurer Prometheus pour extraire les métriques, et éventuellement configurer Grafana pour visualiser les métriques.

Les métriques sont activées par défaut, mais vous pouvez les désactiver, si nécessaire.

Configurer les autorisations d’accès

Avant d’extraire des métriques, assurez-vous d’activer les autorisations d’accès appropriées.

Le compte qui exécute chaque composant logiciel doit faire partie du Performance Monitor Group (Groupe Analyseur de performances) chargé de collecter les métriques de la machine.

Pour les déploiements ArcGIS Enterprise, y compris les serveurs fédérés, authentifiez les requêtes à l’aide d’une clé d’API. Pour des sites ArcGIS Server autonomes, authentifiez les requêtes à l’aide d’un jeton d’administration.

Remarque :

L’authentification permettant d’obtenir des métriques pour un composant ArcGIS Enterprise nécessite que le service Portal for ArcGIS soit accessible. L’authentification des métriques ArcGIS Data Store nécessite également que le serveur d’hébergement soit accessible.

Obtenir une clé d’API à l’aide d’ArcGIS Enterprise

Pour utiliser ArcGIS Enterprise afin d’obtenir une clé d’API appropriée pour accéder à l’API des métriques, procédez comme suit :

Connectez-vous à votre organisation en tant qu’administrateur.
Depuis l’onglet My content (Mon contenu) de la page de contenu, cliquez sur New Item (Nouvel élément), puis sur Developer credentials (Informations d’identification Developer).
Sélectionnez API key credentials (Informations d’identification de clé d’API) et cliquez sur Next (Suivant).
Sélectionnez Private application with selected privileges and access (Application privée avec privilèges et accès sélectionnés) et cliquez sur Next (Suivant).
Sélectionnez No item access (Aucun accès aux éléments) et cliquez sur Next (Suivant).
Sélectionnez le privilège Observability (Observabilité), puis cliquez sur Next (Suivant).
Sélectionnez une date d’expiration et éventuellement les URL des référents, puis cliquez sur Next (Suivant).
Ajoutez un titre pour l’élément de clé d’API et, si vous le souhaitez, des balises et un résumé, puis cliquez sur Next (Suivant).
Examinez la configuration de la clé d’API pour vérifier qu’elle est exacte, puis cliquez sur Next (Suivant).
Assurez-vous que l’option Generate the API key now (Générer la clé d’API maintenant) est sélectionnée, puis cliquez sur Next (Suivant).
Copiez la clé d’API.

Obtenir un jeton d’administration auprès d’ArcGIS Server

Pour les sites ArcGIS Server autonomes, vous pouvez obtenir un jeton d’administration auprès d’ArcGIS Server. Pour les sites ArcGIS Server fédérés, procurez-vous une clé d’API à la place.

Connectez-vous au répertoire administrateur d’ArcGIS Server en tant qu’utilisateur dotés du rôle Administration.
Cliquez sur generateToken.
Indiquez les informations suivantes :
- Nom d’utilisateur : nom d’utilisateur disposant de privilèges d’administration
- Mot de passe : mot de passe du nom d’utilisateur spécifié
- Client : référent HTTP
- Référent HTTP : URL correspondant au référent spécifié dans la configuration Prometheus. L’exemple de configuration Prometheus utilise ARCGIS.COM comme référent.
Si vous le souhaitez, définissez un délai d’expiration en nombre de minutes.

Remarque :

Le délai d’expiration est défini par défaut sur 60 minutes. Le délai d’expiration maximal par défaut est de 1 440 minutes (24 heures). Pour générer un jeton plus long, un administrateur doit mettre à jour la configuration du jeton pour augmenter la propriété longTimeout avant de générer un jeton. Faites preuve de prudence lorsque vous augmentez la valeur longTimeout afin de vous assurer que la valeur mise à jour réponde à vos exigences en matière de sécurité.
Cliquez sur Generate (Générer).
Copiez le jeton.

Configurer le serveur Prometheus

Pour ajouter l’API des métriques comme cible d’extraction, vous devrez mettre à jour la configuration Prometheus. Pour obtenir les instructions de déploiement de Prometheus, consultez le guide de déploiement.

Configurez une tâche d’extraction distincte pour chaque composant d’ArcGIS Enterprise dont vous souhaitez obtenir des métriques. Les informations suivantes sont requises pour chaque configuration d’extraction :

job_name : identifiant unique de la tâche.
http_sd_configs : configuration du point de terminaison de découverte de services. Les informations suivantes sont requises :
- url : URL du point de terminaison de découverte de services. L’URL est au format <scheme>://<machine fqdn>/<context>/monitoring/discovery.
  
  Pour Portal for ArcGIS et ArcGIS Server, il est recommandé d’utiliser l’URL d’ArcGIS Web Adaptor ou le proxy inverse. Par exemple, une organisation pourrait utiliser https://portal.example.com/portal/monitoring/discovery pour procéder à la découverte de services afin d’obtenir les métriques du portail ou https://gisserver.example.com/server/monitoring/discovery afin d’obtenir les métriques d’un site ArcGIS Server.
  
  Pour ArcGIS Data Store, vous devez spécifier la machine sur laquelle le relational store est installé ainsi que le numéro de port. Par exemple, https://relational.example.com:2443/arcgis/monitoring/discovery
- bearer_token ou bearer_token_file : clé d’API ArcGIS Enterprise ou le jeton d’administration ArcGIS Server que vous avez créé.
  
  Le jeton est fourni dans le cadre de l’authentification http_sd_configs auprès du point de terminaison de découverte de services.
bearer_token ou bearer_token_file : clé d’API ArcGIS Enterprise ou le jeton d’administration ArcGIS Server que vous avez créé.

Le jeton est à nouveau fourni dans le cadre de la configuration de l’extraction pour s’authentifier aux points de terminaison de collecte des métriques.
metrics_path : la valeur doit être /arcgis/monitoring/metrics

L’extraction des métriques sur les machines nécessite d’envoyer des requêtes directement à chaque machine. Ces requêtes ne passent par aucune instance ArcGIS Web Adaptor ni proxy inverse que vous avez configuré. Assurez-vous que le serveur Prometheus puisse accéder à chaque machine ArcGIS Server via le port 6443 et à chaque machine Portal for ArcGIS via le port 7443.
scheme : soit http soit https selon que l’URL spécifiée dans https_sd_configs est configurée pour être accessible via http ou https.

Consultez l’exemple de configuration Prometheus pour voir un fichier modèle YAML visant à extraire des métriques ArcGIS Enterprise. Vous pouvez utiliser l’exemple de modèle de tableau de bord pour configurer Grafana afin de visualiser les métriques après les avoir collectées avec Prometheus.

Configurer l’intervalle de nettoyage des métriques

L’intervalle par défaut pour la suppression des métriques du système est d’une heure, ce qui convient à la plupart des organisations. Consultez la rubrique Effacement des métriques pour en savoir plus sur les considérations à prendre en compte lors de la modification de l’intervalle de suppression.

Si vous devez modifier l’intervalle de nettoyage, la marche à suivre dépend du composant ArcGIS Enterprise utilisé.

Configurer l’intervalle de nettoyage des métriques pour ArcGIS Server

Connectez-vous au répertoire administrateur d’ArcGIS Server en tant qu’utilisateur dotés du rôle Administration.
Accédez à System (Système) > Properties (Propriétés) > Update (Mettre à jour).
Dans la zone de texte Properties (Propriétés), ajoutez une valeur pour la clé metricsClearingIntervalInHours sous forme de code JSON.

Par exemple, pour définir un intervalle de deux heures, utilisez le code JSON suivant :
```
{
   "isMetricsEnabled": true,
   "metricsClearingIntervalInHours": 2
}
```
Cliquez sur Update (Mettre à jour).
Redémarrez le service ArcGIS Server.

Configurez l’intervalle de nettoyage des métriques pour Portal for ArcGIS

Connectez-vous au Répertoire administrateur du portail en tant qu’administrateur de votre organisation.
Accédez à System (Système) > Properties (Propriétés) > Update Properties (Mettre à jour les propriétés).
Dans la zone de texte Properties (Propriétés), ajoutez une valeur pour la clé metricsClearingIntervalInHours sous forme de code JSON.

Par exemple, pour définir un intervalle de deux heures, utilisez le code JSON suivant :
```
{
   "isMetricsEnabled": true,
   "metricsClearingIntervalInHours": 2
}
```
Cliquez sur Update Properties (Mettre à jour les propriétés).

Cette opération redémarre automatiquement le service Portal for ArcGIS.

Configurer l’intervalle de nettoyage des métriques pour ArcGIS Data Store

Exécutez l’utilitaire datastoremetrics sur la machine sur laquelle le relational store est installé et spécifiez le paramètre interval. Par exemple, pour définir un intervalle de deux heures, utilisez la commande suivante :

./datastoremetrics --enabled true --interval 2

datastoremetrics --enabled true --interval 2

Pour modifier l’intervalle de nettoyage des métriques pour un relational store principal et un relational store de secours, vous devez exécuter l’utilitaire sur les deux stores.

Désactiver les métriques

La marche à suivre pour désactiver les métriques dépend du composant ArcGIS Enterprise utilisé.

Désactiver les métriques pour un site ArcGIS Server

Connectez-vous au répertoire administrateur d’ArcGIS Server en tant qu’utilisateur dotés du rôle Administration.
Accédez à System (Système) > Properties (Propriétés) > Update (Mettre à jour).
Dans la zone de texte Properties (Propriétés), définissez la clé isMetricsEnabled sur false :
```
{"isMetricsEnabled": false}
```
Cliquez sur Update (Mettre à jour).
Redémarrez le service ArcGIS Server.

Désactiver les métriques pour Portal for ArcGIS

Connectez-vous au Répertoire administrateur du portail en tant qu’administrateur de votre organisation.
Accédez à System (Système) > Properties (Propriétés) > Update Properties (Mettre à jour les propriétés).
Dans la zone de texte Properties (Propriétés), définissez la clé isMetricsEnabled sur false :
```
{"isMetricsEnabled": false}
```
Cliquez sur Update Properties (Mettre à jour les propriétés).

Cette opération redémarre automatiquement le service Portal for ArcGIS.

Désactiver les métriques pour ArcGIS Data Store

Pour désactiver les métriques pour ArcGIS Data Store, exécutez l’utilitaire datastoremetrics sur la machine sur laquelle le relational store est installé à l’aide de la commande suivante :

./datastoremetrics --enabled false

datastoremetrics --enabled false

Pour désactiver les métriques pour un relational store principal et un relational store de secours, vous devez exécuter l’utilitaire sur les deux stores.