Sahi Pro Rest API

Pack assets

Sahi Pro is a test automation software for desktop applications, mobile applications and web applications.

Templates

The Monitoring Connector Sahi Pro Rest API brings a host template:

• App-Sahipro-Restapi-custom

The connector brings the following service templates (sorted by the host template they are attached to):

App-Sahipro-Restapi-custom

This host template does not bring any service template.

Not attached to a host template

Service Alias	Service Template	Service Description
Scenario	App-Sahipro-Restapi-Scenario-custom	Check scenario execution

The services listed above are not created automatically when a host template is applied. To use them, create a service manually, then apply the service template you want.

Collected metrics & status

Here is the list of services for this connector, detailing all metrics linked to each service.

Scenario

Metric name	Unit
scenario status
scenario.execution.time.seconds	ms
scenario.steps.count
scenario.failures.count
scenario.errors.count
step_num#step.execution.time.second	ms

Prerequisites

To monitor this type of resource, a user with read privileges on the Sahi Pro REST API is required.

Installing the monitoring connector

Pack

1. If the platform uses an online license, you can skip the package installation instruction below as it is not required to have the connector displayed within the Configuration > Monitoring Connector Manager menu. If the platform uses an offline license, install the package on the central server with the command corresponding to the operating system's package manager:

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

apt install centreon-pack-applications-sahipro-restapi

CentOS 7

yum install centreon-pack-applications-sahipro-restapi

2. Whatever the license type (online or offline), install the Sahi Pro Rest API connector through the Configuration > Monitoring Connector Manager menu.

Plugin

Since Centreon 22.04, you can benefit from the 'Automatic plugin installation' feature. When this feature is enabled, you can skip the installation part below.

You still have to manually install the plugin on the poller(s) when:

• Automatic plugin installation is turned off
• You want to run a discovery job from a poller that doesn't monitor any resource of this kind yet

More information in the Installing the plugin section.

Use the commands below according to your operating system's package manager:

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

apt install centreon-plugin-applications-sahipro-restapi

CentOS 7

yum install centreon-plugin-Applications-Sahipro-Restapi

Using the monitoring connector

Using a host template provided by the connector

1. Log into Centreon and add a new host through Configuration > Hosts.
2. Fill the Name, Alias & IP Address/DNS fields according to your ressource settings.
3. Apply the App-Sahipro-Restapi-custom template to the host. A list of macros appears. Macros allow you to define how the connector will connect to the resource, and to customize the connector's behavior.
4. Fill in the macros you want. Some macros are mandatory.

Macro	Description	Default value	Mandatory
SAHIAPIPORT		9999
SAHIAPIPROTOCOL		http

5. Deploy the configuration. The host appears in the list of hosts, and on the Resources Status page. The command that is sent by the connector is displayed in the details panel of the host: it shows the values of the macros.

Using a service template provided by the connector

1. If you have used a host template and checked Create Services linked to the Template too, the services linked to the template have been created automatically, using the corresponding service templates. Otherwise, create manually the services you want and apply a service template to them.
2. Fill in the macros you want (e.g. to change the thresholds for the alerts). Some macros are mandatory (see the table below).

Scenario

Macro	Description	Default value	Mandatory
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). All options are listed here	--verbose

3. Deploy the configuration. The service appears in the list of services, and on page Resources Status. The command that is sent by the connector is displayed in the details panel of the service: it shows the values of the macros.

How to check in the CLI that the configuration is OK and what are the main options for?

Once the plugin is installed, log into your Centreon poller's CLI using the centreon-engine user account (su - centreon-engine). Test that the connector is able to monitor the resource using a command like this one (replace the sample values by yours):

/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

The expected command output is shown below:

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

Troubleshooting

Please find the troubleshooting documentation for the API-based plugins in this chapter.

Available modes

In most cases, a mode corresponds to a service template. The mode appears in the execution command for the connector. In the Centreon interface, you don't need to specify a mode explicitly: its use is implied when you apply a service template. However, you will need to specify the correct mode for the template if you want to test the execution command for the connector in your terminal.

All available modes can be displayed by adding the --list-mode parameter to the command:

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

The plugin brings the following modes:

Mode	Linked service template
scenario	App-Sahipro-Restapi-Scenario-custom

Available options

Modes options

All available options for each service template are listed below:

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'.

All available options for a given mode can be displayed by adding the --help parameter to the command:

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