
                              The mon CGI manual
                                       
Gilles Lamiral

   v0.2, 12 November 1998
     _________________________________________________________________
   
   This document describes the mon html user interface minotaur.cgi. 
     _________________________________________________________________
   
1. Principles

   The mon sofware is a general scheduler executing periodic tests on a
   set of services and triggers alarms when a problem occurs.
   
   The scheduler can be consulted upon a simple textual protocol on a
   predefined port.
   
   The interface is based on this protocol. The CGI script (Common
   Gateway Interface) consults the scheduler and presents the results on
   a HTML way.
   
   To understand the web interface, you need to think about the followind
   hierarchy:
   
     * The scheduler supervizes groups.
     * Groups are made up with items.
     * Those items can be hosts presented by their name or their IP
       adress, or everything else, directories for example.
     * Upon each items group, the scheduler supervizes one or more
       services.
     * With each service, the scheduler can trigger one or more alarms.
       
2. General presentation

     * A configuration table called ``Preference''.
     * A status table called ``Status''.
     * An aliases table called ``Aliases''
     * An historic table called ``Historic''.
     * A link bar upon each table.
       
3. The preference table

   [INLINE]
   
   CAPTION: The configuration
   
   With the refresh popup you select the time refresh time of the whole
   page.
   
   With the language popup you select the user interface language.
   
   With the checkboxes named ``Status'', ``Historic'', ``Aliases'', you
   select the table you want to see.
   
4. The status table

   [INLINE]
   
   CAPTION: The status table
   
   The host colomn.
          This colomn contains the list of all hosts. The disabled hosts
          are selected. You can select or deselect some hosts but it
          won't do anything. The disable mechanism is not yet coded.
          
   The ``group'' colomn.
          The group colomn just names the group.
          
   The ``Members'' colomn.
          The members colomn contains the group host lists, one in each
          cell, one for each ``group'' colomn cell.
          
   The ``Service'' colomn.
          The service colomn just names the services. There can be
          several services for each group.
          
   The ``Last at'' and ``Next in'' colomn.
          The ``Last at'' colomn tells you when the last test was done.
          The ``Next in'' colomn tells you the waiting time untill the
          next test.
          
   The ``Status'' colomn.
          The status colomn gives the service status, one cell for each
          service. If the tests were good then you see the string
          "succeeded" alone. Else, you see the string "failed" followed
          by an summary information, typically the host that failed the
          tests.
          
   Color legend.
          
          + When everything is good the services are not colored.
          + When a service is ``down'' the service and its group are red.
            The up-brother services (in the same group) are green.
          + When a service is not yet tested, at the mon reset or
            starting, it is yellow.
          + When a service is disabled (none alarm is triggered), it is
            blue.
          + The sorting rule to present the groups is : red, blue,
            yellow, alphanumeric.
          + The sorting rule to present services in a group is : red,
            blue, yellow, alphanumeric.
            
5. The aliases table

   [INLINE]
   
   CAPTION: The empty aliases table
   
   By default, the aliases table lists the aliases in the first colomn
   but does not detail each alias.
   
   [INLINE]
   
   CAPTION: The non-empty aliases table
   
   To see the alias details, just select it in the List colomn and click
   on a submit button. You can do a multiple selection.
   
   [INLINE]
   
   CAPTION: The full aliases table
   
   To see all the aliases, just select the all radio button and click on
   a submit button.
   
6. The historic table

   [INLINE]
   
   CAPTION: The historic table
   
   In red, the alerts. In green, the upalerts.
   
   You choose the number of line you want to see with the Nb lines
   textfield. You filter the last evenments with the Filter popup. The
   last alerts within the interval are displayed with a broken blank
   background.
