sfl-shinken-plugins documentation¶

Install Selenium IDE¶

You need to install Firefox Selenium IDE extension. You can get it HERE

When you got this file, you have to install it in Firefox:

Click on Tools -> Add-ons

Go to Add-ons page

On Add-ons page, select Install Add-on from file...*

Install Add-on from file...

Select selenium-ide-2.8.0.xpi file on your system

selenium-ide-2.8.0.xpi file

Click on Install Now to install extensions

Click on Install Now

Configuration¶

You have to change the default configuration of your Firefox Selenium IDE extention.

To open Selenium IDE window, click on Tools -> Selenium IDE

Open Selenium IDE window

In Selenium IDE window, open settings by clicking on Options > Options

Menu Options

Then go on Locator Builders tab

Locators list

How to create a new scenario¶

This is an example how to create a new web scenario.

This scenario runs on http://savoirfairelinux.com:

1. sdg
2. sdg

1. First, you have to go to the web page where the web scenario starts. In this case, it’s http://savoirfairelinux.
2. Open Selenium IDE window; Click on Tools -> Selenium IDE

Open Selenium IDE window

3. When the Selenium IDE window is open, please ensure that record button is pushed

Record button

4. Now you can start your scenario. The first thing to do is to check if the first page is the good one. So, select any text in this page, right-click on it and select WaitForText ....

WaitForText .........

5. In Selenium IDE window, you can check the result of your action. A new line was created with WaitForText ....

New line WaitForText ....

6. Now you can continue your scenario. You can now click on Contact Us and wait th page is completely loaded

Contact Us page

7. As on the first page, select any text in this page, right-click on it and select WaitForText ....

WaitForText .........

8. Check the output on Selenium IDE window

New lines in Selenium IDE window

Now, you can continue your scenario following this example.

Save scenario¶

When you have finished your scenario, you can save it. This is highly recommended because, this is the only way to edit the scenario in the future ...

To save the sceario, click on File > Save test Case

Save scenario

Export scenario to Python file¶

In order to use the scenario with the check_selenium plugin, you need to export the scenario to a Python file.

Click on File > Export Test Case As... > Python 2 /unitest / WebDriver

Export scenario

Warning

Use only LOWER CASE letters (a-z) when you export a scenario !!!!!

Note

This file will be used by the check_selenium plugin

Recommendations¶

Requirements¶

This plugin need:

• selenium==2.44.0
• shinkenplugins==0.1.6
• xvfbwrapper==0.2.4

You can install it, with:

pip install -r requirements.txt

How to use the Plugin¶

Show help

$ ./check_selenium -h

Launch scenario

$ ./check_selenium -S scenarios -s savoirfairelinuxcom
OK: Scenario execution time: 4.57 seconds

If you get an error/bug in your scenario with the plugin, you can launch it in debug mode. In debug mode, Firefox will be launched on your display. You will be able to see what Firefox does.

$ ./check_selenium -S scenarios -s savoirfairelinuxcom -d
OK: Scenario execution time: 4.57 seconds

You can also set the size of your Firefox use -W and -H options. This is usefull for scenario on mobile web site.

$ ./check_selenium -S scenarios -s savoirfairelinuxcom -W 400 -H 800
OK: Scenario execution time: 4.57 seconds

Here, the example of command which can be used in your shinken configuration. Don’t forget to add -f option to get perfdata and get graph.

$ $USER1$/check_selenium -S $SCENARIOS_FOLDER$ -s $ARG1$ -w $ARG2$ -c $ARG3$ -f

Shinken Modules¶

Plugins¶

/usr/lib/nagios/plugins/check_http

/usr/lib64/nagios/plugins/check_http

Network¶

This pack will create services which need the following protocol :

• TCP 80 and/or 443 from Poller to monitored client

Settings¶

This is the list of settings which can be redefined in the host definition

Shinken Modules¶

Plugins¶

/usr/lib/nagios/plugins/check_dhcp

/usr/lib64/nagios/plugins/check_dhcp

-rwsr-xr-x root root check_dhcp

Network¶

This pack will create services which need the following protocol :

• UDP 67 and 68 from Poller to monitored client

Settings¶

