survivor: Report Check Module

SURVIVOR: `report` Check Module
About `report` Dependencies Arguments Description Examples
About `report`
basics |
Module Type | Scheduler | Remote
check | Yes | No
syntax |
         module report {
           module <string>
           [instance <string>]
           service <string>
           source <string>
           [recordspan <relation>]
           [warn <relation>]
           [problem <relation>]
           [extraction <extraction>]
           [tmpdir <directory>]
         }
### Dependencies None ### Arguments
Name | Type | Value
module | required string | Report module to execute.
instance | optional string, default is 'default' | Instance to invoke module for.
service | required string | Service (check) to examine history of.
source | required string any of 'alert', 'check', 'command', 'fix' | Type of history records to examine.
recordspan | optional time relation | Examine history records matching the specified time relation only.
warn | optional relation | Generate a warning if relation matches module result.
problem | optional relation | Generate a problem if relation matches module result.
extraction | optional extraction | An extraction applied to the value obtained in the reply.
tmpdir | optional directory | Directory passed to module for writing temporary files.
1. If neither warn nor problem is specified, the module will return `MODEXEC_NOTICE` with the full report text. ### Description The `report` check module executes report modules in order to provide automated trend analysis. Modules generate reports based on the specified instance, service, source, and recordspan. The output, the format of which is described in each module's documentation, can be processed with extraction and then compared against warn and/or prob to generate alerts. ### Examples To run the availability module for the network instancew looking at ping check data records within the last week (604800 seconds) where the first column of output has % available and warning if less than 100% available:
            module report {
              module     availability
              instance   network
              service    ping
              source     check
              recordspan tnt[604800]
              extraction column[0]
              warn       lt[100]
            }
$Date: 2006/11/19 21:29:01 $ $Revision: 0.3 $ | keywords extraction instance module problem recordspan service source tmpdir warn