develop your own plugin
we think that an exemplary monitoring system must have the possibility to create your onw plugins because nonbody knows your system requirements. the plugin methode "public int runCheck()" must!!! return one of the following codes:
- Plugin.PLUGIN_STATE_UNKNOWN
- Plugin.PLUGIN_STATE_OK
- Plugin.PLUGIN_STATE_WARNING
- Plugin.PLUGIN_STATE_CRITICAL
so we try to make your way easy to implement you special requirements.
first step:
create a class like MyOwnPlugin and extends it from AbstractPlugin like this:
public class MyOwnPlugin extends AbstractPlugin
{
private static Logger _logger = LoggerFactory.getLogger(MyOwnPlugin.class);
public MyOwnPlugin(IHostContext hostContext, Configuration pluginConfiguration, int maxTries)
{
super(hostContext, pluginConfiguration, maxTries);
}
/**
* execute the plugin test.
*/
public int runCheck()
{
int returnCode = IPlugin.PLUGIN_STATE_UNKNOWN;
String hostToCheck = getPluginContext().getHostContext().getName();
//
// now start your check against the host
//
try
{
... do check something
if (checkWasOk())
returnCode = IPlugin.PLUGIN_STATE_OK;
}
catch (Exception e)
{
pluginResult.setResultString(e.getLocalizedMessage());
returnCode = IPlugin.PLUGIN_STATE_CRITICAL;
}
return returnCode;
}
}
or we use groovy and create an file in your script directory like MyOwnPlugin.gy and insert following content:
import de.hsofttec.monitoring.plugin.IPlugin
println "Hey dude, i check something"
println "and my name is '" + pluginContext.getDescription() + "'"
pluginContext.getPluginResult().setLastEventMessage("TestResultString")
return IPlugin.PLUGIN_STATE_OK
second step:
create a configuration file MyOwnPlugin.properties like this:
#
# the monitor may convert follwing template names:
#
# ${host} - the host, this plugin should test
# ${script_directory} - the directory name, where the scripts resists
#
#
# insert here the plugin class or script, that should run.
# the class must be declared with full package path
# with a leading property key "class"
# a script mast start with a leading property key "script"
#
# example :
# class = org.sf.monyserv.plugins.TcpPlugin
# or
# script = ${script_directory}/GroovyPlugin.gy
class = org.sf.monyserv.plugins.TcpPlugin
#
# set a short description for this plugin.
#
# example :
# description = My Description
description = My Description
#
# set the duration in seconds to execute this plugin.
# standard duration is every 60 second
#
# example :
# duration = 60
duration = 60
#
# insert the escalation configuration
# the monitor search this configurations relative to the escalations directory thats
# configured in "monitor.properties"
#
# example :
# escalation = email.properties
escalation = email.properties
all listet property keys are the minimal "must have" in a plugin configuration. all other keywords are optional
for your plugin purpose.
third step:
insert a plugin entry in your host file like "myserver.properties"
#
# insert here the plugins, that should run against the declared host.
# every entry must start with "plugin." followed by the sequential number
# the monitor search this configurations relative to the plugins directory thats
# configured in "monitor.properties"
#
plugin.0 = MyOwnPlugin.properties
plugin.0.max.tries = 5
after saving your changes restart MonYServ, simple isnt it?