Skip to main content

Selenium

Connector dependencies​

The following monitoring connectors will be installed when you install the Selenium connector through the Configuration > Connectors > Monitoring Connectors menu:

Pack assets​

Templates​

The Monitoring Connector Selenium brings 2 host templates:

  • App-Selenium-Katalon-custom
  • App-Selenium-WAA-custom

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

Service AliasService TemplateService Description
Scenario-SeleniumApp-Selenium-Scenario-Katalon-customCheck to execute remotely a Selenium scenario and measure execution time (scenario based on the Katalon Automation Recorder web browser plugin with XML export)

The services listed above are created automatically when the App-Selenium-Katalon-custom host template is used.

Collected metrics & status​

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

NameUnit
_prct%
time-scenarioms
stateN/A
steps1#time-stepms
steps2#time-stepms

To obtain this new metric format, include --use-new-perfdata in the EXTRAOPTIONS service macro.

Prerequisites​

The target Selenium server must be reachable from the Centreon poller on the 4444 port (or another port and then you have to change the port in the host template).

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 > Connectors > Monitoring Connectors 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:
dnf install centreon-pack-applications-selenium
  1. Whatever the license type (online or offline), install the Selenium connector through the Configuration > Connectors > Monitoring Connectors 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:

dnf install centreon-plugin-Applications-Selenium

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 in the Name, Alias & IP Address/DNS fields according to your resource's settings.
  3. Apply the App-Selenium-Katalon-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.
MacroDescriptionDefault valueMandatory
SELENIUMHOSTNAMEIP Addr/FQDN of the Selenium server
SELENIUMPORTPort used by Selenium server4444
SCENARIODIRECTORYDirectory where scenarios are stored/var/lib/centreon_waa
SELENIUMBROWSERBrowser used by Selenium server*firefox
EXTRAOPTIONSAny extra option you may want to add to every command (a --verbose flag for example). All options are listed here.
  1. 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).
MacroDescriptionDefault valueMandatory
TIMEOUTSet scenario execution timeout in second50
ACTIONTIMEOUTSet action execution timeout in second10
SCENARIONAMEScenario to play (without extension)X
WARNINGFAILEDThreshold
CRITICALFAILEDThreshold
CRITICALSTATECritical threshold for step state%{state} !~ /OK/i
WARNINGSTATEWarning threshold for step state
WARNINGSUCCESSFULThreshold
CRITICALSUCCESSFULThreshold
WARNINGTIMESCENARIOWarning threshold in milliseconds for scenario execution time
CRITICALTIMESCENARIOCritical threshold in milliseconds for scenario execution time
WARNINGTIMESTEPWarning threshold in milliseconds for step execution time
CRITICALTIMESTEPCritical threshold in milliseconds for step execution time
EXTRAOPTIONSAny extra option you may want to add to the command (a --verbose flag for example). All options are listed here.--verbose
  1. Deploy the configuration. The service appears in the list of services, and on the Resources Status page. 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 a resource using a command like this one (replace the sample values by yours):

/usr/lib/centreon/plugins/centreon_selenium.pl \
	--plugin=apps::selenium::plugin \
	--mode=scenario-katalon \
	--selenium-hostname= \
	--selenium-port='4444' \
	--browser='*firefox' \
	--directory='/var/lib/centreon\_waa'  \
	--scenario='XXXX' \
	--timeout='50' \
	--action-timeout='10' \
	--warning-state='' \
	--critical-state='%\{state\} !~ /OK/i' \
	--warning-failed='' \
	--critical-failed='' \
	--warning-successful='' \
	--critical-successful='' \
	--warning-time-scenario='' \
	--critical-time-scenario='' \
	--warning-time-step='' \
	--critical-time-step='' \
	--verbose

The expected command output is shown below:

OK:   Total execution time : 912 ms All steps state are ok | '_prct'=75%;;;;100 '_prct'=96%;;;;100 'time-scenario'=912ms;;;0; 'steps1#time-step'=39595ms;;;0; 'steps2#time-step'=64207ms;;;0;

Troubleshooting​

Please find the troubleshooting documentation for Centreon Plugins typical issues.

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_selenium.pl \
	--plugin=apps::selenium::plugin \
	--list-mode

The plugin brings the following modes:

ModeLinked service template
scenario [code]App-Selenium-Scenario-WAA-custom
scenario-katalon [code]App-Selenium-Scenario-Katalon-custom

Available options​

Modes options​

All available options for each service template are listed below:

OptionDescription
--selenium-hostnameIP Addr/FQDN of the Selenium server.
--selenium-portPort used by Selenium server.
--browserBrowser used by Selenium server (default : '*firefox').
--directoryDirectory where scenarios are stored.
--scenarioScenario to play (without extension).
--timeoutSet scenario execution timeout in second (default: 50).
--warningWarning threshold in seconds (scenario execution time)
--criticalCritical threshold in seconds (scenario execution response time)
--filter-countersOnly display some counters (regexp can be used). Example to check SSL connections only : --filter-counters='^xxxx|yyyy$'
--force-continueDon't stop if error.
--action-timeoutSet action execution timeout in second (default: 10).
--warning-*Warning threshold for steps state count (can be: 'failed', 'successful').
--warning-stateWarning threshold for step state.
--critical-*Critical threshold for steps state count (can be: 'failed', 'successful').
--critical-stateCritical threshold for step state (default: '%{state} !~ /OK/i').
--warning-time-scenarioWarning threshold in milliseconds for scenario execution time.
--critical-time-scenarioCritical threshold in milliseconds for scenario execution time.
--warning-time-stepWarning threshold in milliseconds for step execution time.
--critical-time-stepCritical threshold in milliseconds for step execution time.

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

/usr/lib/centreon/plugins/centreon_selenium.pl \
	--plugin=apps::selenium::plugin \
	--mode=scenario-katalon \
	--help