logcheckd.interface

NAME

SYNOPSIS

AVAILABILITY

DESCRIPTION

The INTERFACE receives the matching log entry thru stdin, the following environment variables are exported to the INTERFACE: $APPROOT, $SERVER_ENVIRONMENT_NAME, $SERVER_ENVIRONMENT_CUSTOMER, $SERVER_ENVIRONMENT_DESCRIPTION, $INTERFACE_CFG, $TIMESTAMP, $LOGFILE, and $LEVEL.

OPTIONS

ENVIRONMENT

$INTERFACE_CFG

configuration file of the INTERFACE.

$TIMESTAMP

timestamp of the matching logfile entry.

$LOGFILE

name of the logfile containing the matching logfile entry.

$LEVEL

matched level as defined in the logcheckd.pattern(4) file.

$APPROOT

root directory of the WA2L/edrc installation as returned by the approot(3) command.

$SERVER_ENVIRONMENT_NAME

server environment name as returned by the server_environment(3) command.

$SERVER_ENVIRONMENT_CUSTOMER

server environment customer as returned by the server_environment(3) command.

$SERVER_ENVIRONMENT_DESCRIPTION

server environment description as returned by the server_environment(3) command.

EXIT STATUS

0

always.

The exit status of an interface is not resolved ba the logcheckd and lgcheckd.

FILES

edrc/var/logcheckd/iconfig/<interfacefile>.cfg

configuration file for the interface allowing to write a configurable interface.

EXAMPLES

1. Simple example interface:

This example INTERFACE saves all matching log entries to an output file that is configured in the edrc/var/logcheckd/iconfig/Example.cfg .

Interface configuration (edrc/var/logcheckd/iconfig/Example.cfg):

  #
  # logcheckd/iconfig/Example.cfg - configuration for logcheckd interface: Example 
  #
  # [00] 23.05.2009 CWa Initial Version
  #

  # Output file for interface
  #
  INTERFACE_OUTPUTFILE=/tmp/$EDRC_SCRIPTNAME.out

Interface implementation (edrc/lib/logcheckd/interface/Example):

  #!/bin/sh
  #
  # Example - logcheckd interface: simple Example
  #
  # [00] 23.05.2009 CWa   Initial Version
  # [01] 28.05.2009 CWa   ++  
  #
  
  # Const
  . $INTERFACE_CFG
  Outputfile=$INTERFACE_OUTPUTFILE
  
  
  
  # run -- run the interface command
  #
  run(){
      cat <<EOM >> $Outputfile
  --
  TIMESTAMP=$TIMESTAMP
  LEVEL=$LEVEL
  LOGFILE=$LOGFILE
  EOM
  
      cat - >> $Outputfile
  } # run
  
  
  
  # Main -- Main
  #
  main(){
      case $LEVEL in
          HIGH)
                  run
                  ;;
          *)
                  run
                  ;;
      esac
  } # main
  main

2. Other example interfaces:

See directory: edrc/lib/logcheckd/interface/.

SEE ALSO

NOTES

BUGS

AUTHOR

COPYRIGHT

This is free software; see edrc/doc/COPYING for copying conditions. There is ABSOLUTELY NO WARRANTY; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.