This is the list of settings which can be redefined in the host definition

Triggers¶

No trigger used with this packs

Shinken Modules¶

Plugins¶

/usr/lib/nagios/plugins/check_dns

/usr/lib64/nagios/plugins/check_dns

Network¶

This pack will create services which need the following protocol :

• UDP 53 and/or TCP 53 from Poller to monitored client

Settings¶

Triggers¶

No trigger used with this pack

Shinken Modules¶

Plugins¶

/usr/lib/nagios/plugins/check_http

/usr/lib64/nagios/plugins/check_http

Network¶

This pack will create services which need the following protocol :

• TCP 80 and 443 from Poller to monitored client

Settings¶

This is the list of settings which can be redefined in the host definition

Shinken Modules¶

Plugins¶

/usr/lib/nagios/plugins/check_ping

/usr/lib64/nagios/plugins/check_ping

Network¶

This pack will create services which need the following protocol :

• ICMP

Settings¶

This is the list of settings which can be redefined in the host definition

Triggers¶

This is the list of triggers used in the pack :

• collectd_cpu.trig
• collectd_df.trig
• collectd_disk.trig
• collectd_interface.trig
• collectd_load.trig
• collectd_memory.trig
• collectd_processes.trig
• collectd_swap.trig
• collectd_users.trig

Shinken Modules¶

Plugins¶

/usr/lib/nagios/plugins/check_ldap

/usr/lib64/nagios/plugins/check_ldap

/usr/lib/nagios/plugins/check_ldaps

/usr/lib64/nagios/plugins/check_ldaps

/usr/lib/nagios/plugins/check_tcp

/usr/lib64/nagios/plugins/check_tcp

Network¶

This pack will create services which need the following protocol :

• TCP 636 from Poller to monitored client with SSL
• TCP 389 from Poller to monitored client without SSL

Templates¶

sfl-generic-ldap¶

Use this template to monitoring a standard LDAP server.

sfl-generic-ldap3¶

Use this template to monitoring a LDAP3 server.

sfl-generic-ldaps¶

Use this template to monitoring a LDAPS server.

Settings¶

This is the list of settings which can be redefined in the host definition

Triggers¶

Shinken Modules¶

Plugins¶

This pack will create services which need the following plugin :

https://github.com/mzupan/nagios-plugin-mongodb/blob/master/check_mongodb.py

and it here:

/usr/lib/nagios/plugins/check_mongodb.py

Network¶

This pack will create services which need the following protocol :

• TCP 27017 to connect with MongoDB
• SSL

Settings¶

This is the list of settings which can be redefined in the host definition

Shinken Modules¶

Plugins¶

/usr/lib/nagios/plugins/check_http

/usr/lib64/nagios/plugins/check_http

Network¶

This pack will create services which need the following protocol :

• TCP 80 and 443 from Poller to monitored client

Settings¶

This is the list of settings which can be redefined in the host definition

Shinken Modules¶

Plugins¶

/usr/lib/nagios/plugins/check_radius

/usr/lib64/nagios/plugins/check_radius

Network¶

This pack will create services which need the following protocol :

• UDP : 1645 or 1812 from Poller to monitored client

Settings¶

This is the list of settings which can be redefined in the host definition

Shinken Modules¶

Plugins¶

/usr/lib/nagios/plugins/check_http

/usr/lib64/nagios/plugins/check_http

Network¶

This pack will create services which need the following protocol :

• UDP 80 and 443 from Poller to monitored client

Settings¶

This is the list of settings which can be redefined in the host definition

Shinken Modules¶

Plugins¶

/usr/lib/nagios/plugins/check_tcp

/usr/lib64/nagios/plugins/check_tcp

Network¶

This pack will create services which need the following protocol :

• TCP 4505 Poller to monitored client

Settings¶

This is the list of settings which can be redefined in the host definition

Shinken Modules¶

Plugins¶

/usr/lib/nagios/plugins/check_samba.py

/usr/lib64/nagios/plugins/check_samba.py

Network¶

This pack will create services which need the following protocol :

• TCP 139 from Poller to monitored client

Settings¶

This is the list of settings which can be redefined in the host definition

Shinken Modules¶

