Project

General

Profile

Revision 4febadf0

ID4febadf03abb3e9b12b9add7689620e3da1bbede
Parent 07b62a01
Child 54644278

Added by Francois POIROTTE over 14 years ago

Amélioration des styles pour VigiBoard et ajout de documentation dans les différents plugins.

git-svn-id: https://vigilo-dev.si.c-s.fr/svn@2142 b22e2e97-25c9-44ff-b637-2e5ceca36478

View differences:

vigiboard/controllers/root.py
533 533
        last_modification_timestamp.timetuple()))
534 534

  
535 535
def get_plugins_instances():
536
    """
537
    Renvoie une liste d'instances de plugins pour VigiBoard.
538

  
539
    @return: Liste de tuples contenant le nom du plugin et l'instance associé.
540
    @rtype: C{list} of C{tuple}
541
    """
536 542
    plugins = config.get('vigiboard_plugins', [])
537 543
    plugins_instances = []
538 544
    for (plugin_name, plugin_class) in plugins:
vigiboard/controllers/vigiboard_plugin/date.py
1 1
# -*- coding: utf-8 -*-
2
# vim:set expandtab tabstop=4 shiftwidth=4: 
2
# vim:set expandtab tabstop=4 shiftwidth=4:
3 3
"""
4

  
4
Un plugin pour VigiBoard qui ajoute une colonne avec la date à laquelle
5
est survenu un événement et la durée depuis laquelle l'événement est actif.
5 6
"""
6 7

  
7 8
from pylons.i18n import ugettext as _
......
13 14
                            CorrEvent, Event, SupItem
14 15

  
15 16
class PluginDate(VigiboardRequestPlugin):
17
    """Plugin pour l'ajout d'une colonne Date."""
16 18
    pass
17 19

  
vigiboard/controllers/vigiboard_plugin/history.py
1 1
# -*- coding: utf-8 -*-
2
# vim:set expandtab tabstop=4 shiftwidth=4: 
2
# vim:set expandtab tabstop=4 shiftwidth=4:
3 3
"""
4

  
4
Un plugin pour VigiBoard qui ajoute une colonne avec les liens vers les
5
entrées d'historiques liées à l'événement, ainsi que les liens vers les
6
applications externes.
5 7
"""
6 8

  
7 9
import urllib
......
16 18
from vigilo.models import User, CorrEvent, Event, StateName
17 19

  
18 20
class PluginHistory(VigiboardRequestPlugin):
21
    """
22
    Plugin qui ajoute des liens vers les historiques et les applications
23
    externes.
24
    """
25

  
19 26
    def get_value(self, idcorrevent, *args, **kwargs):
20 27
        """
21 28
        Renvoie les éléments pour l'affichage de la fenêtre de dialogue
vigiboard/controllers/vigiboard_plugin/hls.py
1 1
# -*- coding: utf-8 -*-
2
# vim:set expandtab tabstop=4 shiftwidth=4: 
2
# vim:set expandtab tabstop=4 shiftwidth=4:
3 3
"""
4
Plugin SHN : High level service
4
Un plugin pour VigiBoard qui ajoute une colonne avec les services de haut
5
niveau (L{HighLevelService}) impactés par un événement.
5 6
"""
6 7

  
7 8
from pylons.i18n import ugettext as _
......
13 14
                            CorrEvent, Event, SupItem
14 15

  
15 16
class PluginHLS(VigiboardRequestPlugin):
16

  
17 17
    """
18
    Plugin permettant de rajouter le nombre de Service de Haut Niveau
19
    impactés à l'affichage et d'obtenir une liste détaillée de ces
20
    Services de Haut Niveau.
18
    Plugin qui permet de voir les services de haut niveau impactés par
19
    un événement.
21 20
    """
22 21
    def get_value(self, idcorrevent):
23
        """Ajout de fonctionnalités au contrôleur"""
22
        """
23
        Renvoie le nom des services de haut niveau impactés par l'événement.
