ECCL documentation

Authors

Richard Frith-Macdonald (rfm@gnu.org)

Copyright: (C) 2013 Free Software Foundation, Inc.


Contents -

  1. Enterprise Control Configuration and Logging
  2. The AlarmTool command line tool
  3. The LogTool command line tool
  4. The Terminate command line tool

The index below lists the major components of the ECCL documentation.

Title Index

Enterprise Control Configuration and Logging

Classes and tools for building and administering 24*7 server processes for large scale software systems.

The AlarmTool command line tool

The AlarmTool command line tool provides a mechanism to raise and clear alarms (using the ECCL alarm system) from a process which is not itsself ECCL enabled (ie not built using the ECCL classes).
You may use this to generate logging from shell scripts or from Java servlets etc.

The tool requires at least four (usually six) arguments:
'-Cause NN' the probable cause of the alarm (type of problem).
'-Component NN' the component which raised the alarm.
'-Problem NN' the specific problem which raised the alarm.
'-Process NN' the name of the process which raised the alarm.
'-Repair NN' a proposed repair action to fix the issue.
'-Severity NN' the severity of the problem (defaults to 'cleared', in which case the Repair action is not required).

The LogTool command line tool

The LogTool command line tool provides a mechanism to log various types of messages (using the ECCL logging system) from a process which is not itsself ECCL enabled (ie not built using the ECCL classes). You may use this to generate logging from shell scripts or from Java servlets etc.

The tool requires at least two arguments:
'-Name XXX' specifies the name under which the message is to be logged and
'-Mesg XXX' specifies the content of the message to be logged.
The optional '-Mode XXX' argument specifies the type of log to be generated (one of Audit, Debug, Warn, Error or Alert) and defaults to generating a 'Warn' log.

The Terminate command line tool

The Terminate command line tool provides a mechanism to shut down an ECCL host. This tool contacts a Command server and tells it to shut down all it's local client process and the shut itsself down.

You may use '-CommandHost' and '-CommandName' to specify a Command server to contact, otherwise the default local Command server is contacted (or if there is no local server, any available Command server on the local network is contacted).

If you wish to terminate everything in a cluster, you may use the '-CommandName' argument to specify the name of the 'Control' server of the cluster rather than the 'Command' server of an individual host. In this case the tool will contact the Control server, and the Control server will in turn send a terminate message to each Command server in the cluster, before closing down itsself.