Plugins¶

/usr/lib/nagios/plugins/check_dhcp

/usr/lib64/nagios/plugins/check_dhcp

-rwsr-xr-x root root check_dhcp

Network¶

This pack will create services which need the following protocol :

• UDP 67 and 68 from Poller to monitored client

Settings¶

This is the list of settings which can be redefined in the host definition

Shinken Modules¶

Plugins¶

/usr/lib/nagios/plugins/check_ssh

/usr/lib64/nagios/plugins/check_ssh

Network¶

This pack will create services which need the following protocol :

• TCP 22 from Poller to monitored client

Settings¶

This is the list of settings which can be redefined in the host definition

Shinken Modules¶

This pack will create services which need the following modules :

• Arbiter/Receiver : mod-collectd

Plugins¶

This pack will create services which need the following plugins :

Network¶

This pack will create services which need the following protocol :

• UDP 25826 from monitored client to the Arbiter/Receiver Collectd module

Settings¶

This is the list of settings which can be redefined in the host definition

Triggers¶

This is the list of triggers used in the pack :

• collectd_ntpd.trig

Shinken Modules¶

This pack will create services which need the following modules :

• Arbiter/Receiver : mod-collectd

Here an example of a arbiter-collectd module config file:

Plugins¶

This pack will create services which need the following plugins :

Network¶

This pack will create services which need the following protocol :

• UDP 25826 from monitored client to the Arbiter/Receiver Collectd module

Collectd¶

Here an example of a collectd config file:

Settings¶

This is the list of settings which can be redefined in the host definition

Triggers¶

This is the list of triggers used in the pack :

• collectd_processes.trig

Shinken Modules¶

This pack will create services which need the following modules :

• Arbiter/Receiver : mod-collectd

Here an example of a arbiter-collectd module config file:

Plugins¶

This pack will create services which need the following plugins :

Network¶

This pack will create services which need the following protocol :

• UDP 25826 from monitored client to the Arbiter/Receiver Collectd module

Collectd¶

Here an example of a collectd config file:

# COLLECTD: custom configuration file used by STM.

# Global options

Hostname "HOSTNAME"

# When the network plugins (network, write_graphite, etc.) take too
# long to respond, limit the metric list stored in memory.
# e.g. When the remote server times out, do not attempt to store all
# the values in memory.
WriteQueueLimitHigh 50
WriteQueueLimitLow 50

######################################################################
# Common plugins for all the machines.

# Activate the logging plugin before all the others
LoadPlugin syslog
<Plugin syslog>
    LogLevel info
    NotifyLevel WARNING
</Plugin>

# some plugins will be configured in other files
LoadPlugin cpu
LoadPlugin load
LoadPlugin memory
LoadPlugin users
LoadPlugin disk
LoadPlugin df
LoadPlugin interface
LoadPlugin ntpd
LoadPlugin swap
LoadPlugin processes

# NTP comes from 2 servers
<Plugin ntpd>
    Host "10.133.63.17"
    Host "10.133.63.19"
    Port 123
    ReverseLookups false
    IncludeUnitID true
</Plugin>

<Plugin df>
    IgnoreSelected false
    ReportByDevice false
    # Also including the reserved space
    ReportReserved true
    # Free/Used Inodes
    ReportInodes true
</Plugin>

<Plugin processes>
    Process "shinken-poller.py"
    Process "cron"
#    Process "rsyslogd"
</Plugin>

# The network plugin send the results to Shinken
LoadPlugin network
<Plugin network>
    Server "10.133.63.18" "25826"
</Plugin>

# All the machines will send their data to graphite
LoadPlugin write_graphite
<Plugin write_graphite>
    <Node "graphite_server_1">
        Host "10.133.63.13"
        Port "2003"
        Prefix ""
        Postfix ".collectd"
        Protocol "tcp"
        LogSendErrors true
    </Node>
    <Node "graphite_server_2">
        Host "10.133.63.14"
        Port "2003"
        Prefix ""
        Postfix ".collectd"
        Protocol "tcp"
        LogSendErrors true
    </Node>
</Plugin>

######################################################################
#  Search for configuration in the directory
Include "/opt/collectd/etc/conf.d"

