Class SystemExecuteMonitor
- java.lang.Object
-
- org.opennms.netmgt.poller.support.AbstractServiceMonitor
-
- org.opennms.netmgt.poller.monitors.SystemExecuteMonitor
-
- All Implemented Interfaces:
ServiceMonitor
public final class SystemExecuteMonitor extends AbstractServiceMonitor
-
-
Constructor Summary
Constructors Constructor Description SystemExecuteMonitor()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PollStatus
poll(MonitoredService svc, Map<String,Object> parameters)
This method is the heart of the plug-in monitor.-
Methods inherited from class org.opennms.netmgt.poller.support.AbstractServiceMonitor
getEffectiveLocation, getKeyedBoolean, getKeyedInstance, getKeyedInteger, getKeyedLong, getKeyedObject, getKeyedString, getRuntimeAttributes, getServiceProperties
-
-
-
-
Method Detail
-
poll
public PollStatus poll(MonitoredService svc, Map<String,Object> parameters)
This method is the heart of the plug-in monitor. Each time an interface requires a check to be performed as defined by the scheduler the poll method is invoked. The poll is passed the service to check.
By default when the status transition from up to down or vice versa the framework will generate an event. Additionally, if the polling interval changes due to an extended unavailability, the framework will generate an additional down event. The plug-in can suppress the generation of the default events by setting the suppress event bit in the returned integer.
NOTE: This method may be invoked on a Minion, in which case certain bean and facilities will not be available. If any state related information is required such as agent related configuration, it should retrieved by the
During the poll an attempt is made to call the specified external script or program. The banner line returned as standard output by the script or program is parsed for a partial match with the banner string specified in the poller configuration. Provided that the script's response is valid we set the service status to SERVICE_AVAILABLE and return. The parameter script The parameter args is handed over to the called script. The following variables will be replaced. ${timeout} will be replaced with the specified timeout in milliseconds. ${timeoutsec} will be replaced with the specified timeout in seconds not in milliseconds. ${retry} will be replaced with the amount off specified retires. ${ipaddr} will be replaced with the ip-address of the interface that holds the polled service at the node. ${nodeid} will be replaced with the nodeid of the node that holds the polled service. ${nodelabel} will be replaced with the nodelabel of the node that holds the polled service. ${svcname} will be replaced with the name of the polled service. The timeout is handled by ExecRunner and is also passed as a parameter to the script or program being called.ServiceMonitor.getRuntimeAttributes(MonitoredService, Map)
.- Parameters:
svc
- Includes details about to the service being monitored.parameters
- Includes the service parameters defined in poller-configuration.xml and those returned byServiceMonitor.getRuntimeAttributes(MonitoredService, Map)
.- Returns:
- The availability of the interface and if a transition event should be suppressed.
- See Also:
PollStatus.SERVICE_AVAILABLE
,PollStatus.SERVICE_UNAVAILABLE
,PollStatus.SERVICE_AVAILABLE
,PollStatus.SERVICE_UNAVAILABLE
-
-