Package Products :: Package ZenStatus :: Module PingTask :: Class PingCollectionTask |
[hide private]
[frames] | no frames]

# Class PingCollectionTask

source code

    ZenCollector.tasks.BaseTask --+
                                  |
                                 PingCollectionTask

Instance Methods | [hide private]
__init__(self, taskName, deviceId, scheduleIntervalSeconds, taskConfig) | source code
_addToTopology(self) Update the topology with our local knowledge of how we're connected. | source code
_failure(self, reason) Twisted errBack to log the exception for a single IP. | source code
Twisted deferred object |
doTask(self) Contact to one device and return a deferred which gathers data from the device. | source code
_storeResults(self, result) Store the datapoint results asked for by the RRD template. | source code
_updateStatus(self, result) Update the modeler and handle issues | source code
sendPingClearEvent(self, pj, msgTpl='%s is UP!') Send an event based on a ping job to the event backend. | source code
displayStatistics(self) Called by the collector framework scheduler, and allows us to see how each task is doing. | source code
cleanup(self) | source code

Class Variables | [hide private]
| STATE_PING_START = `'PING_START'`
| STATE_PING_STOP = `'PING_STOP'`
| STATE_STORE_PERF = `'STORE_PERF_DATA'`
| STATE_UPDATE_TOPOLOGY = `'UPDATE_TOPOLOGY'`

Method Details | [hide private]

### __init__(self, taskName, deviceId, scheduleIntervalSeconds, taskConfig) (Constructor) | source code
Parameters: `deviceId` (string) - the Zenoss deviceId to watch `taskName` (string) - the unique identifier for this task `scheduleIntervalSeconds` (int) - the interval at which this task will be collected `taskConfig` - the configuration for this task

### _failure(self, reason) | source code
Twisted errBack to log the exception for a single IP. Parameters: `reason` (Twisted error instance) - explanation of the failure

### doTask(self) | source code
Contact to one device and return a deferred which gathers data from the device. Returns: Twisted deferred object A task to ping the device and any of its interfaces.

### _updateStatus(self, result) | source code
Update the modeler and handle issues Parameters: `result` (array of (boolean, dictionaries)) - results of Ping or a failure