# this file is provided by (Minion ID): SHINKENPOLLER

Settings¶

This is the list of settings which can be redefined in the host definition

Triggers¶

This is the list of triggers used in the pack :

• collectd_processes.trig

Shinken Modules¶

This pack will create services which need the following modules :

• Arbiter/Receiver : mod-collectd

Here an example of a arbiter-collectd module config file:

Plugins¶

This pack will create services which need the following plugins :

Network¶

This pack will create services which need the following protocol :

• UDP 25826 from monitored client to the Arbiter/Receiver Collectd module

Collectd¶

Here an example of a collectd config file:

# COLLECTD: custom configuration file used by STM.

# Global options

Hostname "HOSTNAME"

# When the network plugins (network, write_graphite, etc.) take too
# long to respond, limit the metric list stored in memory.
# e.g. When the remote server times out, do not attempt to store all
# the values in memory.
WriteQueueLimitHigh 50
WriteQueueLimitLow 50

######################################################################
# Common plugins for all the machines.

# Activate the logging plugin before all the others
LoadPlugin syslog
<Plugin syslog>
    LogLevel info
    NotifyLevel WARNING
</Plugin>

# some plugins will be configured in other files
LoadPlugin cpu
LoadPlugin load
LoadPlugin memory
LoadPlugin users
LoadPlugin disk
LoadPlugin df
LoadPlugin interface
LoadPlugin ntpd
LoadPlugin swap
LoadPlugin processes

# NTP comes from 2 servers
<Plugin ntpd>
    Host "10.133.63.17"
    Host "10.133.63.19"
    Port 123
    ReverseLookups false
    IncludeUnitID true
</Plugin>

<Plugin df>
    IgnoreSelected false
    ReportByDevice false
    # Also including the reserved space
    ReportReserved true
    # Free/Used Inodes
    ReportInodes true
</Plugin>

<Plugin processes>
    Process "shinken-poller.py"
    Process "cron"
#    Process "rsyslogd"
</Plugin>

# The network plugin send the results to Shinken
LoadPlugin network
<Plugin network>
    Server "10.133.63.18" "25826"
</Plugin>

# All the machines will send their data to graphite
LoadPlugin write_graphite
<Plugin write_graphite>
    <Node "graphite_server_1">
        Host "10.133.63.13"
        Port "2003"
        Prefix ""
        Postfix ".collectd"
        Protocol "tcp"
        LogSendErrors true
    </Node>
    <Node "graphite_server_2">
        Host "10.133.63.14"
        Port "2003"
        Prefix ""
        Postfix ".collectd"
        Protocol "tcp"
        LogSendErrors true
    </Node>
</Plugin>

######################################################################
#  Search for configuration in the directory
Include "/opt/collectd/etc/conf.d"

# this file is provided by (Minion ID): SHINKENPOLLER

Settings¶

This is the list of settings which can be redefined in the host definition

Triggers¶

This is the list of triggers used in the pack :

• collectd_processes.trig

Shinken Modules¶

This pack will create services which need the following modules :

• Arbiter/Receiver : mod-collectd

Here an example of a arbiter-collectd module config file:

## Module:      Collectd
## Loaded by:   Arbiter, Receiver
# Receive passive host and service results from a collectd daemon.
define module {
   module_name Collectd
   module_type collectd
#
#  Specify exact host (optional)
   host        0.0.0.0
   port        25826
#   port        25827
#   multicast   False
 grouped_collectd_plugins   cpu,df,disk,interface,ntpd
}

# this file is provided by (Minion ID): SHINKENFULL

Plugins¶

This pack will create services which need the following plugins :

Network¶

This pack will create services which need the following protocol :

• UDP 25826 from monitored client to the Arbiter/Receiver Collectd module

Collectd¶

Here an example of a collectd config file:

# COLLECTD: custom configuration file used by STM.

# Global options

Hostname "HOSTNAME"

# When the network plugins (network, write_graphite, etc.) take too
# long to respond, limit the metric list stored in memory.
# e.g. When the remote server times out, do not attempt to store all
# the values in memory.
WriteQueueLimitHigh 50
WriteQueueLimitLow 50