24

  
25
        @param idcorrevent: Identifiant de l'événement corrélé.
26
        @type idcorrevent: C{int}
27
        @return: Un dictionnaire dont la clé "services" contient une liste
28
            des noms des services de haut niveau impactés par l'événement
29
            corrélé dont l'identifiant est L{idcorrevent}.
30
        """
24 31
        supitem = self.get_correvent_supitem(idcorrevent)
25 32

  
26 33
        if not supitem:
vigiboard/controllers/vigiboard_plugin/hostname.py
1 1
# -*- coding: utf-8 -*-
2
# vim:set expandtab tabstop=4 shiftwidth=4: 
2
# vim:set expandtab tabstop=4 shiftwidth=4:
3 3
"""
4

  
4
Un plugin pour VigiBoard qui ajoute une colonne avec le nom de l'hôte
5
sur lequel porte l'événement corrélé.
5 6
"""
6 7

  
7 8
from pylons.i18n import ugettext as _
......
13 14
                            CorrEvent, Event, SupItem
14 15

  
15 16
class PluginHostname(VigiboardRequestPlugin):
16
    pass
17
    """
18
    Ajoute une colonne avec le nom de l'hôte impacté par un événement corrélé.
19
    """
17 20

  
vigiboard/controllers/vigiboard_plugin/id.py
1 1
# -*- coding: utf-8 -*-
2
# vim:set expandtab tabstop=4 shiftwidth=4: 
2
# vim:set expandtab tabstop=4 shiftwidth=4:
3 3
"""
4

  
4
Un plugin pour VigiBoard qui ajoute une colonne avec l'identifiant
5
de l'événement corrélé.
6
Ce plugin n'a d'intérêt que pour débuguer l'application.
5 7
"""
6 8

  
7 9
from pylons.i18n import ugettext as _
......
13 15
                            CorrEvent, Event, SupItem
14 16

  
15 17
class PluginId(VigiboardRequestPlugin):
18
    """Plugin de debug qui affiche l'identifiant de l'événement corrélé."""
16 19
    pass
17 20

  
vigiboard/controllers/vigiboard_plugin/occurrences.py
1 1
# -*- coding: utf-8 -*-
2
# vim:set expandtab tabstop=4 shiftwidth=4: 
2
# vim:set expandtab tabstop=4 shiftwidth=4:
3 3
"""
4

  
4
Un plugin pour VigiBoard qui ajoute une colonne avec le nombre
5
d'occurrences d'un événement corrélé donné.
5 6
"""
6 7

  
8

  
7 9
from pylons.i18n import ugettext as _
8 10
from tg import url
9 11

  
......
13 15
                            CorrEvent, Event, SupItem
14 16

  
15 17
class PluginOccurrences(VigiboardRequestPlugin):
18
    """
19
    Ce plugin affiche le nombre d'occurrences d'un événement corrélé.
20
    Ce compteur d'occurrences est mis à jour automatiquement par le
21
    corrélateur chaque fois qu'un événement brut survient sur la cause
22
    de l'événement corrélé.
23
    """
16 24
    pass
17 25

  
vigiboard/controllers/vigiboard_plugin/output.py
1 1
# -*- coding: utf-8 -*-
2 2
# vim:set expandtab tabstop=4 shiftwidth=4: 
3 3
"""
4

  
4
Un plugin pour VigiBoard qui ajoute une colonne avec la sortie
5
de la commande de test exécutée par Nagios sur cet hôte/service.
5 6
"""
6 7

  
7 8
from pylons.i18n import ugettext as _
......
13 14
                            CorrEvent, Event, SupItem
14 15

  
15 16
class PluginOutput(VigiboardRequestPlugin):
16
    pass
17
    """Ajoute une colonne avec le message de Nagios."""
17 18

  
vigiboard/controllers/vigiboard_plugin/priority.py
1 1
# -*- coding: utf-8 -*-
2 2
# vim:set expandtab tabstop=4 shiftwidth=4: 
3 3
"""
4

  
4
Un plugin pour VigiBoard qui ajoute une colonne avec la priorité
5
ITIL de l'événement corrélé.
5 6
"""
6 7

  
7 8
from pylons.i18n import ugettext as _
......
13 14
                            CorrEvent, Event, SupItem
14 15

  
15 16
class PluginPriority(VigiboardRequestPlugin):
16
    pass
17
    """
