#####################################################
    
            MONITORING SYSTEM - README

#####################################################


0. CONTENT
------------

1. Components
2. Requirements
3. Installation

1. COMPONENTS
----------------


This package consists of 5 main packages:

1. gz_parser
2. log file parser server
3. log file parser client
4. visualiser
5. remote controller


The "gz_parser" only deals with srbLog*.gz files. Within the config file paths can be spezified. Make sure you enter a path for the xml file, which is the same you have entered by the "log file parser server". The script will do it's work and then finish, leave the output for the "log file parser client" to fetch.

The log file parser "Server" only deals with the current srbLog file and with the latest srbLog*.gz file. This script can be run as a daemon and can be stopped with the script "stop_server".

The log file parser "Client" is handeling the database issues concerning inserting the error messages. For each parsing event, a mail can be send to people spezified in the config file (config_client.ini). This script also can be run as a daemon and can be stopped with the script "stop_client".

The "Visualiser" can be used to query the database. The results can be displayed in a graph. The graph can be saved as a postscript file for further usage.

With the "Remote Controller" the parsing behaviour of the server can be influenced.


2. REQUIREMENTS
------------------

In this section only external packages are listed.

2.1 gz_parser

- Python 2.2.3 or higher


2.2 server

- Python 2.2.3 or higher
- M2Crypto 0.13 (http://sandbox.rulemaker.net/ngps/m2)
- egrep, awk


2.3 client

- Python 2.2.3 or higher
- M2Crypto 0.13 (http://sandbox.rulemaker.net/ngps/m2)
- sqlite 2.8.16 (http://www.sqlite.org/)
- pysqlite 1.0.1 (http://initd.org/tracker/pysqlite)
- egrep, awk


2.4 Visualiser 

- Python 2.2.3 or higher
- sqlite 2.8.16 (http://www.sqlite.org/)
- pysqlite 1.0.1 (http://initd.org/tracker/pysqlite)


2.5 Remote Controller 

- Python 2.2.3 or higher
- M2Crypto 0.13 (http://sandbox.rulemaker.net/ngps/m2)



3. INSTALLATIONS
----------------

3.1 M2Crypto 0.13 

M2Crypto is a Python interface to OpenSSL. 

$ unzip m2crypto-0.13.zip 
$ cd m2crypto-0.13 
$ python setup.py build 
# python setup.py install

or if you want to install it locally

$ python setup.py install --home=/home/yourhome/yourpath_to_the_desired_folder
$ cd tests # optional
$ python alltests.py # optional 


3.2 sqlite 2.8.16

SQLite is a small C library that implements a self-contained, embeddable, zero-configuration SQL database engine. 

$ tar -xzf sqlite-2.8.16.tar.gz 
$ cd sqlite-2.8.16 
$ ./configure

or if you want to install it locally

$ ./configure --prefix=/home/yourhome/yourpath_to_the_desired_folder
$ make 
# make install

or if you want to install it locally

$ make install 


3.3 pysqlite 1.0.1

Pysqlite is a Python DB-API 2.0 interface for the SQLite embedded relational database engine. 

$ tar -xzf pysqlite-1.0.1.tar.gz 
$ cd pysqlite 
$ python setup.py build 
# python setup.py install

or if you want to install it locally

$ python setup.py install --home=/home/yourhome/yourpath_to_the_desired_folder

You might have to export the python path, if you use the local installation

$ export PYTHONPATH=/home/yourhome/yourpath_to_the_desired_folder/lib/Python 


3.4 Server

Make sure you edit the configuration and keyword file properly beforehand.

$ python start_server.py -c config config_server.ini [optional parameters]

Enter python start_server.py -h for more information. A bash script for stopping the server is provided too -> ./stop_server.


3.5 Client

Make sure you edit the configuration file properly beforehand.

$ python start_client.py -c config config_client.ini [optional parameters] 

Enter python start_client.py -h for more information. A bash script for stopping the client is provided too -> ./stop_client. 


3.6 Virtualiser

Make sure you edit the configuratin file beforehand.

$ python gui.py -c config_gui.ini [optional parameters]

Enter python gui.py -h for more information and usage examples.


3.7 Remote Controller

Make sure you edit the configuratin file beforehand.

$ python admin_server.py -c config_admin.ini [optional parameters]

Enter python admin_server.py -h for more information and usage examples.


3.8 GZ Parser

Make sure you edit the configuration file beforehand.

$ python gz_parser.py -c config_gz_parser.ini [optional parameters]

Enter python gz_parser.py -h for more information.





4. Questions ?

a.weise@reading.ac.uk

otherwise


Have Fun !