######################################################################
# Common plugins for all the machines.

# Activate the logging plugin before all the others
LoadPlugin syslog
<Plugin syslog>
    LogLevel info
    NotifyLevel WARNING
</Plugin>

# some plugins will be configured in other files
LoadPlugin cpu
LoadPlugin load
LoadPlugin memory
LoadPlugin users
LoadPlugin disk
LoadPlugin df
LoadPlugin interface
LoadPlugin ntpd
LoadPlugin swap
LoadPlugin processes

# NTP comes from 2 servers
<Plugin ntpd>
    Host "10.133.63.17"
    Host "10.133.63.19"
    Port 123
    ReverseLookups false
    IncludeUnitID true
</Plugin>

<Plugin df>
    IgnoreSelected false
    ReportByDevice false
    # Also including the reserved space
    ReportReserved true
    # Free/Used Inodes
    ReportInodes true
</Plugin>

<Plugin processes>
    Process "shinken-poller.py"
    Process "cron"
#    Process "rsyslogd"
</Plugin>

# The network plugin send the results to Shinken
LoadPlugin network
<Plugin network>
    Server "10.133.63.18" "25826"
</Plugin>

# All the machines will send their data to graphite
LoadPlugin write_graphite
<Plugin write_graphite>
    <Node "graphite_server_1">
        Host "10.133.63.13"
        Port "2003"
        Prefix ""
        Postfix ".collectd"
        Protocol "tcp"
        LogSendErrors true
    </Node>
    <Node "graphite_server_2">
        Host "10.133.63.14"
        Port "2003"
        Prefix ""
        Postfix ".collectd"
        Protocol "tcp"
        LogSendErrors true
    </Node>
</Plugin>

######################################################################
#  Search for configuration in the directory
Include "/opt/collectd/etc/conf.d"

# this file is provided by (Minion ID): SHINKENPOLLER

Settings¶

This is the list of settings which can be redefined in the host definition

Triggers¶

This is the list of triggers used in the pack :

• collectd_cpu.trig
• collectd_df.trig
• collectd_disk.trig
• collectd_interface.trig
• collectd_load.trig
• collectd_memory.trig
• collectd_processes.trig
• collectd_swap.trig
• collectd_users.trig

Shinken Modules¶

Plugins¶

/usr/lib/nagios/plugins/check_vmware_api.pl

Network¶

This pack will create services which need the following protocol :

• TCP 80 and 443 from Poller to monitored client

Settings¶

This is the list of settings which can be redefined in the host definition

Shinken Modules¶

Plugins¶

/usr/lib/nagios/plugins/check_dhcp

/usr/lib64/nagios/plugins/check_dhcp

-rwsr-xr-x root root check_dhcp

Network¶

This pack will create services which need the following protocol :

• UDP 67 and 68 from Poller to monitored client

Settings¶

This is the list of settings which can be redefined in the host definition

Triggers¶

This is the list of triggers used in the pack :

• collectd_cpu.trig
• collectd_df.trig
• collectd_disk.trig
• collectd_interface.trig
• collectd_load.trig
• collectd_memory.trig
• collectd_processes.trig
• collectd_swap.trig
• collectd_users.trig

Shinken Modules¶

Plugins¶

/usr/lib/nagios/plugins/check_mssql_health

/usr/lib64/nagios/plugins/check_mssql_health

Network¶

This pack will create services which need the following protocol :

• TCP 1433 from Poller to monitored client

Settings¶

This is the list of settings which can be redefined in the host definition

Triggers¶

Shinken Modules¶

Plugins¶

/usr/lib/nagios/plugins/check_x224

/usr/lib64/nagios/plugins/check_x224

Network¶

This pack will create services which need the following protocol :

• TCP 3389 from Poller to monitored client

Settings¶

Shinken Modules¶

This pack will create services which need the following modules :

• Arbiter/Receiver : mod-collectd

Here an example of a arbiter-collectd module config file:

## Module:      Collectd
## Loaded by:   Arbiter, Receiver
# Receive passive host and service results from a collectd daemon.
define module {
   module_name Collectd
   module_type collectd
#
#  Specify exact host (optional)
   host        0.0.0.0
   port        25826
#   port        25827
#   multicast   False
 grouped_collectd_plugins   cpu,df,disk,interface,ntpd
}

