.. -*- mode: rst; coding: iso-8859-1 -*-

################################################################
README
################################################################

================================================================
Agents de supervision Zphir
================================================================

:Author: Damien Pollet
:Date: $Date: 2005/03/23 16:47:55 $
:Version: $Revision: 1.9 $

.. contents::



Description
================================================================

Service de surveillance de l'tat d'une machine, et de rapport  un
serveur Zphir.

Sur le poste client, des agents collectent des donnes  intervalles
de temps rguliers. On peut consulter ces donnes en temps rel pour
un poste client particulier par un site web local 
http://localhost:8080. Rgulirement, l'application principale du
Zphir archive ces donnes et les envoie via UUCP au serveur Zphir.

Sur le serveur, une version du service Zphir-Agents sans collection
de donnes permet de consulter en diffr les donnes provenant de
tous les postes clients.



Contenu
-------

::

  zephir-agents/
      agentmanager/	module python du service de mesure
          templates/	templates Cheetah pour les pages web
      agents/		code des agents prdfinis
      api/		documentation du code (docutils)
      configs/		instanciation d'agents (pour exemple & test)
      doc/		documentation (format reStructuredText des docutils)
      i18n/		fichiers d'internationalisation (locales)
      static/		donnes web statiques (images, feuilles de styles...)
      tests/		tests unitaires



Installation
================================================================

Dpendances :

- Python 2.3
- TwistedMatrix 1.3
- Cheetah 0.9.15
- py-rrdtool 0.2.1

Compiler les templates, les localisations, et la documentation : ::

  make

Les rpertoires ``agentmanager/`` et ``agents/`` sont des paquets
python et doivent tre disponibles  l'interprteur
(cf. ``$PYTHONPATH``).



Excution
================================================================

Le programme est une application TwistedMatrix, utilisable sous forme
de plugin ``.tap`` ou ``.tac``.



Plugin ``.tap``
----------------------------------------------------------------

Pour lancer la version ``.tap``, on cre d'abord un fichier ``.tap``
 l'aide de l'utilitaire ``mktap``, puis on lance ``twistd`` : ::

  mktap zephiragents <options>
  twistd -nof zephiragents.tap

Options reconnues (attention aux / en fin) :

--config=repertoire
  Les agents seront chargs  partir des fichiers d'instanciation
  prsents dans ce rpertoire.

--data=repertoire
  Les donnes mesures par les agents seront stockes dans ce
  rpertoire, qui constituera la racine de l'archive envoye au
  serveur Zphir.

--archive=repertoire
  L'archive de mesures sera cre dans ce rpertoire.

--static=repertoire
  Fichiers statiques pour le serveur web.

--static-base=URL
  Prfixe d'URL pour les donnes statiques (pour hbergement par un
  autre serveur web par exemple).

--tmp=repertoire
  Rpertoire pour donnes temporaires.


sur les modules eole:

	- placer z_stats dans /etc/init.d
	- copier l'arborescence dans /usr/share/eole/monitor/
	- ajouter 1 en argument lors de l'appel  maj_site (zephir_client.py)

sur zephir:

	- changer 'static-base' pour '/sites'
	- recopier la css et le rpertoire img de static dans /var/lib/zephir/sites/
	- le rpertoire temporaire de donnes doit s'appeler des donnes doit tre stats


Plugin ``.tac``
----------------------------------------------------------------

Il est aussi possible d'utiliser le programme en crant un fichier
``.tac`` qui sera lanc directement avec ``twistd`` : ::

  twistd -ny zephir.tac

Dans ce cas les options sont crites directement dans le fichier
``.tac`` ; deux fichiers sont fournis  titre d'exemple :
``agentmanager/zephir.tac`` et ``agentmanager/zephir-nolive.tac``. Les
valeurs par dfaut des options sont dfinies dans
``agentmanager/config.py``.


