Revision 5b44cbbd
Mise a jour documentation suite a passage Epydoc
git-svn-id: https://vigilo-dev.si.c-s.fr/svn@2458 b22e2e97-25c9-44ff-b637-2e5ceca36478
| vigigraph/controllers/error.py | ||
|---|---|---|
| 34 | 34 |
""" |
| 35 | 35 |
Gestion erreur rrd |
| 36 | 36 |
|
| 37 |
@param **kwargs : arguments nommes
|
|
| 38 |
@type **kwargs : dict
|
|
| 37 |
@param kwargs : arguments nommes |
|
| 38 |
@type kwargs : dict |
|
| 39 | 39 |
(pour la clé 'txt', contient le texte) |
| 40 | 40 |
|
| 41 |
@return : texte de l erreur
|
|
| 41 |
@return: texte de l erreur |
|
| 42 | 42 |
@rtype : C{str}
|
| 43 | 43 |
""" |
| 44 | 44 |
|
| ... | ... | |
| 52 | 52 |
""" |
| 53 | 53 |
Gestion erreur rrd |
| 54 | 54 |
|
| 55 |
@param **kwargs : arguments nommes
|
|
| 56 |
@type **kwargs : dict
|
|
| 55 |
@param kwargs : arguments nommes |
|
| 56 |
@type kwargs : dict |
|
| 57 | 57 |
(pour la clé 'host', contient l'hôte) |
| 58 | 58 |
|
| 59 |
@return : page erreur
|
|
| 60 |
@rtype : page (-> dict sur template rrd_error.html)
|
|
| 59 |
@return: page erreur |
|
| 60 |
@rtype: page (-> dict sur template rrd_error.html) |
|
| 61 | 61 |
""" |
| 62 | 62 |
|
| 63 | 63 |
host = None |
| ... | ... | |
| 72 | 72 |
""" |
| 73 | 73 |
Gestion erreur rrd sur export CSV |
| 74 | 74 |
|
| 75 |
@param **kwargs : arguments nommes
|
|
| 76 |
@type **kwargs : dict
|
|
| 75 |
@param kwargs : arguments nommes |
|
| 76 |
@type kwargs : dict |
|
| 77 | 77 |
(pour la clé 'host', contient l'hôte) |
| 78 | 78 |
|
| 79 |
@return : page erreur
|
|
| 80 |
@rtype : page (-> dict sur template rrd_error.html)
|
|
| 79 |
@return: page erreur |
|
| 80 |
@rtype: page (-> dict sur template rrd_error.html) |
|
| 81 | 81 |
""" |
| 82 | 82 |
|
| 83 | 83 |
host = None |
| ... | ... | |
| 92 | 92 |
""" |
| 93 | 93 |
Gestion erreur nagios sur l hote |
| 94 | 94 |
|
| 95 |
@param **kwargs : arguments nommes |
|
| 96 |
@type **kwargs : dict |
|
| 97 |
(pour la clé 'host', contient l'hôte) |
|
| 95 |
@param kwargs : arguments nommes |
|
| 96 |
@type kwargs : dict |
|
| 98 | 97 |
|
| 99 |
@return : page erreur |
|
| 100 |
@rtype : page (-> dict sur template nagios_host_error.html) |
|
| 98 |
@return: page erreur |
|
| 99 |
@rtype: page |
|
| 100 |
|
|
| 101 |
(arguments nommes : pour la clé 'host', contient l'hôte) |
|
| 101 | 102 |
""" |
| 102 | 103 |
|
| 103 | 104 |
host = None |
| ... | ... | |
| 112 | 113 |
""" |
| 113 | 114 |
Gestion erreur nagios sur l'hote et le service |
| 114 | 115 |
|
| 115 |
@param **kwargs : arguments nommes
|
|
| 116 |
@type **kwargs : dict
|
|
| 116 |
@param kwargs : arguments nommes |
|
| 117 |
@type kwargs : dict |
|
| 117 | 118 |
(pour la clé 'host', contient l'hôte) |
| 118 | 119 |
(pour la clé 'service', contient le service) |
| 119 | 120 |
|
| 120 |
@return : page erreur
|
|
| 121 |
@rtype : page (-> dict sur template nagios_host_service_error.html)
|
|
| 121 |
@return: page erreur |
|
| 122 |
@rtype: page (-> dict sur template nagios_host_service_error.html) |
|
| 122 | 123 |
""" |
| 123 | 124 |
|
| 124 | 125 |
host = None |
| vigigraph/controllers/rpc.py | ||
|---|---|---|
| 58 | 58 |
""" |
| 59 | 59 |
Determination des groupes principaux (sans parent) |
| 60 | 60 |
|
| 61 |
@return : groupes principaux
|
|
| 62 |
@rtype : document json (sous forme de dict)
|
|
| 61 |
@return: groupes principaux |
|
| 62 |
@rtype: document json (sous forme de dict) |
|
| 63 | 63 |
""" |
| 64 | 64 |
topgroups = DBSession.query(HostGroup.name, HostGroup.idgroup) \ |
| 65 | 65 |
.filter(HostGroup.parent == None) \ |
| ... | ... | |
| 79 | 79 |
@param maingroupid : identificateur d un groupe principal |
| 80 | 80 |
@type maingroupid : int |
| 81 | 81 |
|
| 82 |
@return : groupes
|
|
| 83 |
@rtype : document json (sous forme de dict)
|
|
| 82 |
@return: groupes |
|
| 83 |
@rtype: document json (sous forme de dict) |
|
| 84 | 84 |
""" |
| 85 | 85 |
hostgroups = DBSession.query(HostGroup.name, HostGroup.idgroup)\ |
| 86 | 86 |
.filter(HostGroup.idparent == maingroupid) \ |
| ... | ... | |
| 99 | 99 |
@param othergroupid : identificateur d un groupe |
| 100 | 100 |
@type othergroupid : int |
| 101 | 101 |
|
| 102 |
@return : hotes
|
|
| 103 |
@rtype : document json (sous forme de dict)
|
|
| 102 |
@return: hotes |
|
| 103 |
@rtype: document json (sous forme de dict) |
|
| 104 | 104 |
""" |
| 105 | 105 |
hostgroup = DBSession.query(HostGroup) \ |
| 106 | 106 |
.filter(HostGroup.idgroup == othergroupid) \ |
| ... | ... | |
| 121 | 121 |
@param idhost : identificateur d un hote |
| 122 | 122 |
@type idhost : int |
| 123 | 123 |
|
| 124 |
@return : groupes de service
|
|
| 125 |
@rtype : document json (sous forme de dict)
|
|
| 124 |
@return: groupes de service |
|
| 125 |
@rtype: document json (sous forme de dict) |
|
| 126 | 126 |
""" |
| 127 | 127 |
# passage par une table intermédiaire à cause de l'héritage |
| 128 | 128 |
servicegroups = DBSession.query \ |
| ... | ... | |
| 148 | 148 |
@param idservice : identificateur d un service |
| 149 | 149 |
@type idservice : int |
| 150 | 150 |
|
| 151 |
@return : graphes
|
|
| 152 |
@rtype : document json (sous forme de dict)
|
|
| 151 |
@return: graphes |
|
| 152 |
@rtype: document json (sous forme de dict) |
|
| 153 | 153 |
""" |
| 154 | 154 |
graphs_l = DBSession.query(Graph.name, Graph.idgraph) \ |
| 155 | 155 |
.join((GRAPH_PERFDATASOURCE_TABLE, \ |
| ... | ... | |
| 174 | 174 |
Un critere peut correspondre a un intitule complet hote ou service |
| 175 | 175 |
ou a un extrait |
| 176 | 176 |
|
| 177 |
@param **kwargs : arguments nommes
|
|
| 178 |
@type **kwargs : dict
|
|
| 177 |
@param kwargs : arguments nommes |
|
| 178 |
@type kwargs : dict |
|
| 179 | 179 |
( arguments nommes -> host et service ) |
| 180 | 180 |
|
| 181 |
@return : couples hote-service
|
|
| 182 |
@rtype : document json (sous forme de dict)
|
|
| 181 |
@return: couples hote-service |
|
| 182 |
@rtype: document json (sous forme de dict) |
|
| 183 | 183 |
""" |
| 184 | 184 |
host = kwargs.get('host')
|
| 185 | 185 |
service = kwargs.get('service')
|
| ... | ... | |
| 220 | 220 |
""" |
| 221 | 221 |
Determination (groupe principal-groupe-service) associe au couple (hote-service) |
| 222 | 222 |
|
| 223 |
@param **kwargs : arguments nommes
|
|
| 224 |
@type **kwargs : dict
|
|
| 223 |
@param kwargs : arguments nommes |
|
| 224 |
@type kwargs : dict |
|
| 225 | 225 |
( arguments nommes -> host et service ) |
| 226 | 226 |
|
| 227 |
@return : (groupe principal-groupe-service)
|
|
| 228 |
@rtype : document json (sous forme de dict)
|
|
| 227 |
@return: (groupe principal-groupe-service) |
|
| 228 |
@rtype: document json (sous forme de dict) |
|
| 229 | 229 |
""" |
| 230 | 230 |
host = kwargs.get('host')
|
| 231 | 231 |
#service = kwargs.get('service')
|
| ... | ... | |
| 295 | 295 |
@param graph : graphe |
| 296 | 296 |
@type graph : C{str}
|
| 297 | 297 |
|
| 298 |
@return : url du graphe
|
|
| 298 |
@return: url du graphe |
|
| 299 | 299 |
@rtype: C{str}
|
| 300 | 300 |
""" |
| 301 | 301 |
|
| ... | ... | |
| 347 | 347 |
@param details : indicateur affichage details dans graphe (legende) |
| 348 | 348 |
@type details : int |
| 349 | 349 |
|
| 350 |
@return : image du graphe
|
|
| 350 |
@return: image du graphe |
|
| 351 | 351 |
@rtype: image png |
| 352 | 352 |
""" |
| 353 | 353 |
result = None |
| ... | ... | |
| 389 | 389 |
@param graphtemplate : graphe |
| 390 | 390 |
@type graphtemplate : C{str}
|
| 391 | 391 |
|
| 392 |
@return : page avec l image du graphe (redirection sur getImage_png)
|
|
| 392 |
@return: page avec l image du graphe (redirection sur getImage_png) |
|
| 393 | 393 |
@rtype: page |
| 394 | 394 |
""" |
| 395 | 395 |
redirect('getImage_png?host=%s&graph=%s' % (server, graphtemplate))
|
| ... | ... | |
| 403 | 403 |
@param host : hôte |
| 404 | 404 |
@type host : C{str}
|
| 405 | 405 |
|
| 406 |
@return : date-heure de debut des donnees RRD
|
|
| 406 |
@return: date-heure de debut des donnees RRD |
|
| 407 | 407 |
@rtype: C{str}
|
| 408 | 408 |
""" |
| 409 | 409 |
|
| ... | ... | |
| 439 | 439 |
@param host : hôte |
| 440 | 440 |
@type host : C{str}
|
| 441 | 441 |
|
| 442 |
@return : page de supervision Nagios
|
|
| 443 |
@rtype : page
|
|
| 442 |
@return: page de supervision Nagios |
|
| 443 |
@rtype: page |
|
| 444 | 444 |
""" |
| 445 | 445 |
result = None |
| 446 | 446 |
|
| ... | ... | |
| 474 | 474 |
@param service : service |
| 475 | 475 |
@type service : C{str}
|
| 476 | 476 |
|
| 477 |
@return : page de supervision Nagios
|
|
| 478 |
@rtype : page
|
|
| 477 |
@return: page de supervision Nagios |
|
| 478 |
@rtype: page |
|
| 479 | 479 |
""" |
| 480 | 480 |
result = None |
| 481 | 481 |
|
| ... | ... | |
| 509 | 509 |
@param host : hôte |
| 510 | 510 |
@type host : C{str}
|
| 511 | 511 |
|
| 512 |
@return : page de metrologie
|
|
| 513 |
@rtype : page
|
|
| 512 |
@return: page de metrologie |
|
| 513 |
@rtype: page |
|
| 514 | 514 |
""" |
| 515 | 515 |
result = None |
| 516 | 516 |
|
| ... | ... | |
| 539 | 539 |
Generation document avec url des graphes affiches |
| 540 | 540 |
(pour l impression ) |
| 541 | 541 |
|
| 542 |
@param **kwargs : arguments nommes
|
|
| 543 |
@type **kwargs : dict
|
|
| 542 |
@param kwargs : arguments nommes |
|
| 543 |
@type kwargs : dict |
|
| 544 | 544 |
|
| 545 |
@return : url de graphes
|
|
| 545 |
@return: url de graphes |
|
| 546 | 546 |
@rtype: document html |
| 547 | 547 |
""" |
| 548 | 548 |
graphslist = graphs.graphsList(**kwargs) |
| ... | ... | |
| 554 | 554 |
Determination valeur temporisation pour le rafraichissement automatique |
| 555 | 555 |
d un graphe |
| 556 | 556 |
|
| 557 |
@return : valeur de temporisation
|
|
| 558 |
@rtype : C{str}
|
|
| 557 |
@return: valeur de temporisation |
|
| 558 |
@rtype: C{str}
|
|
| 559 | 559 |
""" |
| 560 | 560 |
|
| 561 | 561 |
delay = graphs.tempoDelayRefresh() |
| ... | ... | |
| 569 | 569 |
@param graph : graphe |
| 570 | 570 |
@type graph : C{str}
|
| 571 | 571 |
|
| 572 |
@return : dictionnaire des indicateurs d un graphe
|
|
| 573 |
@rtype : document json (sous forme de dict)
|
|
| 572 |
@return: dictionnaire des indicateurs d un graphe |
|
| 573 |
@rtype: document json (sous forme de dict) |
|
| 574 | 574 |
""" |
| 575 | 575 |
|
| 576 | 576 |
indicators = self.getListIndicators(graph) |
| ... | ... | |
| 586 | 586 |
@param graph : graphe |
| 587 | 587 |
@type graph : C{str}
|
| 588 | 588 |
|
| 589 |
@return : liste d indicateurs
|
|
| 589 |
@return: liste d indicateurs |
|
| 590 | 590 |
@rtype : list |
| 591 | 591 |
""" |
| 592 | 592 |
|
| ... | ... | |
| 609 | 609 |
start=None, end=None): |
| 610 | 610 |
""" |
| 611 | 611 |
Export CSV sous forme de fichier |
| 612 |
- pour un hote et un graphe |
|
| 613 |
- pour l'indicateur suivant |
|
| 614 |
- soit un des indicateurs associes au graphe |
|
| 615 |
- soit l ensemble des indicateurs -> valeur argument = All |
|
| 612 |
pour un hote et un graphe et pour l'indicateur suivant |
|
| 613 |
* soit un des indicateurs associes au graphe |
|
| 614 |
* soit l ensemble des indicateurs -> valeur argument = All |
|
| 616 | 615 |
|
| 617 | 616 |
@param host : hôte |
| 618 | 617 |
@type host : C{str}
|
| ... | ... | |
| 623 | 622 |
@param start : date-heure de debut des donnees |
| 624 | 623 |
@type start : C{str}
|
| 625 | 624 |
|
| 626 |
@return : fichier genere avec les donnees RRD repondant aux criteres
|
|
| 625 |
@return: fichier genere avec les donnees RRD repondant aux criteres |
|
| 627 | 626 |
@rtype : fichier CSV |
| 628 | 627 |
""" |
| 629 | 628 |
|
| ... | ... | |
| 744 | 743 |
def fullHostPage(self, host, start=None, duration=86400): |
| 745 | 744 |
""" |
| 746 | 745 |
Affichage de l'ensemble des graphes associes a un hote |
| 747 |
- d apres les donnees RRD
|
|
| 748 |
- avec une date-heure de debut
|
|
| 749 |
- pour une plage de temps
|
|
| 746 |
* d apres les donnees RRD
|
|
| 747 |
* avec une date-heure de debut
|
|
| 748 |
* pour une plage de temps
|
|
| 750 | 749 |
|
| 751 | 750 |
@param host : hôte |
| 752 | 751 |
@type host : C{str}
|
| ... | ... | |
| 756 | 755 |
@type duration : C{str}
|
| 757 | 756 |
(parametre optionnel, initialise a 86400 = plage de 1 jour) |
| 758 | 757 |
|
| 759 |
@return : page avec les images des graphes et boutons de deplacement dans le temps
|
|
| 758 |
@return: page avec les images des graphes et boutons de deplacement dans le temps |
|
| 760 | 759 |
@rtype: page html |
| 761 | 760 |
""" |
| 762 | 761 |
|
| ... | ... | |
| 803 | 802 |
def singleGraph(self, host, graph, start=None, duration=86400): |
| 804 | 803 |
""" |
| 805 | 804 |
Affichage d un graphe associe a un hote et un graphe |
| 806 |
- d apres les donnees RRD
|
|
| 807 |
- avec une date-heure de debut
|
|
| 808 |
- pour une plage de temps
|
|
| 805 |
* d apres les donnees RRD
|
|
| 806 |
* avec une date-heure de debut
|
|
| 807 |
* pour une plage de temps
|
|
| 809 | 808 |
|
| 810 | 809 |
@param host : hôte |
| 811 | 810 |
@type host : C{str}
|
| ... | ... | |
| 817 | 816 |
@type duration : C{str}
|
| 818 | 817 |
(parametre optionnel, initialise a 86400 = plage de 1 jour) |
| 819 | 818 |
|
| 820 |
@return : page avec l image du graphe et boutons de deplacement dans le temps
|
|
| 819 |
@return: page avec l image du graphe et boutons de deplacement dans le temps |
|
| 821 | 820 |
@rtype: page html |
| 822 | 821 |
""" |
| 823 | 822 |
|
| ... | ... | |
| 843 | 842 |
""" |
| 844 | 843 |
Formulaire de recherche sur les hotes |
| 845 | 844 |
|
| 846 |
@return : page avec formulaire de recherche
|
|
| 845 |
@return: page avec formulaire de recherche |
|
| 847 | 846 |
@rtype: page html |
| 848 | 847 |
""" |
| 849 | 848 |
searchhostform = SearchHostForm('search_host_form', \
|
| ... | ... | |
| 859 | 858 |
@param query : prefixe de recherche sur les hotes |
| 860 | 859 |
@type query : C{str}
|
| 861 | 860 |
|
| 862 |
@return : page
|
|
| 861 |
@return: page |
|
| 863 | 862 |
@rtype: page html |
| 864 | 863 |
""" |
| 865 | 864 |
|
| ... | ... | |
| 897 | 896 |
""" |
| 898 | 897 |
Moteur de recherche des graphes |
| 899 | 898 |
|
| 900 |
@return : document
|
|
| 899 |
@return: document |
|
| 901 | 900 |
@rtype: document xml |
| 902 | 901 |
""" |
| 903 | 902 |
|
| ... | ... | |
| 917 | 916 |
@param host : hôte |
| 918 | 917 |
@type host : C{str}
|
| 919 | 918 |
|
| 920 |
@return : serveur RRD
|
|
| 919 |
@return: serveur RRD |
|
| 921 | 920 |
@rtype: C{str}
|
| 922 | 921 |
""" |
| 923 | 922 |
|
| ... | ... | |
| 945 | 944 |
@param host : hôte |
| 946 | 945 |
@type host : C{str}
|
| 947 | 946 |
|
| 948 |
@return : serveur Nagios
|
|
| 947 |
@return: serveur Nagios |
|
| 949 | 948 |
@rtype: C{str}
|
| 950 | 949 |
""" |
| 951 | 950 |
|
Also available in: Unified diff