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

Class Agent

source code

AgentData --+
            |
           Agent
Known Subclasses:
agents.services.TCPServices, agents.services.VPNService, agents.nut.Nut, agents.crl.Crl, agents.patches.Patches, agents.network.Network, agents.rvp.RvpAmon, RRDAgent, agents.printers.Printers, agents.ldapscribe.LdapScribe, MultiRRDAgent, agents.tcpservices.TCPServices, agents.sentinelle.Sentinelle, agents.frontend.Frontend, agents.configperso.ConfigPerso, agents.clamav.ClamLog, agents.bilan.Bilan, agents.eximstats.EximStats, agents.web.Web, agents.montages.DiskSpace, agents.ldaphorus.LdapHorus, LoadErrorAgent, TableAgent

Classe abstraite des agents.

Un agent concret est une sous-classe d'Agent implémentant (en particulier) la méthode measure().

Instance Methods [hide private]
 
__init__(self, name, period=60, fields=['value'], description=None, section=None, modules=None, requires=[], **params) source code
 
init_data(self, archive_dir)
Mémorise et initialise le répertoire d'archivage
source code
 
measure(self)
Prend concrètement une mesure.
source code
 
check_status(self)
Renvoie le diagnostic de fonctionnement de l'agent.
source code
 
update_status(self) source code
 
set_status(self, s, reset=False)
Mémorise le statut et met à jour statut_max
source code
 
reset_max_status(self)
Réinitialise max_status à la valeur courante du status
source code
 
scheduled_measure(self)
Déclenche une mesure programmée.
source code
 
save_measure(self, measure)
Mémorise une mesure donnée.
source code
 
handle_measure_exception(self, exc)
Callback d'erreur pour scheduled_measure()
source code
 
archive(self)
Crée l'archive de l'agent sur disque
source code
 
ensure_data_uptodate(self)
Met à jour les données de l'agent sur disque
source code
 
write_data(self)
Écrit les données générées par l'agent sur disque
source code
 
ensure_datadirs(self)
Méthode de convenance, cf zephir.monitor.agentmanager.util.ensure_dir
source code
Class Methods [hide private]

Inherited from AgentData: from_agent, from_archive

Method Details [hide private]

__init__(self, name, period=60, fields=['value'], description=None, section=None, modules=None, requires=[], **params)
(Constructor)

source code 
Overrides: AgentData.__init__

init_data(self, archive_dir)

source code 

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)

source code 

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.

check_status(self)

source code 

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.

set_status(self, s, reset=False)

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

scheduled_measure(self)

source code 

Déclenche une mesure programmée.

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

save_measure(self, measure)

source code 

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())

archive(self)

source code 
Crée l'archive de l'agent sur disque
Overrides: AgentData.archive

ensure_data_uptodate(self)

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

write_data(self)

source code 

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

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