Project

General

Profile

Revision 106d99dd

ID106d99dd7aba19bc71df6119e88b5195e9aac010
Parent 876e6068
Child a3e33eb1

Added by Aurelien BOMPARD about 12 years ago

Correction de la syntaxe RST dans la doc

Change-Id: I3e14c776b827cb76ad67c70325c994bce474cf6f

View differences:

doc/util.rst
3 3
********************
4 4

  
5 5
Description générale de l'application
6
#####################################
6
=====================================
7 7

  
8 8
Présentation
9
============
9
------------
10 10
L'objectif de VigiGraph est de fournir une interface unifiée d'accès à
11 11
l'ensemble des applications web de supervision et de métrologie (Nagios,
12 12
VigiRRD), alors même que ces interfaces sont réparties sur plusieurs serveurs.
......
16 16
Pour les graphiques, l'impression et l'export (sous forme de fichier CSV) sont de plus possibles.
17 17

  
18 18
Principales données accessibles
19
===============================
19
-------------------------------
20 20
VigiGraph accède aux données suivantes :
21 21

  
22 22
- des données de configuration	:	dans les fichiers de configuration,
......
26 26

  
27 27

  
28 28
Services annexes
29
================
29
----------------
30 30
Néant.
31 31

  
32 32
Utilisateurs
33
============
33
------------
34 34

  
35 35
Authentification d'un utilisateur
36
---------------------------------
36
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
37 37
Un utilisateur s'authentifie à l'aide de deux informations : un identifiant et un mot de passe.
38 38

  
39 39
Utilisation de l'application
40
############################
40
============================
41 41

  
42 42
Configuration pré-requise
43
=========================
43
-------------------------
44 44
L'application s'utilise via un navigateur web, au travers d'une adresse internet (URL). Cette adresse vous a été transmise par votre administrateur.
45 45
Le reste de ce document présente des captures d'écran réalisées sous Mozilla Firefox 3.6. D'autres navigateurs ou d'autres versions du navigateur Mozilla Firefox peuvent également être utilisés. Certaines fonctionnalités font appel à des outils intégrés au navigateur (marque-pages, moteurs de recherche, …) et peuvent ne pas être disponibles sur votre navigateur ou nécessiter une légère adaptation.
46 46

  
47 47
Procédure de connexion
48
======================
48
----------------------
49 49

  
50 50
- Sur le Poste Client, lancer le navigateur web
51 51
  → la page d'accueil du navigateur s'affiche
......
94 94

  
95 95

  
96 96
Procédure de déconnexion
97
========================
97
------------------------
98 98
Cliquer sur le bouton « Déconnexion »
99 99
.. image:: img/logout_button.png
100 100

  
......
104 104
de l'application.
105 105

  
106 106
Fonctionnalités
107
###############
107
===============
108 108
Les fonctionnalités suivantes sont supportées :
109 109

  
110 110
- Recherche
......
118 118

  
119 119

  
120 120
Sélection d'un hôte / graphe
121
============================
121
----------------------------
122 122
L'accès à certaines des fonctionnalités de VigiGraph nécessite que les champs de la barre de sélection soient renseignés. Les champs pouvant être modifiés sont ceux qui disposent d'une flèche pointant vers le bas
123 123
.. image:: img/100000000000000E000000106713413D.png
124 124

  
......
151 151
Le renseignement de chacun des champs constitutifs de cette fenêtre s'effectue par choix dans une liste établie d'après les valeurs présentes en base de données.
152 152

  
153 153
Recherche
154
=========
154
---------
155 155
Cette fenêtre permet l'affichage de la liste des couples Hôtes - Graphes.
156 156
L'activation s'effectue par un clic sur l'icône en forme de loupe
157 157
.. image:: img/100002010000001800000018D51A653F.png
......
205 205
 en haut à droite de la fenêtre de recherche provoque la fermeture de cette fenêtre.
206 206

  
207 207
Consultation d'un graphe
208
========================
208
------------------------
209 209
Cette fonctionnalité permet de consulter un graphe. Elle se rapporte au serveur et au graphe sélectionnés dans la barre de sélection (voir chapitre ). Les données exploitées sont extraites des fichiers RRD.
210 210
L'affichage s'effectue dans une boîte de dialogue distincte, comme présenté dans l'illustration .
211 211

  
......
263 263
 en haut à droite de la fenêtre du graphe provoque la fermeture de cette fenêtre.
