Creating a New openITCOCKPIT Check Plugin¶
openITCOCKPIT uses a plugin-based system to check the status of hosts and services. The plugin API is 100% compatible with the Nagios , Naemon , Shinken and Icinga 1.x plugin API. By default, openITCOCKPIT comes with a standard set of plugins for the basic checking of network features such as ports, running processes, CPU usage, etc.
In some cases, it will be practical to write your own specialised plugin(s) for in-depth monitoring.
Plugins for openITCOCKPIT can be developed in all programming languages. From a simple bash script to a complex Python or C binary - everything is possible. For some languages such as Perl or Python , there are even helper classes that speed up and simplify development.
Plugin overview¶
To be compatible with openITCOCKPIT, a plugin must meet the following minimum requirements:
- The script or binary must be executable
- Must "exit" with a valid return value (see Return Codes)
- Must return at least one line of text (plugin output) to STDOUT.
Plugin paths¶
The standard plugins that are delivered with openITCOCKPIT are located in the folder /opt/openitc/nagios/libexec. It
is recommended (but not necessary) to create a separate folder for your own plugins, for
example /opt/openitc/my_checks/.
Return codes¶
Hosts¶
| Plugin return code | Host state |
|---|---|
| 0 | UP |
| 1 | DOWN |
| 2 | UNREACHABLE |
Services¶
| Plugin return code | Service state |
|---|---|
| 0 | OK |
| 1 | WARNING |
| 2 | CRITICAL |
| 3 | UNKNOWN |
Plugin output¶
By default, the "plugin output" must be one line of text to STDOUT, as in this example:
#!/bin/bash
echo "This is the minimum plugin output"
# Return with status UP or OK
exit 0
openITCOCKPIT supports BBCode for controlling the style of embedded hyperlinks in the plugin output.
echo "This is [b]bold text[/b]"
Performance data (metrics)¶
Performance data is used by openITCOCKPIT to create graphs for the user interface, for notifications and Grafana.
Performance data is separated from the plugin output by a "pipe" symbol |. This is optional as not every plugin provides performance data.
The format for the performance data is as follows:
'label'=value[UOM];[warn];[crit];[min];[max]
- A space-separated list of label/value pairs
- If the label contains a space, the label must be enclosed in single quotes (').
- Numerical values must be given in US format (
10.5instead of10,5). - Optional unit of measurement (e.g.:
s,ms,kgetc.) - Optional WARNING threshold 2. Optional CRITICAL threshold 3. Optional minimum threshold 4. Optional maximum threshold
| Example plugin output | Legend |
|---|---|
| PING OK - Packet loss = 0%, RTA = 17.30 ms|rta=17.302000ms;100.000000;500.000000;0.000000 pl=0%;20;60;0 | Plugin output performance data |