Utilisation de la pile de surveillance

Surveiller Automation Suite à l'aide de Prometheus, Grafana et Alert Manager sur EKS/AKS.

La pile de surveillance pour les clusters Automation Suite comprend Prometheus, Grafana et Alertmanager, qui sont automatiquement installés, sauf si vous choisissez d'apporter votre propre pile de surveillance.

Cette page décrit une série de scénarios de surveillance optimisés pour fonctionner avec l'outil de surveillance fourni avec le cluster Automation Suite . Si vous choisissez d'apporter votre propre pile de surveillance, assurez-vous de suivre la documentation officielle de vos outils pour surveiller la santé du cluster.

Important :

Lors de l'utilisation de collecteurs pour exporter des métriques vers des outils tiers, l'activation de la surveillance des applications peut perturber les fonctionnalités d'Automation Suite.

Accès aux outils de surveillance

Vue d'ensemble (Overview)

La pile de surveillance pour les clusters Automation Suite comprend Prometheus, Grafana et Alert Manager.

Vous pouvez accéder aux outils de surveillance Automation Suite individuellement à l'aide des URL suivantes :

Application	Outil	URL	Exemple
Métriques	Prometheus	https://monitoring.fqdn/metrics	https://monitoring.automationsuite.mycompany.com/metrics
Tableau de bord	Grafana	https://monitoring.fqdn/grafana	https://monitoring.automationsuite.mycompany.com/grafana
Gestion des alertes	Alertmanager	https://monitoring.fqdn/alertmanager	https://monitoring.automationsuite.mycompany.com/alertmanager

Authentification de l'outil de surveillance

To access the monitoring tools for the first time, follow the instructions in Accessing Automation Suite.

Vérification des alertes en cours de déclenchement

Pour afficher les alertes, accédez à Prometheus à l'aide de https://monitoring.fqdn/metrics et sélectionnez l'onglet Alertes (Alerts). Ici, vous pouvez voir toutes les alertes configurées dans Automation Suite.

• Pour afficher les alertes actives, filtrez le statut de l'alerte en cochant la case Déclenchement (Firing).

• Pour plus de détails sur certaines alertes, développez les alertes que vous souhaitez afficher.

  L'image suivante montre l'onglet Alertes Prometheus avec les alertes actuellement en cours de déclenchement.

  

Mettre les alertes en silencieux

Si les alertes sont trop bruyantes, vous pouvez les désactiver. Pour ce faire, procédez comme suit :

1. Accédez au gestionnaire d'alertes à l'aide de https://monitoring.fqdn/alertmanager.
2. Recherchez l'alerte en question et sélectionnez Silence.
3. Renseignez les détails Créateur (Creator) et Commentaire (Comment), puis cliquez sur Créer (Create). L'alerte ne devrait plus s'afficher sur le tableau de bord de surveillance ni être signalée à l'un des récepteurs configurés.

Configuration des alertes

Remarque :

Before starting configuring the alerts, make sure to enable kubectl.

Ajout d'une nouvelle configuration d'e-mail

Pour ajouter une nouvelle configuration de messagerie après une installation, exécutez la commande suivante :

./uipathctl config alerts add-email \
  --name test \
  --to "[e-mail]" \
  --from "[e-mail]" \
  --smtp server.mycompany.com \
  --username admin \
  --password somesecret \
  --require-tls \
  --ca-file <path_to_ca_file> \
  --cert-file <path_to_cert_file> \
  --key-file <path_to_key_file> \
  --send-resolved \
  --ASEA

Le tableau suivant décrit les indicateurs disponibles pour la commande add-email .

Drapeau	Description	Exemple
name	Le nom de la configuration de l'e-mail	testconfig
to	L'adresse e-mail du destinataire	[e-mail]
from	L'adresse e-mail de l'expéditeur	[e-mail]
SMTP	URL du serveur SMTP ou adresse IP et numéro de port	server.mycompany.com:567
username	Nom d'utilisateur d'authentification	admin
password	Mot de passe d'authentification	securepassword
require-tls	Indicateur booléen indiquant que TLS est activé au niveau du serveur SMTP.	S/O
ca-file	Chemin du fichier contenant le certificat CA du serveur SMTP. Ceci est facultatif si l'autorité de certification est privée.	./ca-file.crt
cert-file	Chemin du fichier contenant le certificat du serveur SMTP. Ceci est facultatif si le certificat est privé.	./cert-file.crt
key-file	Chemin du fichier contenant la clé privée du certificat du serveur SMTP. Ceci est requis si le certificat est privé.	./key-file.crt
send-resolved	Indicateur booléen permettant d'envoyer un e-mail une fois l'alerte résolue.	S/O
ASEA	Indicateur booléen indiquant que vous avez installé Automation Suite sur EKS ou AKS.	S/O

Suppression d'une configuration d'e-mail

Pour supprimer une configuration d'e-mail, vous devez exécuter la commande suivante. Assurez-vous de saisir le nom de la configuration de l'e-mail que vous souhaitez supprimer.

./uipathctl config alerts remove-email --name test --ASEA

Mise à jour d'une configuration d'e-mail

Pour mettre à jour une configuration d'e-mail, vous devez exécuter la commande suivante. Assurez-vous de transmettre le nom de la configuration d'e-mail que vous souhaitez mettre à jour et les paramètres facultatifs supplémentaires que vous souhaitez modifier. Ces paramètres sont les mêmes que ceux permettant d'ajouter une nouvelle configuration d'e-mail. Vous pouvez transmettre un ou plusieurs indicateurs en même temps.