18
    Ce plugin affiche la priorité ITIL des événements corrélés.
19
    La priorité est un nombre entier et permet de classer les événements
20
    corrélés dans l'ordre qui semble le plus approprié pour que les
21
    problèmes les plus urgents soient traités en premier.
22

  
23
    La priorité des événements peut être croissante (plus le nombre est
24
    élevé, plus il est urgent de traiter le problème) ou décroissante
25
    (ordre opposé). L'ordre utilisé par VigiBoard pour le tri est
26
    défini dans la variable de configuration C{vigiboard_priority_order}.
27
    """
17 28

  
vigiboard/controllers/vigiboard_plugin/servicename.py
1 1
# -*- coding: utf-8 -*-
2
# vim:set expandtab tabstop=4 shiftwidth=4: 
2
# vim:set expandtab tabstop=4 shiftwidth=4:
3 3
"""
4

  
4
Un plugin pour VigiBoard qui ajoute une colonne avec le nom du service
5
à l'origine de l'événement corrélé.
5 6
"""
6 7

  
7 8
from pylons.i18n import ugettext as _
......
13 14
                            CorrEvent, Event, SupItem
14 15

  
15 16
class PluginServicename(VigiboardRequestPlugin):
16
    pass
17
    """
18
    Affiche le nom du service à l'origine de l'événement corrélé.
19
    Si l'événement corrélé porte directement sur un hôte,
20
    alors le nom de service vaut None.
21
    """
17 22

  
vigiboard/controllers/vigiboard_plugin/status.py
1 1
# -*- coding: utf-8 -*-
2
# vim:set expandtab tabstop=4 shiftwidth=4: 
2
# vim:set expandtab tabstop=4 shiftwidth=4:
3 3
"""
4

  
4
Un plugin pour VigiBoard qui ajoute 3 colonnes au tableau des événements :
5
-   la première colonne contient l'état d'acquittement de l'événement.
6
-   la seconde colonne contient un lien permettant d'éditer certaines
7
    propriétés associées à l'événement corrélé.
8
-   la dernière colonne permet de (dé)sélectionner l'événement pour
9
    effectuer un traitement par lot.
5 10
"""
6 11

  
7 12
from pylons.i18n import ugettext as _
......
13 18
                            CorrEvent, Event, SupItem
14 19

  
15 20
class PluginStatus(VigiboardRequestPlugin):
21
    """
22
    Ajoute des colonnes permettant de voir le statut d'acquittement
23
    d'un événement corrélé et de modifier certaines de ses propriétés.
24
    """
25

  
16 26
    def get_generated_columns_count(self):
27
        """
28
        Renvoie le nombre de colonnes que ce plugin ajoute.
29
        Ce plugin en ajoute 3, au lieu de 1 comme la plupart des plugins.
30
        """
17 31
        return 3
18 32

  
vigiboard/controllers/vigiboard_plugin/tt.py
1 1
# -*- coding: utf-8 -*-
2
# vim:set expandtab tabstop=4 shiftwidth=4: 
2
# vim:set expandtab tabstop=4 shiftwidth=4:
3 3
"""
4

  
4
Un plugin pour VigiBoard qui ajoute une colonne avec un lien vers le ticket
5
d'incidence se rapportant à un événement corrélé donné.
5 6
"""
6 7

  
7 8
from pylons.i18n import ugettext as _
......
13 14
                            CorrEvent, Event, SupItem
14 15

  
15 16
class PluginTroubleTicket(VigiboardRequestPlugin):
16
    pass
17
    """Ajoute un lien vers le ticket d'incidence associé à l'événement."""
17 18

  

Also available in: Unified diff