# this file is provided by (Minion ID): SHINKENFULL

Plugins¶

This pack will create services which need the following plugins :

Network¶

This pack will create services which need the following protocol :

• UDP 25826 from monitored client to the Arbiter/Receiver Collectd module

Collectd¶

Here an example of a collectd config file:

# COLLECTD: custom configuration file used by STM.

# Global options

Hostname "HOSTNAME"

# When the network plugins (network, write_graphite, etc.) take too
# long to respond, limit the metric list stored in memory.
# e.g. When the remote server times out, do not attempt to store all
# the values in memory.
WriteQueueLimitHigh 50
WriteQueueLimitLow 50

######################################################################
# Common plugins for all the machines.

# Activate the logging plugin before all the others
LoadPlugin syslog
<Plugin syslog>
    LogLevel info
    NotifyLevel WARNING
</Plugin>

# some plugins will be configured in other files
LoadPlugin cpu
LoadPlugin load
LoadPlugin memory
LoadPlugin users
LoadPlugin disk
LoadPlugin df
LoadPlugin interface
LoadPlugin ntpd
LoadPlugin swap
LoadPlugin processes

# NTP comes from 2 servers
<Plugin ntpd>
    Host "10.133.63.17"
    Host "10.133.63.19"
    Port 123
    ReverseLookups false
    IncludeUnitID true
</Plugin>

<Plugin df>
    IgnoreSelected false
    ReportByDevice false
    # Also including the reserved space
    ReportReserved true
    # Free/Used Inodes
    ReportInodes true
</Plugin>

<Plugin processes>
    Process "shinken-poller.py"
    Process "cron"
#    Process "rsyslogd"
</Plugin>

# The network plugin send the results to Shinken
LoadPlugin network
<Plugin network>
    Server "10.133.63.18" "25826"
</Plugin>

# All the machines will send their data to graphite
LoadPlugin write_graphite
<Plugin write_graphite>
    <Node "graphite_server_1">
        Host "10.133.63.13"
        Port "2003"
        Prefix ""
        Postfix ".collectd"
        Protocol "tcp"
        LogSendErrors true
    </Node>
    <Node "graphite_server_2">
        Host "10.133.63.14"
        Port "2003"
        Prefix ""
        Postfix ".collectd"
        Protocol "tcp"
        LogSendErrors true
    </Node>
</Plugin>

######################################################################
#  Search for configuration in the directory
Include "/opt/collectd/etc/conf.d"

# this file is provided by (Minion ID): SHINKENPOLLER

Settings¶

This is the list of settings which can be redefined in the host definition

Triggers¶

This is the list of triggers used in the pack :

• windows_collectd_service.trig
• windows_collectd_processes.trig

Shinken Modules¶

Plugins¶

/usr/lib/nagios/plugins/check_dhcp

/usr/lib64/nagios/plugins/check_dhcp

-rwsr-xr-x root root check_dhcp

Network¶

This pack will create services which need the following protocol :

• UDP 67 and 68 from Poller to monitored client

Settings¶

This is the list of settings which can be redefined in the host definition

Shinken Modules¶

This pack will create services which need the following modules :

• Arbiter/Receiver : mod-collectd

Here an example of a arbiter-collectd module config file:

Plugins¶

This pack will create services which need the following plugins :

Network¶

This pack will create services which need the following protocol :

• UDP 25826 from monitored client to the Arbiter/Receiver Collectd module

Collectd¶

Here an example of a collectd config file:

Settings¶

This is the list of settings which can be redefined in the host definition

Triggers¶

This is the list of triggers used in the pack :

• windows_collectd_counter.trig
• windows_collectd_counter_multiple.trig
• windows_collectd_cpu.trig
• windows_collectd_df.trig
• windows_collectd_disk.trig
• windows_collectd_interface.trig
• windows_collectd_memory.trig
• windows_collectd_memory-pagefile.trig
• windows-collectd_process.trig
• windows-collectd_processes.trig
• windows-collectd_service.trig
• windows-collectd_users.trig