./uipathctl config alerts update-email --name test --ASEA [additional_flags]

Accéder au tableau de bord Grafana

Pour accéder aux tableaux de bord Grafana, vous devez récupérer vos identifiants et les utiliser pour vous connecter :

• Nom d’utilisateur :

  kubectl -n monitoring get secrets/grafana-creds -o "jsonpath={.data.admin-user}" | base64 -d; echo
  

• Mot de passe :

  kubectl -n monitoring get secrets/grafana-creds -o "jsonpath={.data.admin-password}" | base64 -d; echo
  

Surveillance des volumes persistants

Vous pouvez surveiller les volumes persistants via le tableau de bord Kubernetes / Persistent Volumes. Vous pouvez suivre l'espace libre et utilisé pour chaque volume.

L'image suivante montre le tableau de bord Kubernetes Persistent Volumes.

Vous pouvez également vérifier l'état de chaque volume en sélectionnant l'élément PersistentVolumes dans le menu Stockage de Cluster Explorer.

Surveillance de l'utilisation du matériel

Pour vérifier l'utilisation du matériel par nœud, vous pouvez utiliser le tableau de bord Nœud/exporteur/nœuds . Les données sur le processeur, la mémoire, le disque et le réseau sont disponibles.

Vous pouvez surveiller l'utilisation du matériel pour des charges de travail spécifiques à l'aide du tableau de bord Kubernetes / Ressources de calcul (Compute Resources) / Espace de noms (charges de travail) (Namespace (Workloads)). Sélectionnez l'espace de noms uipath pour obtenir les données nécessaires.

Création d'un instantané visuel partageable d'un graphique Grafana

1. Sélectionnez le bouton de menu à côté du titre du graphique, puis sélectionnez Partager.
2. Sélectionnez l'onglet Instantané et définissez le Nom de l'instantané, et Expire.
3. Sélectionnez Publier sur snapshot.raintank.io.

Pour des détails, reportez-vous à la documentation Grafana sur le partage des tableaux de bord.

Remarque :

Cet instantané est visible sur l'Internet public par toute personne disposant du lien.

Création de tableaux de bord Grafana persistants personnalisés

Remarque :

Les tableaux de bord créés directement dans l’interface utilisateur Grafana ne sont pas conservés entre les redémarrages de pod ou de nœud. Les tableaux de bord prédéfinis ne sont pas concernés, car ils sont stockés en tant que ConfigMaps dans l’espace de noms monitoring .

Pour créer un tableau de bord personnalisé persistant, procédez comme suit:

1. Créez votre tableau de bord dans Grafana. Pour obtenir des instructions, consultez la documentation Grafana.
2. Exportez le tableau de bord sous forme de fichier JSON.
3. Enregistrez la configuration ConfigMap suivante sous forme de fichier YAML, en remplaçant <dashboard-name> par un nom unique et <dashboard-json> par le contenu de votre fichier JSON exporté:

   apiVersion: v1
   kind: ConfigMap
   metadata:
     name: <dashboard-name>
     namespace: monitoring
     labels:
       grafana_dashboard: "1"
   data:
     dashboard.json: |
       <dashboard-json>
   

4. Appliquez l’objet ConfigMap:

   kubectl apply -f <file_name.yaml>
   

Grafana importe automatiquement le tableau de bord après que vous avez appliqué ConfigMap.

Surveillance du temporel en tant que service (TaaS)

Les pods de serveur TaaS exposent les métriques Prometheus. Si Prometheus est activé dans votre cluster, les mesures sont extraites automatiquement des pods taas-temporal-* .

Le tableau suivant répertorie les mesures clés de la surveillance de la santé et des performances du SaaS.

Mesure	Description
temporal_activity_schedule_to_start_latency_bucket	Temps entre la planification d’une activité et le fait que le travailleur la récupère. Des valeurs élevées indiquent que les employés ne peuvent pas traiter les tâches suffisamment rapidement.
temporal_workflow_task_schedule_to_start_latency_bucket	Temps entre une tâche de workflow en cours de planification et un travailleur qui la lance. Des valeurs élevées indiquent un retour en arrière de la file d'attente.
temporal_workflow_completed	Nombre d'exécutions de workflow terminées avec succès.
temporal_workflow_failed	Nombre d'exécutions de workflows ayant échoué.
temporal_num_pollers	Nombre d’interrogateurs de travail actuellement actifs, par type d’interrogateur.
temporal_request_latency_bucket	Latence des requêtes gRPC des clients vers le front-end SaaS.

Accéder à l’interface utilisateur temporel

Par défaut, l'interface utilisateur Web Temporel n'est pas exposée en dehors du cluster. Pour y accéder à des fins de diagnostic, transférez le port au déploiement :

kubectl port-forward -n uipath deployment/taas-temporal-web 8008:8008

Ouvrez http://localhost:8008 dans un navigateur. Aucune connexion n’est requise lors de l’accès par l’intermédiaire du port.

L'interface utilisateur temporel vous permet d'inspecter des exécutions de workflow individuelles, d'afficher l'historique d'exécution et d'identifier les activités ayant échoué ou expiré.

Métriques disponibles

Vous pouvez rechercher les métriques disponibles dans l'interface utilisateur Prometheus.

La documentation sur les métriques disponibles est ici :

• https://github.com/prometheus/node_exporter#enabled-by-default - Connectez-vous pour prévisualiser
• https://github.com/kubernetes/kube-state-metrics/tree/master/docs#exposed-metrics - Connectez-vous pour prévisualiser
• Envoyer des requêtes métriques depuis Prometheus (Istio)