Monitor Plugin Specifications Version 0.01

Inro

A Monitor Plugin is any executable program that returns a report on the status of a specific thing. The Monitor Plugin should return a report via standard output in the format below.

Note that a single monitor must not produce multiple BEGIN - DONE blocks.

Report Format

The report consists of these sections:

BEGIN #

Marks the start of the report. # is the format 
version of the report.

URGENCY #

Reports on the "urgency" or the situation. # is
a number from 1 to 8

LOG_EMERG - 8
       system is unusable

LOG_ALERT - 7
       action must be taken immediately

LOG_CRIT - 6
      critical conditions

LOG_ERR - 5
     error conditions

LOG_WARNING - 4
         warning conditions

LOG_NOTICE - 3
        normal, but significant, condition

LOG_INFO - 2
      informational message

LOG_DEBUG - 1
       debug-level message


REPORT

Marks the start of the diagnostic text. 

Between REPORT and DONE should be filled
with diagnostic text. The text can be
any ASCII text. All formatting will be
preserved.

DONE

Marks the end of the report.

Example Reports:

BEGIN 0.01
URGENCY 8
REPORT
/dev/hda1 just failed. 
DONE

BEGIN 0.01
URGENCY 2
REPORT
CPU temperature 30 degrees.
DONE 
Index
© 1999, 2000 Peter Todd
Last update - $Id: monitor.html,v 5.2 2000/05/02 00:38:44 pete Exp $