Sahi Pro Rest API

Contenu du pack

Sahi Pro est un logiciel d'automatisation de tests pour les applications de bureau, les applications mobiles et les applications Web.

Modèles

Le connecteur de supervision Sahi Pro Rest API apporte un modèle d'hôte :

• App-Sahipro-Restapi-custom

Le connecteur apporte le modèle de service suivant (classés selon le modèle d'hôte auquel ils sont rattachés) :

App-Sahipro-Restapi-custom

Ce modèle d'hôte n'apporte pas de modèle de service.

Non rattachés à un modèle d'hôte

Alias	Modèle de service	Description
Scenario	App-Sahipro-Restapi-Scenario-custom	Contrôle le statut d'un scénario

Les services listés ci-dessus ne sont pas créés automatiquement lorsqu'un modèle d'hôte est appliqué. Pour les utiliser, créez un service manuellement et appliquez le modèle de service souhaité.

Métriques & statuts collectés

Voici le tableau des services pour ce connecteur, détaillant les métriques rattachées à chaque service.

Scenario

Métrique	Unité
scenario status
scenario.execution.time.seconds	ms
scenario.steps.count
scenario.failures.count
scenario.errors.count
step_num#step.execution.time.second	ms

Prérequis

Pour la supervision, un utilisateur avec des droits de lecture sur l'API Rest Sahi Pro est nécessaire.

Installer le connecteur de supervision

Pack

1. Si la plateforme est configurée avec une licence online, l'installation d'un paquet n'est pas requise pour voir apparaître le connecteur dans le menu Configuration > Gestionnaire de connecteurs de supervision. Au contraire, si la plateforme utilise une licence offline, installez le paquet sur le serveur central via la commande correspondant au gestionnaire de paquets associé à sa distribution :

Alma / RHEL / Oracle Linux 8

dnf install centreon-pack-applications-sahipro-restapi

Alma / RHEL / Oracle Linux 9

dnf install centreon-pack-applications-sahipro-restapi

Debian 11 & 12

apt install centreon-pack-applications-sahipro-restapi

CentOS 7

yum install centreon-pack-applications-sahipro-restapi

2. Quel que soit le type de la licence (online ou offline), installez le connecteur Sahi Pro Rest API depuis l'interface web et le menu Configuration > Gestionnaire de connecteurs de supervision.

Plugin

À partir de Centreon 22.04, il est possible de demander le déploiement automatique du plugin lors de l'utilisation d'un connecteur. Si cette fonctionnalité est activée, et que vous ne souhaitez pas découvrir des éléments pour la première fois, alors cette étape n'est pas requise.

Plus d'informations dans la section Installer le plugin.

Utilisez les commandes ci-dessous en fonction du gestionnaire de paquets de votre système d'exploitation :

Alma / RHEL / Oracle Linux 8

dnf install centreon-plugin-Applications-Sahipro-Restapi

Alma / RHEL / Oracle Linux 9

dnf install centreon-plugin-Applications-Sahipro-Restapi

Debian 11 & 12

apt install centreon-plugin-applications-sahipro-restapi

CentOS 7

yum install centreon-plugin-Applications-Sahipro-Restapi

Utiliser le connecteur de supervision

Utiliser un modèle d'hôte issu du connecteur

1. Ajoutez un hôte à Centreon depuis la page Configuration > Hôtes.
2. Complétez les champs Nom, Alias & IP Address/DNS correspondant à votre ressource.
3. Appliquez le modèle d'hôte App-Sahipro-Restapi-custom. Une liste de macros apparaît. Les macros vous permettent de définir comment le connecteur se connectera à la ressource, ainsi que de personnaliser le comportement du connecteur.
4. Renseignez les macros désirées. Attention, certaines macros sont obligatoires.

Macro	Description	Valeur par défaut	Obligatoire
SAHIAPIPORT		9999
SAHIAPIPROTOCOL		http

5. Déployez la configuration. L'hôte apparaît dans la liste des hôtes supervisés, et dans la page Statut des ressources. La commande envoyée par le connecteur est indiquée dans le panneau de détails de l'hôte : celle-ci montre les valeurs des macros.

Utiliser un modèle de service issu du connecteur

1. Si vous avez utilisé un modèle d'hôte et coché la case Créer aussi les services liés aux modèles, les services associés au modèle ont été créés automatiquement, avec les modèles de services correspondants. Sinon, créez les services désirés manuellement et appliquez-leur un modèle de service.
2. Renseignez les macros désirées (par exemple, ajustez les seuils d'alerte). Les macros indiquées ci-dessous comme requises (Obligatoire) doivent être renseignées.

Scenario

Macro	Description	Valeur par défaut	Obligatoire
SAHIENDPOINT	Define endpoint (default: '/_s_/dyn/')	/_s_/dyn/
SAHIHTTPTIMEOUT	Timeout for each HTTP requests (Default: 5)	5
SAHITHREADS	Number of simultaneous browser instances that can be executed (default: 1)	1
SAHISTARTWITH	Define the start mode (Default: BROWSER)	BROWSER
SAHIBROWSERTYPE	Browser used for script executions (Default: chrome)	chrome
RETRIESSCENARIOSTATUS	Define the number of retries to get scenario status (if we fail to get the status)	0
INTERVALSCENARIOSTATUS	Define time interval to get scenario status in seconds (default: 10)	10
UNKNOWNRUNSTATUS	Unknown threshold for running scenario rest api response. (Default: '%{http_code} \< 200 or %{http_code} >= 300')	%{http_code} \< 200 or %{http_code} >= 300
SAHISUITE	Define path for scenario files (required. Example: 'sahitests/small.suite')
SAHIBASEURL	Define default Start URL for scripts
TIMEOUT	Define the global script timeout. If timeout is reached, scenario is killed
UNKNOWNSTATUS	Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %{status}
WARNINGERRORS	Thresholds
CRITICALERRORS	Thresholds
WARNINGFAILURES	Thresholds
CRITICALFAILURES	Thresholds
WARNINGRUNSTATUS	Warning threshold for running scenario rest api response
CRITICALRUNSTATUS	Critical threshold for running scenario rest api response
CRITICALSTATUS	Define the conditions to match for the status to be CRITICAL (default: '%{status} ne "SUCCESS"'). You can use the following variables: %{status}	%{status} ne "SUCCESS"
WARNINGSTATUS	Define the conditions to match for the status to be WARNING. You can use the following variables: %{status}
WARNINGSTEPTIME	Thresholds
CRITICALSTEPTIME	Thresholds
WARNINGTOTALSTEPS	Thresholds
CRITICALTOTALSTEPS	Thresholds
WARNINGTOTALTIME	Thresholds
CRITICALTOTALTIME	Thresholds
EXTRAOPTIONS	Any extra option you may want to add to the command (E.g. a --verbose flag). Toutes les options sont listées ici	--verbose

3. Déployez la configuration. Le service apparaît dans la liste des services supervisés, et dans la page Statut des ressources. La commande envoyée par le connecteur est indiquée dans le panneau de détails du service : celle-ci montre les valeurs des macros.

Comment puis-je tester le plugin et que signifient les options des commandes ?

Une fois le plugin installé, vous pouvez tester celui-ci directement en ligne de commande depuis votre collecteur Centreon en vous connectant avec l'utilisateur centreon-engine (su - centreon-engine). Vous pouvez tester que le connecteur arrive bien à superviser la ressource en utilisant une commande telle que celle-ci (remplacez les valeurs d'exemple par les vôtres) :

/usr/lib/centreon/plugins/centreon_sahipro_restapi.pl \
    --plugin=apps::sahipro::restapi::plugin \
    --mode=scenario \
    --sahi-hostname='10.0.0.1' \
    --sahi-port='9999' \
    --sahi-proto='http'  \
    --sahi-endpoint='/\_s\_/dyn/' \
    --sahi-suite='C:/sahi_pro/userdata/scripts/sahitests/small.suite' \
    --sahi-startwith='BROWSER' \
    --sahi-browsertype='chrome' \
    --verbose

La commande devrait retourner un message de sortie similaire à :

OK: Scenario status is SUCCESS, execution time: 10 ms, total steps: 2, failures: 0, errors: 0 - All steps are ok | 'scenario.execution.time.seconds'=10ms;;;0; 'scenario.steps.count'=2;;;0; 'scenario.failures.count'=0;;;0; 'scenario.errors.count'=0;;;0; '0#step.execution.time.second'=19ms;;;0; '1#step.execution.time.second'=121ms;;;0;
Step '0' [AUTH] execution time: 19 ms
Step '1' [READ] execution time: 121 ms

Diagnostic des erreurs communes

Rendez-vous sur la documentation dédiée des plugins basés sur HTTP/API.

Modes disponibles

Dans la plupart des cas, un mode correspond à un modèle de service. Le mode est renseigné dans la commande d'exécution du connecteur. Dans l'interface de Centreon, il n'est pas nécessaire de les spécifier explicitement, leur utilisation est implicite dès lors que vous utilisez un modèle de service. En revanche, vous devrez spécifier le mode correspondant à ce modèle si vous voulez tester la commande d'exécution du connecteur dans votre terminal.

Tous les modes disponibles peuvent être affichés en ajoutant le paramètre --list-mode à la commande :

/usr/lib/centreon/plugins/centreon_sahipro_restapi.pl \
    --plugin=apps::sahipro::restapi::plugin \
    --list-mode

Le plugin apporte les modes suivants :

Mode	Modèle de service associé
scenario	App-Sahipro-Restapi-Scenario-custom

Options disponibles

Options des modes

Les options disponibles pour chaque modèle de services sont listées ci-dessous :

Scenario

Option	Description
--mode	Define the mode in which you want the plugin to be executed (see--list-mode).
--dyn-mode	Specify a mode with the module's path (advanced).
--list-mode	List all available modes.
--mode-version	Check minimal version of mode. If not, unknown error.
--version	Return the version of the plugin.
--pass-manager	Define the password manager you want to use. Supported managers are: environment, file, keepass, hashicorpvault and teampass.
--verbose	Display extended status information (long output).
--debug	Display debug messages.
--filter-perfdata	Filter perfdata that match the regexp. Eg: adding --filter-perfdata='avg' will remove all metrics that do not contain 'avg' from performance data.
--filter-perfdata-adv	Filter perfdata based on a "if" condition using the following variables: label, value, unit, warning, critical, min, max. Variables must be written either %{variable} or %(variable). Eg: adding --filter-perfdata-adv='not (%(value) == 0 and %(max) eq "")' will remove all metrics whose value equals 0 and that don't have a maximum value.
--explode-perfdata-max	Create a new metric for each metric that comes with a maximum limit. The new metric will be named identically with a '_max' suffix). Eg: it will split 'used_prct'=26.93%;0:80;0:90;0;100 into 'used_prct'=26.93%;0:80;0:90;0;100 'used_prct_max'=100%;;;;
--change-perfdata --extend-perfdata	Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target[,[newuom],[min],[m ax]] Common examples: Convert storage free perfdata into used: --change-perfdata=free,used,invert() Convert storage free perfdata into used: --change-perfdata=used,free,invert() Scale traffic values automatically: --change-perfdata=traffic,,scale(auto) Scale traffic values in Mbps: --change-perfdata=traffic_in,,scale(Mbps),mbps Change traffic values in percent: --change-perfdata=traffic_in,,percent()
--extend-perfdata-group	Add new aggregated metrics (min, max, average or sum) for groups of metrics defined by a regex match on the metrics' names. Syntax: --extend-perfdata-group=regex,namesofnewmetrics,calculation[,[ne wuom],[min],[max]] regex: regular expression namesofnewmetrics: how the new metrics' names are composed (can use $1, $2... for groups defined by () in regex). calculation: how the values of the new metrics should be calculated newuom (optional): unit of measure for the new metrics min (optional): lowest value the metrics can reach max (optional): highest value the metrics can reach Common examples: Sum wrong packets from all interfaces (with interface need --units-errors=absolute): --extend-perfdata-group=',packets_wrong,sum(packets_(discard |error)_(in|out))' Sum traffic by interface: --extend-perfdata-group='traffic_in_(.*),traffic_$1,sum(traf fic_(in|out)_$1)'
--change-short-output --change-long-output	Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=pattern~replacement~modifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Eg: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up'
--change-exit	Replace an exit code with one of your choice. Eg: adding --change-exit=unknown=critical will result in a CRITICAL state instead of an UNKNOWN state.
--range-perfdata	Rewrite the ranges displayed in the perfdata. Accepted values: 0: nothing is changed. 1: if the lower value of the range is equal to 0, it is removed. 2: remove the thresholds from the perfdata.
--filter-uom	Mask the units when they don't match the given regular expression.
--opt-exit	Replace the exit code in case of an execution error (i.e. wrong option provided, SSH connection refused, timeout, etc). Default: unknown.
--output-ignore-perfdata	Remove all the metrics from the service. The service will still have a status and an output.
--output-ignore-label	Remove the status label ("OK:", "WARNING:", "UNKNOWN:", CRITICAL:") from the beginning of the output. Eg: 'OK: Ram Total:...' will become 'Ram Total:...'
--output-xml	Return the output in XML format (to send to an XML API).
--output-json	Return the output in JSON format (to send to a JSON API).
--output-openmetrics	Return the output in OpenMetrics format (to send to a tool expecting this format).
--output-file	Write output in file (can be combined with json, xml and openmetrics options). E.g.: --output-file=/tmp/output.txt will write the output in /tmp/output.txt.
--disco-format	Applies only to modes beginning with 'list-'. Returns the list of available macros to configure a service discovery rule (formatted in XML).
--disco-show	Applies only to modes beginning with 'list-'. Returns the list of discovered objects (formatted in XML) for service discovery.
--float-precision	Define the float precision for thresholds (default: 8).
--source-encoding	Define the character encoding of the response sent by the monitored resource Default: 'UTF-8'.
--http-peer-addr	Set the address you want to connect to. Useful if hostname is only a vhost, to avoid IP resolution.
--proxyurl	Proxy URL. Eg: http://my.proxy:3128
--proxypac	Proxy pac file (can be a URL or a local file).
--insecure	Accept insecure SSL connections.
--http-backend	Perl library to use for HTTP transactions. Possible values are: lwp (default) and curl.
--ssl-opt	Set SSL Options (--ssl-opt="SSL_version => TLSv1" --ssl-opt="SSL_verify_mode => SSL_VERIFY_NONE").
--curl-opt	Set CURL Options (--curl-opt="CURLOPT_SSL_VERIFYPEER => 0" --curl-opt="CURLOPT_SSLVERSION => CURL_SSLVERSION_TLSv1_1" ).
--sahi-hostname	IP Addr/FQDN of the host
--sahi-port	Port used (default: 9999)
--sahi-proto	Define HTTPS if needed (default: 'http')
--sahi-endpoint	Define endpoint (default: '/_s_/dyn/')
--sahi-suite	Define path for scenario files (required. Example: 'sahitests/small.suite')
--sahi-http-timeout	Timeout for each HTTP requests (Default: 5)
--sahi-threads	Number of simultaneous browser instances that can be executed (default: 1)
--sahi-startwith	Define the start mode (Default: BROWSER)
--sahi-browsertype	Browser used for script executions (Default: chrome)
--sahi-baseurl	Define default Start URL for scripts
--timeout	Define the global script timeout. If timeout is reached, scenario is killed.
--retries-scenario-status	Define the number of retries to get scenario status (if we fail to get the status).
--interval-scenario-status	Define time interval to get scenario status in seconds (default: 10).
--unknown-run-status	Unknown threshold for running scenario rest api response. (Default: '%{http_code} \< 200 or %{http_code} >= 300')
--warning-run-status	Warning threshold for running scenario rest api response.
--critical-run-status	Critical threshold for running scenario rest api response.
--warning-status	Define the conditions to match for the status to be WARNING. You can use the following variables: %{status}.
--critical-status	Define the conditions to match for the status to be CRITICAL (default: '%{status} ne "SUCCESS"'). You can use the following variables: %{status}.
--warning- --critical-	Thresholds. Can be: 'total-time', 'total-steps', 'failures', 'errors', 'step-time'.

Pour un mode, la liste de toutes les options disponibles et leur signification peut être affichée en ajoutant le paramètre --help à la commande :

/usr/lib/centreon/plugins/centreon_sahipro_restapi.pl \
    --plugin=apps::sahipro::restapi::plugin \
    --mode=scenario \
    --help