  Copyright(C) 1996, 1997 Network Flight Recorder, Inc.
  All rights reserved.

  Use and distribution of this software and its source code
  are governed by the terms and conditions of the
  Network Flight Recorder Software License ("LICENSE.TXT")


  File:   README
  Author: Andrew Lambeth <andrew@nfr.net>



NFR Alert Facilities



Abstract

Alert facilities are processing endpoints for alerts . There are two types of
alert facilities: builtin and external. 

Builtin alert facilities

Builtin alert facilities are internal functions of the alert daemon and cannot
be uninstalled. The following builtin alert facilities are currently available: 

      NFR_FAC_LOG 
      NFR_FAC_CONSOLE 
      NFR_FAC_NULL 

External alert facilities

External alert facilities are all managed by the builtin queueing function of
alertd. When alertd receives an alert message which is destined for an
external facility, it puts it in that facility's queue. If the queue has reached
it's maximum size or time limit, it is flushed. A queue is flushed by sending
its contents to the program specified as "Exec_Path" in the facility's
queue.cf file. The program is passed the arguments given by "Exec_Args",
and the data is passed to it using the method specified in "Flush_Method".
The only method currently supported for doing this is POPEN, which,
surprisingly enough, uses popen() to dump the queue's contents to the
program's stdin. 

To manually create a new alert facility: 

      make a copy of the "~nfr/alertd/facilities/template" directory with
      the name of the new facility. 
      edit the queue.cf file in the new directory. 

Alertd automatically recognizes any facilities which are used by one or
more alerts in the resource file, so once a facility is installed in
"~nfr/etc/alertd/facilities/" it is ready to be used. 

To add a new facility to the CVS nfr source tree: 

      make a copy of the "nfr/alertd/facilities/template" directory in the
      source tree with the name of the new facility. 
      edit the queue.cf file in the new directory. 
      cd to the new directory 
      do a "cvs import" 