264 264

  
265 265
Consultation d'une page de supervision
266
======================================
266
--------------------------------------
267 267
Cette fonctionnalité permet de consulter les données Nagios. Elle se rapporte à l'hôte actuellement sélectionné (voir chapitre ).
268 268
L'activation s'effectue par un clic sur le bouton « Page Nagios » dans la barre de sélection d'un hôte, cerclé de rouge sur l'illustration  qui suit. L'intitulé de l'info-bulle d'aide est « Affiche la page Nagios de l'hôte sélectionné ».
269 269
Cette visualisation n'est possible qu'après renseignement des trois premiers champs de la fenêtre.
......
280 280

  
281 281

  
282 282
Consultation de l'ensemble des graphes de métrologie d'un hôte
283
==============================================================
283
--------------------------------------------------------------
284 284
Cette fonctionnalité permet de consulter l'ensemble des graphes de métrologie
285 285
d'un hôte. Elle se rapporte à l'hôte actuellement sélectionné (voir chapitre ).
286 286
L'activation s'effectue par un clic sur le bouton « Page de métrologie » dans
......
303 303

  
304 304

  
305 305
Impression d'un graphe
306
======================
306
----------------------
307 307
Cette fonctionnalité permet d'imprimer le graphe courant tel qu'il est présenté à l'écran.
308 308
L'activation de l'impression s'effectue par un clic dans la fenêtre du graphe sur le bouton
309 309
.. image:: img/100002010000001000000010DAA1BEF7.png
......
325 325
Après renseignement des paramètres d'impression et validation, cette fenêtre se referme et l'impression commence.
326 326

  
327 327
Export d'un graphe
328
==================
328
------------------
329 329
Cette fonctionnalité permet d'exporter le graphe courant.
330 330
L'activation de l'export s'effectue par un clic dans la fenêtre du graphe sur le bouton « 
331 331
.. image:: img/1000020100000010000000103A35F438.png
......
361 361
Les données sont triées par horodatage croissant dans le fichier exporté.
362 362

  
363 363
Rafraîchissement automatique d'un graphe
364
========================================
364
----------------------------------------
365 365
Cette fonctionnalité permet de réactualiser un graphe périodiquement.
366 366
La période figure dans un fichier de configuration ; elle est exprimée en secondes. Par défaut, elle est initialisée à 30 secondes. Cette donnée n'est pas modifiable via l'application. Elle est gérée par l'administrateur système.
367 367
L'activation s'effectue par un clic sur le bouton
......
385 385
 permet également d'activer ou de désactiver le rafraîchissement automatique sur l'ensemble des graphes visibles à l'écran. Le comportement de ce bouton est similaire à celui du bouton positionné sur chaque fenêtre de graphe : un clic permet d'activer le rafraîchissement (le bouton apparaît alors enfoncé), un nouveau clic désactive le rafraîchissement (le bouton apparaît alors relâché).
