Surveillance de l'Expérience Utilisateur WEB (WUX)
Introduction à WUX avec Pandora FMS
La surveillance de l'expérience utilisateur WEB (User Experience Monitoring, UX Monitoring ou simplement WUX dans la terminologie de Pandora FMS) est le processus de collecte, d'analyse et d'évaluation de données sur la façon dont les utilisateurs interagissent avec un site web ou une application web en temps réel. Son objectif est de détecter les problèmes de performance, d'utilisabilité et d'accessibilité pour améliorer l'expérience de l'utilisateur.
Pandora FMS WUX effectue une surveillance synthétique (Synthetic Monitoring) en utilisant un backend spécialisé à cet effet (Selenium®). Cela signifie que Pandora FMS utilise un véritable navigateur pour interagir avec des sites web distants (Google Chrome®, Mozilla Firefox®, etc.).
- Il permet de détecter les problèmes avant que les vrais utilisateurs ne les rencontrent. Il recueille des données de navigation de vrais utilisateurs en temps réel (web scraping).
- Il mesure des métriques telles que le temps de chargement, les interactions, les erreurs et le comportement de l'utilisateur (analyse web).
- Exemples : Mesure du chargement des pages, des temps de réponse, des captures d'écran (du web), des tests sur différents appareils, des tests d'applications complexes nécessitant une inscription, de l'interaction JavaScript®, des inputs de texte, du transfert de données d'un champ à un autre comme le ferait un utilisateur, des clics de souris, des temps d'attente, etc.
Quelle est la différence entre WUX et l'autre surveillance WEB effectuée par Pandora FMS avec le WEB Server ?
Le WEB Server utilise des requêtes HTTP de base, et bien qu'il puisse simuler des sessions, ce n'est pas un véritable navigateur, il ne peut donc pas exécuter JavaScript ou émuler un navigateur moderne. Les tests WEB standard sont très bien pour les tests WEB simples, WUX est beaucoup plus puissant.
Quelles sont les différentes versions de WUX de Pandora FMS ?
- WUX basé sur un agent (Selenium version 2), jusqu'à la version 740.
- WUX centralisé sur le WUX Server (Selenium 3), jusqu'à la version 780.
- WUX centralisé en tant que plugin de Discovery PFMS (Selenium 4), à partir de la version 780.
Dans les versions antérieures à la 780, WUX fonctionnait comme partie intégrante du serveur Pandora FMS (WUX Server). Bien que cela soit toujours possible, la configuration (setup) est plus complexe que l'utilisation de WUX en mode centralisé avec Discovery PFMS.
WUX centralisé dans Discovery PFMS est également basé sur Selenium 4 et peut être utilisé (en option) depuis un agent en tant que plugin. Les fichiers transactionnels (.side) qui fonctionnaient sur un WUX Server fonctionneront sur WUX Discovery PFMS.
Vous trouverez des informations sur la façon d'utiliser WUX Server (Selenium 3) dans l'annexe technique Surveillance WUX.
Architecture de WUX / Discovery
Le fonctionnement de ce plugin pour Selenium 4 est réalisé grâce au serveur Discovery de Pandora FMS. Comme mentionné précédemment, un serveur dédié connu sous le nom de WUX Server était utilisé exclusivement, et il est également possible d'utiliser Discovery PFMS à cet effet.
Il est désormais capable d'effectuer des exécutions à l'aide de Selenium 4, d'où son nom, et il est également compatible avec les transactions Selenium 3 (qui pourraient déjà être en cours d'exécution dans un environnement grâce à un WUX Server).
En ce qui concerne les exécutions de transactions, il existe 4 méthodes de connexion différentes avec Selenium, qui seront détaillées ci-dessous, ainsi que les exigences qui doivent être satisfaites pour garantir un fonctionnement correct.
Prérequis
L'exigence principale est que le serveur où le plugin est exécuté soit capable de se connecter à la pile (stack) Selenium 4, et que celle-ci puisse communiquer avec les URL des sites web qu'elle surveillera.
Ce plugin WUX dispose de quatre méthodes de connexion Selenium différentes pour être exécuté dans chaque transaction, vous devrez donc ajuster les exigences au mode d'exécution souhaité pour chaque cas.
Pilote local (Driver local)
Le plugin utilisera les drivers (pilotes) pour Google Chrome ou Mozilla Firefox trouvés sur l'ordinateur où il est exécuté. Par défaut, ces composants seront recherchés dans les chemins suivants, bien que des chemins différents puissent être spécifiés si nécessaire.
Binaire Google Chrome :
/usr/share/pandora_server/util/selenium_headless_drivers/chrome/google-chrome
Chromedriver :
/usr/share/pandora_server/util/selenium_headless_drivers/chromedriver
Binaire Mozilla Firefox :
/usr/share/pandora_server/util/selenium_headless_drivers/firefox/firefox
Geckodriver :
/usr/share/pandora_server/util/selenium_headless_drivers/geckodriver
Ces drivers peuvent être téléchargés depuis la bibliothèque de Pandora FMS et décompressés dans le chemin par défaut ou installés en ligne via le Marketplace PFMS.
Pour que les navigateurs démarrent dans ce mode, leurs dépendances spécifiques installées sur le système seront également nécessaires.
- Pour Mozilla Firefox :
gtk3,alsa-lib,libX11-xcb. - Pour Google Chrome :
nss,libdrm,mesa-libgbm.
Pilote distant (Driver distant)
Le plugin se connectera à un serveur Selenium 4 indiqué par son URL, il sera donc nécessaire d'avoir accès depuis le serveur exécutant le plugin au serveur Selenium 4 via le port qu'il écoute (par défaut 4444 TCP).
Docker local
Le plugin démarrera un conteneur Docker sur le serveur où il s'exécute à l'aide d'une image contenant les drivers indiqués pour le mode pilote local, ce qui permet d'abstraire les dépendances de l'équipement réel.
Par défaut, l'image pandorafms/pandora_selenium_headless sera utilisée (bien qu'il soit possible d'en indiquer une différente pour chaque exécution), et les drivers seront recherchés dans Docker dans les chemins suivants :
- Binaire Google Chrome :
/tmp/lib/chrome/google-chrome. - Chromedriver :
/tmp/lib/chromedriver. - Binaire Mozilla Firefox :
/tmp/lib/firefox/firefox. - Geckodriver :
/tmp/lib/geckodriver.
Docker distant
Le plugin se connectera via SSH avec un nom d'utilisateur et un mot de passe à un serveur distant, où il exécutera une copie du plugin lui-même (copiée à ce moment-là) en mode Docker local. Par conséquent, en plus des exigences du mode précédent, la connectivité avec le serveur distant via SSH doit également être autorisée avec les identifiants indiqués sur le port spécifié (par défaut 22 TCP).
L'utilisateur indiqué pour la connexion SSH doit avoir des autorisations suffisantes pour démarrer le conteneur Docker et accéder aux fichiers copiés dans le répertoire temporaire. Un répertoire temporaire sera utilisé pour copier les fichiers sur le serveur distant (par défaut /tmp), bien qu'un chemin différent puisse être indiqué lors de chaque exécution.
Exigences optionnelles
Pour tous les modes d'exécution, il sera possible, si vous le souhaitez, d'utiliser des profils Google Chrome ou Mozilla Firefox pour chaque transaction. En cas d'utilisation de cette fonctionnalité, il faut s'assurer que les chemins d'accès à ces profils se trouvent sur le serveur où la transaction est initiée (qu'elle soit locale ou distante).
Dans les modes d'exécution Docker (local, distant), ce sera le serveur hôte qui devra avoir les chemins vers les dossiers de profil, car le plugin montera ces dossiers en tant que volumes du conteneur qu'il démarre.
Il sera également possible de surveiller les statistiques de connexion à l'URL principale du SIDE indiquée lors de chaque exécution. Pour cela, il sera nécessaire d'avoir l'exécutable curl installé sur l'ordinateur où le plugin est lancé.
Il faut tenir compte du fait que si l'exécution du test est effectuée en mode pilote distant, les statistiques ne seront pas obtenues à partir du serveur Selenium 4, mais à partir du serveur exécutant le plugin.
Utilisation de WUX avec Discovery PFMS
Installer le plugin Discovery PFMS
Afin d'utiliser la surveillance WUX avec Selenium 4, le fichier .disco doit être préalablement installé dans la section Discovery de la console web Pandora FMS. Cela peut être fait depuis la vue Manage disco packages, en sélectionnant le fichier de type .disco à télécharger depuis la bibliothèque Pandora FMS pour ce plugin :
Enregistrement des transactions avec Selenium IDE
Afin d'exécuter ces transactions, elles doivent d'abord être enregistrées à l'aide de l'extension Selenium IDE disponible pour les navigateurs Google Chrome ou Mozilla Firefox. Après avoir ouvert l'extension, il vous sera demandé de choisir si vous souhaitez enregistrer dans un nouveau projet, en ouvrir un existant, créer un nouveau projet ou simplement fermer l'extension.
Si la première option est choisie, il vous sera demandé de donner un nom au projet en cours de création, puis d'indiquer l'adresse URL de base pour l'enregistrement.
Dans le cas du choix de la troisième option, il vous sera seulement demandé d'indiquer le nom du projet. Ainsi, si vous n'avez pas d'enregistrements précédents, vous devrez également indiquer manuellement l'adresse URL de base pour commencer l'enregistrement.
Une fois l'extension prête avec ces étapes préalables, l'étape suivante consiste à cliquer sur le bouton REC situé dans la partie supérieure droite de l'écran. Une nouvelle fenêtre s'ouvrira dans le navigateur sélectionné et chargera la page indiquée dans la section URL de base. À partir de ce moment, toute action effectuée sur cette fenêtre sera enregistrée dans le projet de l'extension Selenium IDE.
Une fois que toutes les actions à surveiller ultérieurement lors de l'exécution de la transaction ont été effectuées, vous devez cliquer sur le bouton Stop recording (là où se trouvait le bouton REC précédemment) pour arrêter l'enregistrement. Il vous sera demandé d'entrer un nom pour le test de transaction. Un projet dans un enregistrement est composé d'un ou plusieurs tests, qui seront exécutés de manière séquentielle ultérieurement (s'il y en a plus d'un) lors de son chargement dans Pandora FMS. Un nouvel agent sera créé pour chaque test dans un projet.
Par la suite, une vue similaire à la suivante apparaîtra :
Si vous le souhaitez, il est possible d'ajouter manuellement des commandes supplémentaires, telles que des séparateurs de phase, des commentaires ou des commandes d'attente (wait).
Dans la section Commandes des fichiers SIDE se trouve la liste complète des commandes prises en charge.
Pour les ajouter à l'enregistrement en cours, vous devez faire un clic droit sur l'une des commandes existantes et cliquer sur l'option Insert new command :
Cela insérera une ligne de commande vide au-dessus de la commande cliquée, qui pourra être éditée pour ajouter la commande manuellement. Il suffira d'entrer la commande souhaitée dans le champ Command :
Par exemple, pour ajouter une commande de début de phase, vous devez utiliser :
//phase_start:nombre_fase
Par rapport aux versions précédentes, il ne sera pas nécessaire d'indiquer la fin de la phase pour la fermer ; cela sera automatiquement détecté lorsqu'une nouvelle commande phase_start apparaîtra ou, à défaut, lorsque la transaction se terminera.
Lorsque l'enregistrement est terminé et que les commandes supplémentaires à utiliser ont été configurées, le fichier .side peut être généré, dont le contenu pourra être utilisé dans la configuration de l'exécution du plugin. Pour cela, cliquez sur l'icône de disquette située en haut à droite de la fenêtre Selenium IDE, donnez un nom au fichier dans un chemin facilement localisable et enregistrez-le.
Une fois le fichier .side généré, si vous l'ouvrez, vous verrez que son contenu est en réalité un JSON. Ce contenu au format JSON est ce qui doit être copié et collé dans la case Selenium IDE JSON de l'étape Test setup de la configuration du plugin, qui sera vue ci-dessous.
Exécution de la transaction depuis Discovery
Afin d'exécuter les enregistrements depuis l'outil Discovery dans la console web Pandora FMS, une tâche doit être créée à l'aide de Selenium 4 depuis le menu Applications (menu Management → Discovery → Applications ; s'il est inactif, vous devez utiliser le Marketplace PFMS pour l'installer) :
Un nom doit être indiqué pour cette tâche et un groupe lui être assigné. Il est possible d'ajouter une description et de modifier d'autres paramètres importants tels que le temps d'intervalle ou le type d'exécution :
À l'étape suivante, les paramètres suivants apparaîtront :
Ceux-ci permettront de choisir l'un des quatre modes d'exécution disponibles mentionnés ci-dessus, en plus d'indiquer dans quel navigateur web la transaction sera exécutée. Pour des raisons de compatibilité, il est recommandé que ce soit le même navigateur que celui où la transaction a été enregistrée avec Selenium IDE.
Une fois le type d'exécution indiqué, selon l'option choisie, différentes options de configuration apparaîtront.
Docker Local
Par défaut, l'image à utiliser est indiquée, il n'y a donc rien à remplir à moins que vous ne souhaitiez utiliser une image différente. Au cas où il serait nécessaire d'utiliser le profil d'un utilisateur spécifique dans l'exécution de la transaction, l'utilisateur doit être indiqué. Il sera également possible d'indiquer le chemin pour les profils de navigateur utilisés.
Docker Distant
Les données nécessaires pour se connecter via SSH au serveur distant qui exécutera la tâche doivent être indiquées. Pour les données de connexion, les champs adresse IP ou FQDN, port SSH et identifiants d'accès seront requis.
Le chemin temporaire hébergera les fichiers nécessaires pour effectuer l'exécution, et le reste des champs sont les mêmes que pour l'exécution Docker Local.
Pilote Local
Dans ce type d'exécution, le chemin vers les drivers nécessaires pour effectuer l'exécution peut être indiqué, ceux-ci pouvant être téléchargés depuis la bibliothèque Pandora FMS.
En ce qui concerne les tokens qui peuvent être trouvés en bas :
- Virtual display : Utilisé pour que l'exécution utilise un bureau virtuel. Si ce n'est pas indiqué, le serveur exécutant la tâche doit avoir un bureau physique (moniteur) connecté.
- Headless driver : Pour que le navigateur utilisé s'exécute dans ce mode, qui est indiqué pour les environnements sans bureau.
Il est recommandé de laisser ces deux tokens cochés.
Pilote Distant
Dans le quatrième mode disponible, l'URL de connexion avec le driver distant doit être indiquée. Le fonctionnement des paramètres d'utilisateur et de profil est tel que mentionné précédemment.
Après avoir sélectionné le mode de connexion, une dernière étape doit être configurée avant de terminer la configuration de la tâche.
Il est possible d'indiquer que les certificats non sécurisés sont acceptés, ainsi que la surveillance des statistiques de temps. Il existe également d'autres paramètres de configuration tels que la résolution d'écran à laquelle la transaction sera exécutée, le temps de timeout global et le temps d'attente entre les commandes d'enregistrement.
Enfin, comme indiqué à l'étape d'enregistrement de la transaction, le contenu JSON du format .side doit être saisi dans le dernier champ appelé Selenium IDE JSON.
Après avoir terminé la configuration de la tâche, elle s'exécutera automatiquement après quelques secondes, ou il sera nécessaire de forcer l'exécution manuellement, selon ce qui a été indiqué lors de la première étape.
Lorsque l'exécution est terminée, vous pouvez vérifier la vue récapitulative, qui indiquera les agents qui ont été créés à partir de la tâche, lequel ou lesquels appartiennent à des agents de test, et combien il y en a de chaque type.
Résultats de la tâche Discovery PFMS
Dans le cas de l'exemple, le projet Selenium a été nommé Selenium 4 et comporte deux tests différents appelés Test 1 et Test 2. Si l'option Monitor time statistics est cochée lors de la configuration de la tâche, un agent sera créé avec le nom du projet qui hébergera les données de performance.
D'autre part, les agents des transactions enregistrées seront également créés, un pour chaque test. Dans ce cas, il y aura deux agents avec les noms Test 1 et Test 2 :
Surveiller les résultats
Après l'exécution, des agents seront créés avec les données sur les transactions et contiendront les modules de l'exécution de ladite transaction. L'agent avec les données de performance contiendra également les modules pour ces informations et l'option Monitor time statistics doit être préalablement activée à la dernière étape de la configuration de la tâche.
Les modules ajoutés aux agents de test sont au moins les trois suivants :
- Global status : Indique si le test a été complété avec succès ou a échoué à un moment donné.
- Global time : Il s'agit d'un module de type numérique qui indique les secondes qu'il a fallu pour terminer le test.
- Last error screenshot : Si le test a échoué, une capture d'écran de ce qui apparaît dans le navigateur au moment où l'échec s'est produit est stockée dans ce module.
Dans la description des modules Global status et Last error screenshot, le texte de l'erreur renvoyé par le moteur Selenium est indiqué.
Au cas où des phases auraient été configurées dans la transaction, des modules indiquant le status et le time de chaque phase sont créés en plus des précédents. Il est important de savoir que le Global time ne doit pas nécessairement être une somme des modules time de chaque phase, car le Global time inclut également les temps utilisés par le navigateur pour s'ouvrir et se fermer, pour ne citer que quelques exemples.
En ce qui concerne les données de performance, elles indiquent le temps en millisecondes qu'il a fallu pour effectuer chacune des opérations jusqu'à atteindre le site. Dans ce cas, ce serait :
- URL stat DNS : Temps pour la résolution DNS de l'URL.
- URL stat TSSL : Temps pour établir la connexion SSL.
- URL stat TST : Temps jusqu'à la réception du premier octet.
- URL stat TT : Temps total de transaction pour accéder à l'URL.
- URL stat TTC : Temps de connexion TCP.
- URL stat TTCP : Temps jusqu'à ce que la connexion soit prête à transférer des données.
- URL status : Surveille si la connexion à l'URL peut être établie.
Sur ces modules, comme sur tout autre, vous pouvez créer des alertes, des rapports, et d'autres actions dans le reste des menus de Pandora FMS.
Il existe également une vue dans l'agent dédiée uniquement aux données WUX. On peut la trouver dans les onglets en haut à droite :
En plus des widgets pour les tableaux de bord (Dashboards) qui font spécifiquement référence aux modules WUX :
L'enregistrement présenté ci-dessus est un enregistrement simple. Au cas où l'enregistrement aurait été configuré pour être divisé en différentes phases, elles seront également différenciées dans la vue des données WUX :
Et de même avec les widgets :
Enfin, mentionnons que la capture de données web (web scraping) peut également être effectuée, ce qui sera décrit plus loin.
Exécution manuelle (depuis un agent, en tant que plugin)
Pour une exécution manuelle, un EndPoint peut être configuré au sein du serveur Pandora FMS lui-même qui héberge le plugin Selenium 4 pour effectuer ces exécutions et générer des fichiers XML pour chacune d'elles, afin d'obtenir différents agents, et chacun avec ses modules respectifs.
Pour ce faire, le plugin Selenium 4 peut être configuré en tant que plugin d'agent en utilisant des chemins absolus, de sorte que le chemin du fichier du plugin et des fichiers de configuration nécessaires puisse être indiqué.
Le modèle qui peut être utilisé pour configurer le plugin d'agent à l'aide de Selenium 4 se présente comme suit :
module_plugin /var/spool/pandora/data_in/discovery/pandorafms.selenium.4/bin/pandora_selenium -c /ruta/a/fichero/de/configuración -s /ruta/a/fichero/side -t nombre_tarea -i intervalo_agente -g ID_grupo -x
Il est important de garder à l'esprit que le fichier de configuration de la tâche, ainsi que le fichier .SIDE chargé sur la machine, doivent être configurés manuellement au préalable.
Pour préparer le fichier de configuration, vous pouvez aller dans la section « Paramètres et configuration », où se trouve le modèle de données à remplir. Dans le cas du fichier .SIDE, il suffira de copier le fichier lui-même généré par l'extension Selenium IDE.
Il est important d'appliquer le paramètre -x car il est responsable de la génération des données d'exécution au format XML afin qu'elles puissent être traitées ultérieurement. Dans le cas d'exécutions par défaut via Discovery, le format de données reçu est JSON :
Si vous le souhaitez, il est également possible d'exécuter le plugin depuis un EndPoint qui n'est pas installé sur le même serveur que Pandora FMS. Pour cela, il est nécessaire de télécharger localement sur le serveur hébergeant l'EndPoint le paquet .disco du plugin, de le renommer pour modifier son format en .zip, et de décompresser le contenu pour avoir accès au binaire et au reste des fichiers dont il peut avoir besoin pour fonctionner.
Quant à la configuration nécessaire, le fichier doit également être créé manuellement, comme mentionné ci-dessus, et les paramètres -x doivent également être utilisés pour l'envoi de données au format XML et -S pour indiquer l'adresse IP et le port du serveur Tentacle qui recevra ce XML, qui est généralement la même machine qui héberge le serveur Pandora FMS. L'exécution ressemblerait à ceci :
module_plugin /ruta/de/fichero/binario/pandora_selenium -c /ruta/a/fichero/de/configuración -s /ruta/a/fichero/side -t nombre_tarea -i intervalo_agente -g ID_grupo -x -S dirección_IP_Tentacle_server:Puerto_Tentacle
Il est important de se rappeler que chaque XML généré avec ce type d'exécution correspondrait à un agent différent, de sorte que les modules ne seraient pas hébergés au sein de l'agent où le plugin s'exécute.
Enfin, il convient de noter que, bien qu'il soit possible d'effectuer ce type d'exécutions, soit manuellement depuis le terminal ou depuis l'EndPoint, la recommandation est de toujours les réaliser depuis la section Discovery PFMS, car la méthode de fonctionnement est initialement conçue pour fonctionner de cette manière, et la configuration de la tâche est considérablement plus simple.
Paramètres et configuration
| Paramètre court / paramètre long | Description |
|---|---|
-v --verbose | Optionnel. Affiche des informations sur la progression de l'exécution du plugin via STDERR. |
-c <task_configuration_file_path> --conf <task_configuration_file_path> | Chemin vers le fichier de configuration de la tâche à exécuter. |
-s <side_file_path> --side <side_file_path> | Chemin vers le fichier SIDE à exécuter. |
-t <task_name> --task <task_name> | Nom unique de la tâche. Il est utilisé pour générer des éléments temporaires qui n'écrasent pas ceux d'autres tâches qui pourraient s'exécuter sur le même équipement. |
-i <agents_interval> --interval <agents_interval> | Optionnel. Intervalle de surveillance des agents générés par le plugin. Par défaut : 300. |
-g <group_id> --group <group_id> | Optionnel. ID du groupe où les agents générés par le plugin doivent être créés. Par défaut : 0. |
-x --xml_mode | Optionnel. Si indiqué, le plugin générera des fichiers XML pour les agents au lieu de le faire via sa sortie STDOUT. |
-S <server:port> --server <server:port> | Optionnel. Pour la génération d'agents via XML. Adresse IP et port du serveur Tentacle auquel envoyer les fichiers XML. |
-T <temp_folder> --temp <temp_folder> | Optionnel. Pour la génération d'agents via XML. Répertoire temporaire pour les fichiers XML générés avant d'être envoyés au serveur Tentacle indiqué. |
Fichier de configuration (--conf)
{
"worker_mode" : "<local | remote>",
"run_mode" : "<driver | docker>",
"browser" : "<chrome | firefox>",
"driver_url" : "http://<selenium_ip>:<selenium_port>/wd/hub",
"ssh_address" : "<ssh_ip>",
"ssh_port" : "<ssh_port>",
"ssh_user" : "<ssh_user>",
"ssh_password" : "<ssh_password>",
"ssh_password_encrypt" : "<1 | 0>",
"ssh_temp_folder" : "<ssh_temp_folder_path>",
"docker_image": "<docker_image>",
"chromedriver_path": "<chromedriver_path>",
"chrome_binary_path": "<chrome_binary_path>",
"chrome_user_data_dir" : "<chrome_user_data_dir>",
"chrome_profile" : "<chrome_profile>",
"geckodriver_path": "<geckodriver_path>",
"firefox_binary_path": "<firefox_binary_path>",
"firefox_profile" : "<firefox_profile>",
"accept_insecure_certs" : "<1 | 0>",
"monitor_stats" : "<1 | 0>",
"browser_width" : "<width>",
"browser_height" : "<height>",
"global_timeout" : "<seconds>",
"wait_between_commands" : "<seconds>",
"phase_summarize" : "<1 | 0>",
"legacy_data_structure" : "<1 | 0>",
"legacy_data_agent_name" : "<agent_name>",
"legacy_data_agent_group" : "<group_name>"
}
Où chaque élément de configuration est :
worker_mode | Indique si la transaction sera lancée en local ou à distance. |
run_mode | Indique si le plugin sera exécuté avec des drivers ou dans Docker. |
browser | Indique le navigateur web qui sera utilisé pour la transaction. |
driver_url | Indique l'URL vers le serveur Selenium 4 pour exécuter la transaction. Seulement en mode remote/driver. |
ssh_address | Indique l'adresse IP du serveur auquel il se connectera via SSH pour exécuter le plugin. Seulement en mode remote/docker. |
ssh_port | Optionnel. Indique le numéro de port pour la connexion SSH. Par défaut : 22. Seulement en mode remote/docker. |
ssh_user | Indique l'utilisateur pour la connexion SSH. Seulement en mode remote/docker. |
ssh_password | Indique le mot de passe de l'utilisateur ssh_user. Seulement en mode remote/docker. |
ssh_password_encrypt | Optionnel. Indique si le mot de passe précédent est envoyé crypté ( 1) ou non (0). Seulement en mode remote/docker. Les mots de passe peuvent être cryptés en exécutant le plugin depuis le serveur Discovery de Pandora FMS. |
ssh_temp_folder | Optionnel. Indique le chemin vers le répertoire temporaire pour les fichiers nécessaires lors de l'exécution sur le serveur SSH. Par défaut : /tmp. Seulement en mode remote/docker. |
docker_image | Optionnel. Indique le nom de l'image Docker pour exécuter la transaction. Par défaut : pandorafms/pandora_selenium_headless. Seulement en mode docker. |
chromedriver_path | Optionnel. Indique le chemin vers le binaire chromedriver.1) Seulement en mode local/driver. |
chrome_binary_path | Optionnel. Indique le chemin vers le binaire Google Chrome.2) Seulement en mode local/driver. |
chrome_user_data_dir | Optionnel. Indique le chemin vers le répertoire de données ( data dir) de Google Chrome à utiliser. |
chrome_profile | Optionnel. Indique le nom du profil Google Chrome à utiliser. Il doit se trouver dans le data_dir. S'il n'est pas indiqué, le profil par défaut du navigateur sera utilisé. |
geckodriver_path | Indique le chemin vers le binaire geckodriver.3) Seulement en mode local/driver. |
firefox_binary_path | Indique le chemin vers le binaire Mozilla Firefox.4) Seulement en mode local/driver. |
firefox_profile | Optionnel. Indique le chemin vers le répertoire du profil Mozilla Firefox à utiliser. S'il n'est pas indiqué, le profil par défaut du navigateur sera utilisé. |
accept_insecure_certs | Optionnel. S'il est indiqué avec une valeur de 1, les certificats SSL non sécurisés des URL accédées lors de la transaction seront automatiquement acceptés comme valides. |
monitor_stats | Optionnel. S'il est indiqué avec une valeur de 1, des modules de statistiques de connexion à l'URL principale du fichier SIDE indiqué seront générés. |
browser_width | Optionnel. Indique la largeur du navigateur web en pixels pour la transaction. Par défaut : 1920. |
browser_height | Optionnel. Indique la hauteur du navigateur en pixels pour la transaction. Par défaut : 1080. |
global_timeout | Optionnel. Indique le timeout global en secondes pour les tâches effectuées par le plugin, telles que la connexion au serveur Selenium, le démarrage des drivers du navigateur, etc. C'est également le timeout utilisé par défaut pour les commandes Selenium exécutées. Par défaut : 5. |
wait_between_commands | Optionnel. Indique le temps en secondes que le plugin attendra entre chaque commande SIDE qu'il exécute. Cette valeur peut être ajustée avec le SIDE lui-même en utilisant la commande setSpeed. Par défaut : 0. |
phase_summarize | Optionnel. Définit le Global_Time de la transaction comme la somme des modules Time de toutes les phases. |
legacy_data_structure | Optionnel. Active le changement de nomenclature des modules créés dans la transaction vers celle qu'avait Selenium 3. Utile pour les migrations de tâches de Selenium 3 vers Selenium 4 et pour rapporter aux modules déjà existants. |
legacy_data_agent_name | Optionnel. Si legacy_data_structure est activé, nom de l'agent auquel la tâche fera un rapport. |
legacy_data_agent_group | Optionnel. Si legacy_data_structure est activé, nom du groupe auquel l'agent auquel la tâche fera un rapport appartiendra. |
Par exemple :
{
"worker_mode" : "local",
"run_mode" : "driver",
"browser" : "chrome",
"driver_url" : "",
"ssh_address" : "",
"ssh_port" : "",
"ssh_user" : "",
"ssh_password" : "",
"ssh_password_encrypt" : "",
"ssh_temp_folder" : "",
"docker_image": "",
"chromedriver_path": "",
"chrome_binary_path": "",
"chrome_user_data_dir" : "",
"chrome_profile" : "",
"geckodriver_path": "",
"firefox_binary_path": "",
"firefox_profile" : "",
"accept_insecure_certs" : "0",
"monitor_stats" : "1",
"browser_width" : "1920",
"browser_height" : "1080",
"global_timeout" : "10",
"wait_between_commands" : "0.2"
}
Commandes des fichiers .SIDE
Les commandes personnalisées suivantes peuvent être configurées pour générer des modules supplémentaires (toutes les commandes personnalisées doivent commencer par //) :
//phase_start:<phase_name> | Indique le début d'une phase, qui durera jusqu'à ce qu'une autre commande //phase_start soit trouvée ou jusqu'à ce que le test se termine. Cela générera un module avec le statut de la phase et un autre module avec le temps qu'il a fallu pour la terminer. Par exemple : //phase_start:Login |
//getValue;<module_name>;<module_type>;<regexp> | Génère un module avec du contenu de la page web qui peut être obtenu par le biais d'une expression régulière de son code source. Par exemple : //getValue;Temperature;generic_data;<span class="temperature">(\d+\.*\,*\d*).*</span> Cela obtiendrait la température indiquée sur une page web avec cette ligne dans son code source : <p> The temperature of the solar panel is: <span class="temperature">54 º C</span></p> |
//getVariable;<module_name>;<module_type>;<variable> | Génère un module avec le contenu d'une variable stockée dans le SIDE avec des commandes store. Par exemple : //getVariable;List count;generic_data;listCount |
//getScreenshot;<module_name> | Génère un module avec une capture d'écran du navigateur à ce moment-là. Par exemple : //getScreenshot;URL home |
Les commandes de fichier SIDE activées pour être exécutées avec le plugin sont les suivantes (consultez la documentation de Selenium IDE pour leur utilisation) :
addSelection | answerOnNextPrompt |
assert | assertAlert |
assertChecked | assertConfirmation |
assertEditable | assertElementPresent |
assertElementNotPresent | assertNotChecked |
assertNotEditable | assertNotSelectedValue |
assertNotText | assertPrompt |
assertSelectedValue | assertSelectedLabel |
assertText | assertTitle |
assertValue | check |
chooseCancelOnNextConfirmation | chooseCancelOnNextPrompt |
chooseOkOnNextConfirmation | click |
clickAt | close |
do | doubleClick |
doubleClickAt | dragAndDropToObject |
editContent | else |
elseIf | executeScript |
executeAsyncScript | forEach |
if | mouseDown |
mouseDownAt | mouseMoveAt |
mouseOut | mouseOver |
mouseUp | mouseUpAt |
open | pause |
removeSelection | run |
runScript | select |
selectFrame | selectWindow |
sendKeys | setSpeed |
setWindowSize | store |
storeAttribute | storeJson |
storeText | storeTitle |
storeValue | storeWindowHandle |
storeXpathCount | submit |
times | type |
uncheck | verify |
verifyChecked | verifyEditable |
verifyElementPresent | verifyElementNotPresent |
verifyNotChecked | verifyNotEditable |
verifyNotSelectedValue | verifyNotText |
verifySelectedLabel | verifySelectedValue |
verifyText | verifyTitle |
verifyValue | waitForElementEditable |
waitForElementNotEditable | waitForElementNotPresent |
waitForElementNotVisible | waitForElementPresent |
waitForElementVisible | waitForText |
webdriverAnswerOnVisiblePrompt | while |
webdriverChooseCancelOnVisibleConfirmation | |
webdriverChooseCancelOnVisiblePrompt | |
webdriverChooseOkOnVisibleConfirmation |
Web Scraping (Ratissage du web)
Il est possible de faire du web scraping avec Pandora FMS ; bien qu'il ait été conçu pour mesurer les performances et les résultats de transactions complexes, il est faisable de le faire.
Le web scraping est une technique utilisée pour extraire des informations de sites web de manière automatisée. Au lieu de collecter des données manuellement, on utilise des programmes ou des scripts qui naviguent sur des pages web, identifient les informations pertinentes et les stockent dans une base de données ou un fichier structuré.
Ce qui est décrit ici peut être utilisé à la fois pour WUX en mode Discovery (Selenium 4 uniquement) et pour WUX en mode serveur intégré (version 777 ou antérieure), avec Selenium 3.
Pour ce faire, il existe deux manières de base : la plus simple consiste à prendre une valeur directement à partir d'un ID de page web (en utilisant l'inspecteur lui-même de l'extension de la console Selenium et en la passant à Pandora FMS) ou en utilisant une regexp pour traiter des données HTML de façon brute. Dans les deux cas, une commande supplémentaire doit être insérée dans la transaction Selenium.
Exemple, en l'utilisant comme web scraper pour lire le nombre d'avis d'un article sur la boutique Amazon®, en utilisant la capture de la valeur et en la stockant dans une variable :
Elle sera stockée en tant que type TEXT dans une variable appelée REVIEW. Et une commande echo supplémentaire sera créée pour afficher la valeur de cette variable :
Ici, vous pouvez voir les deux dernières étapes du code .side généré par l'extension Selenium :
{
"id": "55546183-fc2f-45b5-af7e-2ff27464798f",
"comment": "",
"command": "storeText",
"target": "css=.a-spacing-medium > .a-size-base",
"targets": [
[
"css=.a-spacing-medium > .a-size-base",
"css:finder"
],
[
"xpath=//div[@id='cm_cr_dp_d_rating_histogram']/div[3]/span",
"xpath:idRelative"
],
[
"xpath=//span/div/div/div/div/div/div[3]/span",
"xpath:position"
]
],
"value": "REVIEW"
}
{
"id": "69cd3cea-5981-4011-bb3d-88a1b58dc18e",
"comment": "",
"command": "echo",
"target": "${REVIEW}",
"targets": [],
"value": ""
}
L'inconvénient de cette méthode est qu'elle sera enregistrée sous forme de chaîne de caractères, car lors de l'utilisation d'un ID (dans ce cas un span), tout ce qui se trouve entre les balises de cet ID est enregistré.
Si vous souhaitez obtenir une valeur de manière plus “raffinée”, vous devez utiliser la méthode d'analyse (parse) avec une expression régulière pour traiter le texte :
- Pour ce cas, un nombre sera pris et converti en module numérique dans Pandora FMS
- Comme code source du
.side, la commande créée deviendra un code similaire à celui-ci. Il est important de noter comment les caractères comme les guillemets doubles"ou le caractère\sont échappés. - Ce qu'il faut faire, c'est déterminer le morceau de code HTML avec le texte à capturer. Pour cela, analysez avec un inspecteur HTML la zone de code où la valeur doit être prise, exemple :
Vous cherchez ce qui se trouve entre les balises (tags) :
<span id="acrCustomerReviewText" class="a-size-base">''
et
</span>
Si une regexp est appliquée, ce sera :
<span id="acrCustomerReviewText" class="a-size-base">(\d+) valoraciones</span>
Cela doit être fait en créant une commande “fictive” (commentée avec //) à la fin de la séquence Selenium (en échappant tout caractère avec " ou \) et en utilisant la commande getValue pour créer un module appelé AMZ_001, de type generic_data (c'est-à-dire, numérique) et en fournissant la regexp échappée :
{
"id": "ae557b25-b096-4d6e-baa7-f7219ac16e04",
"comment": "",
"command": [
"//getValue;AMZ_001;generic_data;",
"<span id=\"acrCustomerReviewText\"",
" class=\"a-size-base\">(\\d+) valoraciones</span>"
],
"target": "",
"targets": [],
"value": ""
}
Ceci après exécution renverra des données conventionnelles de Pandora FMS, avec lesquelles vous pourrez appliquer des alertes, inclure dans des graphiques, des rapports, et bien d'autres choses.
Puisque la transaction utilise un vrai navigateur, vous pouvez même faire la connexion avec un utilisateur spécifique et naviguer pour, enfin, obtenir la donnée nécessaire.
WUX Server et Selenium 3
Documentation décrite dans l'annexe technique “Surveillance WUX avec WUX server et Selenium 3”.
/usr/share/pandora_server/util/selenium_headless_drivers/chromedriver./usr/share/pandora_server/util/selenium_headless_drivers/chrome/google-chrome./usr/share/pandora_server/util/selenium_headless_drivers/geckodriver./usr/share/pandora_server/util/selenium_headless_drivers/firefox/firefox.


























