Package zephir :: Package monitor :: Package agentmanager :: Module agent :: Class Agent
[frames | no frames]

Class Agent

AgentData --+
            |
           Agent

Known Subclasses:
LoadErrorAgent, MultiRRDAgent, RRDAgent, TableAgent

Classe abstraite des agents.

Un agent concret est une sous-classe d'Agent implémentant (en particulier) la méthode measure().
Method Summary
  __init__(self, name, period, fields, description, modules, requires, **params)
  archive(self)
Crée l'archive de l'agent sur disque
  check_status(self)
Renvoie le diagnostic de fonctionnement de l'agent.
  ensure_data_uptodate(self)
Met à jour les données de l'agent sur disque
  ensure_datadirs(self)
Méthode de convenance, cf zephir.monitor.agentmanager.util.ensure_dir
  handle_measure_exception(self, exc)
Callback d'erreur pour scheduled_measure()
  init_data(self, archive_dir)
Mémorise et initialise le répertoire d'archivage
  measure(self)
Prend concrètement une mesure.
  reset_max_status(self)
Réinitialise max_status à la valeur courante du status
  save_measure(self, measure)
Mémorise une mesure donnée.
  scheduled_measure(self)
Déclenche une mesure programmée.
  set_status(self, s, reset)
Mémorise le statut et met à jour statut_max
  update_status(self)
  write_data(self)
Écrit les données générées par l'agent sur disque
    Inherited from AgentData
  from_agent(self, agent)
Factory Method (Class method)
  from_archive(self, archive_dir)
Factory Method (Class method)

Instance Method Details

archive(self)

Crée l'archive de l'agent sur disque
Overrides:
zephir.monitor.agentmanager.agent.AgentData.archive

check_status(self)

Renvoie le diagnostic de fonctionnement de l'agent.

L'implémentation par défaut dans Agent renvoie un statut neutre. Les agents concrets doivent donc redéfinir cette méthode pour annoncer un diagnostic utile.

ensure_data_uptodate(self)

Met à jour les données de l'agent sur disque
Overrides:
zephir.monitor.agentmanager.agent.AgentData.ensure_data_uptodate (inherited documentation)

ensure_datadirs(self)

Méthode de convenance, cf zephir.monitor.agentmanager.util.ensure_dir

handle_measure_exception(self, exc)

Callback d'erreur pour scheduled_measure()

init_data(self, archive_dir)

Mémorise et initialise le répertoire d'archivage

Cette méthode sera appelée par le framework après chargement de l'agent, afin de terminer les initialisations pour lesquelles l'agent a besoin de connaître l'emplacement de ses données sur disque.

measure(self)

Prend concrètement une mesure.

Pour implémenter un agent, il faut implémenter au moins cette méthode.
Returns:
Résultat de la mesure, un dictionnaire {champ: valeur} ou un objet twisted.internet.defer.Deferred renvoyant ce dictionnaire.

reset_max_status(self)

Réinitialise max_status à la valeur courante du status

save_measure(self, measure)

Mémorise une mesure donnée.

Méthode à redéfinir dans les sous-classes concrètes de Agent. (callback de succès pour scheduled_measure())

scheduled_measure(self)

Déclenche une mesure programmée.

Prend une mesure et mémorise le résultat et l'heure.

set_status(self, s, reset=False)

Mémorise le statut et met à jour statut_max
Parameters:
s - statut actuel
reset - réinitialise max_status à s si reset==True

write_data(self)

Écrit les données générées par l'agent sur disque

Méthode à redéfinir si nécessaire dans les sous-classes.

Generated by Epydoc 2.1 on Mon Nov 27 08:44:02 2006 http://epydoc.sf.net