386 386

  
387 387
Impression de l'ensemble des graphes
388
====================================
388
------------------------------------
389 389
Cette fonctionnalité permet l'impression de tous les graphes affichés à l'écran.
390 390
L'activation s'effectue par un clic sur le bouton
391 391
.. image:: img/100002010000001000000010DAA1BEF7.png
......
404 404
Après renseignement des paramètres d'impression et validation, cette fenêtre se referme et l'impression s'effectue.
405 405

  
406 406
Sauvegarde de l'affichage
407
=========================
407
-------------------------
408 408
Cette fonctionnalité permet de sauvegarder un ensemble de graphes affichés à l'écran pour des opérations ultérieures.
409 409
La constitution de la sélection s'effectue via le navigateur, en ajoutant un marque-page, à l'aide des étapes suivantes :
410 410

  
......
423 423

  
424 424

  
425 425
Moteur de recherche
426
===================
426
-------------------
427 427
La phase de recherche nécessite au préalable l'enregistrement du moteur de recherche de VigiGraph au sein du navigateur. Cette déclaration ne doit être effectuée qu'une seule fois.
428 428
Pour enregistrer le moteur de recherche :
429 429

  
......
460 460
Un clic sur l'un de ces liens remplace la page courante par la page demandée.
461 461
Le lien intitulé « Page de métrologie » permet de consulter l'ensemble des graphes de l'hôte concerné. Le lien intitulé « Page de supervision » donne accès à la page de supervision de l'hôte concerné dans Nagios.
462 462

  
463

  
463 464
Description de l'interface
464
##########################
465
==========================
465 466

  
466 467
Architecture statique d'un écran
467
================================
468
--------------------------------
468 469
Un écran comporte :
469 470

  
470 471
- une barre de titre
......
474 475

  
475 476

  
476 477
Dynamique des écrans
477
====================
478
--------------------
478 479
On distingue deux types d'écran:
479 480

  
480 481
- page	:	ressource web (associée à une URL)
......
484 485
Le positionnement de la souris sur un bouton provoque l'affichage de l'intitulé d'aide associé (s'il y a lieu).
485 486

  
486 487
Écrans
487
======
488
------
488 489

  
489 490
Formulaire d'authentification
490
-----------------------------
491
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
491 492
Ce formulaire permet la saisie des informations d'authentification.
492 493
Il s'affiche au lancement.
493 494

  
......
496 497

  
497 498

  
498 499
Page VigiGraph
499
--------------
500
^^^^^^^^^^^^^^
500 501
Cette page autorise les opérations de visualisation (graphes et pages), d'impression (graphes) et de recherche (hôtes et graphes).
501 502
Elle s'affiche une fois l'authentification effectuée.
502 503

  
......
506 507
La visualisation s'effectue via la barre de sélection d'un hôte / graphe.
507 508

  
508 509
Barre de sélection d'un hôte / graphe
509
-------------------------------------
510
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
510 511
Cette barre se présente comme suit :
511 512

  
512 513
..  figure:: img/selection_bar.png
......
516 517
Une fois l'hôte sélectionné, les boutons d'affichage de la page Nagios, de la page de métrologie et de sélection du graphe s'activent. Une fois le nom du graphe à afficher sélectionné, celui-ci apparaît à l'écran.
517 518

  
518 519
Graphe
519
------
520
^^^^^^
520 521
Cette fenêtre permet la visualisation d'un graphe.
521 522

  
522 523
..  figure:: img/graph_window.png
......
588 589
.
589 590

  
590 591
Page de supervision
591
-------------------
592
^^^^^^^^^^^^^^^^^^^
592 593
Cette page permet la visualisation des données Nagios pour un hôte.
593 594

  
594 595
..  figure:: img/nagios_page.png
......
596 597

  
597 598

  
598 599
Impression
599
----------
600
^^^^^^^^^^
600 601
Cette fenêtre est destinée à saisir les paramètres d'impression. Elle s'affiche après déclenchement d'une demande d'impression.
601 602

  
602 603
..  figure:: img/print_dialog.png
......
604 605

  
605 606

  
606 607
Export CSV
607
----------
608
^^^^^^^^^^
608 609
Cette fenêtre est destinée à saisir les paramètres d'export.
609 610
Elle s'affiche après activation d'un export.
610 611

  
......
632 633

  
633 634

  
634 635
Recherche
635
---------
636
^^^^^^^^^
636 637
Cette fenêtre permet l'affichage de la liste des couples Hôtes-Graphes.
637 638
Elle se présente comme suit :
638 639

  
......
664 665
Un clic dans la zone d'affichage des résultats sur le nom d'un graphe déclenche l'ouverture de ce graphe. Un clic sur le nom d'un hôte pré-sélectionne cet hôte dans la barre de sélection.
665 666

  
666 667
Format des sorties
667
##################
668
==================
668 669
VigiGraph permet des sorties :
669 670

  
670 671
- écran	:	affichage des graphes et des pages de supervision
......
684 685

  
685 686

  
686 687
Annexes
687
#######
688
=======
688 689

  
689 690
.. include:: ../../turbogears/doc/glossaire.rst
690 691

  

Also available in: Unified diff