Package org.opennms.netmgt.poller.monitors

Class HostResourceSwRunMonitor

  • All Implemented Interfaces:
    ServiceMonitor
    public class HostResourceSwRunMonitor
extends SnmpMonitorStrategy

    This class is designed to be used by the service poller framework to test the status of services reported in the Host Resources SW Run Table. The class implements the ServiceMonitor interface that allows it to be used along with other plug-ins by the service poller framework.

    This does SNMP and therefore relies on the SNMP configuration so it is not distributable.

    Feature Added (2013-01-23):

    This class uses TableTracker to request multiple columns at once and avoid possible problems, if the table is re-indexed at the moment is being collected, which is a problem with volatile services, or service with several forks like crond.

    Author:
    Tarus Balog , Alejandro Galue , OpenNMS

    • Constructor Detail

      • HostResourceSwRunMonitor

        public HostResourceSwRunMonitor()

    • Method Detail

      • poll

        public PollStatus poll​(MonitoredService svc,
                       java.util.Map<java.lang.String,​java.lang.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 ServiceMonitor.getRuntimeAttributes(MonitoredService, Map).

        The poll() method is responsible for polling the specified address for SNMP service availability.

        Parameters:
        svc - Includes details about to the service being monitored.
        parameters - Includes the service parameters defined in poller-configuration.xml and those returned by ServiceMonitor.getRuntimeAttributes(MonitoredService, Map).
        Returns:
        The availability of the interface and if a transition event should be suppressed.
        Throws:
        java.lang.RuntimeException - Thrown for any uncrecoverable errors.
        See Also:
        PollStatus.SERVICE_AVAILABLE, PollStatus.SERVICE_UNAVAILABLE, PollStatus.SERVICE_AVAILABLE, PollStatus.SERVICE_UNAVAILABLE