vigigraph / doc / util-features.rst @ master
History | View | Annotate | Download (15.2 KB)
1 |
Fonctionnalités |
---|---|
2 |
=============== |
3 |
|
4 |
Page d'accueil |
5 |
-------------- |
6 |
Une fois la page d'authentification passée, la page d'accueil s'affiche, comme |
7 |
comme sur la figure qui suit. |
8 |
Il s'agit de l'interface principale de VigiGraph. |
9 |
|
10 |
.. figure:: img/homepage.png |
11 |
|
12 |
Page d'accueil. |
13 |
|
14 |
Cette page permet à la fois la recherche, la visualisation, et l'impression des |
15 |
graphes. |
16 |
|
17 |
|
18 |
Sélection d'un hôte |
19 |
------------------- |
20 |
L'accès à la plupart des fonctionnalités de VigiGraph nécessite que le champ |
21 |
« Hôte » de la barre de sélection soit renseigné. |
22 |
|
23 |
.. _fig-selection-bar: |
24 |
.. figure:: img/selection_bar.png |
25 |
|
26 |
Barre de sélection. |
27 |
|
28 |
Après un premier clic sur le bouton « Sélectionner un hôte », une boîte de |
29 |
dialogue permet de choisir l'hôte souhaité parmi l'arborescence des groupes |
30 |
configurés dans Vigilo. |
31 |
|
32 |
.. _fig-select-host: |
33 |
.. figure:: img/select_host.png |
34 |
|
35 |
Sélection de l'hôte. |
36 |
|
37 |
|
38 |
Sélection d'un graphe à afficher |
39 |
-------------------------------- |
40 |
|
41 |
Une fois un hôte sélectionné, le bouton « Sélectionner un graphe » devient |
42 |
actif. |
43 |
|
44 |
Un clic sur ce bouton permet de choisir un graphe à afficher parmi la liste de |
45 |
graphes diponibles pour cet hôte. La fenêtre de visualisation s'ouvre alors, |
46 |
comme le montre l'illustration suivante : |
47 |
|
48 |
.. _fig-graph-window: |
49 |
.. figure:: img/graph_window.png |
50 |
|
51 |
Affichage du graphe après sélection de l'hôte et du graphe. |
52 |
|
53 |
Cette fenêtre est décrite plus en détail dans la section `Visualisation d'un |
54 |
graphe`_. |
55 |
|
56 |
.. note:: |
57 |
Il est tout à fait possible de sélectionner plusieurs graphes de plusieurs |
58 |
hôtes pour un affichage simultané. |
59 |
|
60 |
|
61 |
Recherche |
62 |
--------- |
63 |
Cette fenêtre permet de rechercher parmi la liste des couples Hôtes/Graphes |
64 |
disponibles. |
65 |
L'activation s'effectue par un clic sur l'icône en forme de loupe |lens| située |
66 |
en haut à droite de l'interface. |
67 |
|
68 |
.. |lens| image:: img/lens.png |
69 |
:alt: loupe |
70 |
|
71 |
La fenêtre de recherche se présente au départ comme sur l'illustration |
72 |
suivante : |
73 |
|
74 |
.. figure:: img/search_form_empty.png |
75 |
|
76 |
État initial du formulaire de recherche. |
77 |
|
78 |
Les caractères « ? » et « \* » permettent de représenter un caractère |
79 |
quelconque ou une suite de caractères quelconques, respectivement. |
80 |
|
81 |
Un clic sur le bouton « Rechercher » provoque l'affichage de la liste complète |
82 |
des couples Hôtes/Graphes déclarés en base de données et correspondant aux |
83 |
motifs de recherche saisis. |
84 |
|
85 |
Si aucun texte n'a été saisi dans le champ « Hôte » et le champ « Graphe », |
86 |
la liste complète de tous les couples Hôtes/Graphes disponibles est affichée. |
87 |
|
88 |
.. figure:: img/search_form_all.png |
89 |
|
90 |
Liste de tous les graphes disponibles. |
91 |
|
92 |
Les champs de saisie « Hôte » et « Graphe » permettent la saisie de critères |
93 |
de recherche sur un serveur ou un graphe particulier. |
94 |
|
95 |
.. figure:: img/search_form_graph.png |
96 |
|
97 |
Recherche des graphes portant sur une partition. |
98 |
|
99 |
et/ou : |
100 |
|
101 |
.. figure:: img/search_form_host.png |
102 |
|
103 |
Recherche parmi les hôtes. |
104 |
|
105 |
Les deux critères peuvent être combinés afin de n'afficher que |
106 |
certains graphes d'un ensemble d'hôtes. |
107 |
|
108 |
La sélection d'un élément de cette liste est possible par un clic sur la ligne |
109 |
correspondante. Ce clic provoque l'actualisation de la fenêtre « Sélection d'un |
110 |
hôte » afin de sélectionner l'hôte (et éventuellement le graphe) cliqué. Si |
111 |
l'élément cliqué correspond à un graphe, le graphe est affiché à l'écran, comme |
112 |
sur l'illustration suivante : |
113 |
|
114 |
.. figure:: img/search_click_graph.png |
115 |
|
116 |
Affichage d'un graphe suite à un clic dans la fenêtre de recherche. |
117 |
|
118 |
|
119 |
Visualisation d'un graphe |
120 |
------------------------- |
121 |
L'affichage des graphes s'effectue dans une fenêtre distincte, semblable |
122 |
à celle présentée dans l'illustration suivante : |
123 |
|
124 |
.. figure:: img/graph_window.png |
125 |
|
126 |
Fenêtre de visualisation d'un graphe. |
127 |
|
128 |
Cette fenêtre comporte : |
129 |
|
130 |
- une barre de titre rappelant le nom de l'hôte et du graphe affiché ; |
131 |
- des boutons de gestion de l'affichage du graphe ; |
132 |
- la zone d'affichage à proprement parler. |
133 |
|
134 |
Le graphe donne l'évolution des valeurs dans le temps, avec un intervalle de |
135 |
temps par défaut qui couvre les dernières 24 heures. |
136 |
|
137 |
L'utilisateur peut modifier cette durée en cliquant sur les boutons |plus| et |
138 |
|minus|. |
139 |
|
140 |
Ceci provoque le rafraîchissement des données sur une durée respectivement |
141 |
diminuée ou agrandie avec un facteur 2. |
142 |
|
143 |
La sélection de la plage de temps est aussi possible : |
144 |
|
145 |
- par un clic sur un des boutons |graph_start|, |previous_section|, |
146 |
|next_section|, et |graph_end| (respectivement plage de |
147 |
début, plage précédente, plage suivante et plage de fin) ; |
148 |
|
149 |
- ou par un choix dans la liste obtenue après un clic sur le bouton « Période » |time_period|. |
150 |
|
151 |
Ceci provoque le rafraîchissement des données sur la durée courante. |
152 |
|
153 |
Dans l'illustration, le bouton |graph_start| |
154 |
a été utilisé afin de se replacer au tout début de la période d'enregistrement. |
155 |
Partant de cette situation, l'utilisation du bouton |next_section| donne par |
156 |
exemple le graphe suivant : |
157 |
|
158 |
.. figure:: img/graph_window2.png |
159 |
|
160 |
Progression dans le temps. |
161 |
|
162 |
Le tableau suivant liste l'ensemble des boutons disponibles dans la fenêtre de |
163 |
visualisation, et détaille leur fonctionnement : |
164 |
|
165 |
.. list-table:: Liste des boutons |
166 |
:widths: 10 25 65 |
167 |
:header-rows: 1 |
168 |
|
169 |
* - Bouton |
170 |
- Intitulé de la bulle d'aide |
171 |
- Détail |
172 |
* - |reload| |
173 |
- Recharger le graphe |
174 |
- Rafraîchissement automatique du graphe selon la fréquence configurée : |
175 |
|
176 |
- bouton enfoncé → rafraîchissement automatique |
177 |
- bouton relâché → pas de rafraîchissement |
178 |
* - |time_period| |
179 |
- Menu de choix de la période |
180 |
- Rafraîchissement du graphe avec adaptation à la plage de temps |
181 |
* - |graph_start| |
182 |
- Début du graphe |
183 |
- Rafraîchissement du graphe avec les valeurs de la première plage de |
184 |
temps |
185 |
* - |previous_section| |
186 |
- Section précédente |
187 |
- Rafraîchissement du graphe avec les valeurs de la plage de temps |
188 |
précédente |
189 |
* - |next_section| |
190 |
- Section suivante |
191 |
- Rafraîchissement du graphe avec les valeurs de la plage de temps |
192 |
suivante |
193 |
* - |graph_end| |
194 |
- Fin du graphe |
195 |
- Rafraîchissement du graphe avec les valeurs de la dernière plage de |
196 |
temps |
197 |
* - |plus| |
198 |
- Zoomer |
199 |
- Rafraîchissement du graphe avec agrandissement de la plage de temps |
200 |
(x 2) |
201 |
* - |minus| |
202 |
- Dézoomer |
203 |
- Rafraîchissement du graphe avec diminution de la plage de temps (/ 2) |
204 |
* - |export| |
205 |
- Export CSV |
206 |
- Export du graphe |
207 |
* - |print| |
208 |
- Imprimer le graphe |
209 |
- Impression du graphe |
210 |
|
211 |
.. |reload| image:: img/reload.png |
212 |
:alt: rechargement |
213 |
.. |time_period| image:: img/time_period.png |
214 |
:alt: période |
215 |
.. |graph_start| image:: img/graph_start.png |
216 |
:alt: plage de début |
217 |
.. |previous_section| image:: img/previous_section.png |
218 |
:alt: plage précédente |
219 |
.. |next_section| image:: img/next_section.png |
220 |
:alt: plage suivante |
221 |
.. |graph_end| image:: img/graph_end.png |
222 |
:alt: plage de fin |
223 |
.. |plus| image:: img/plus.png |
224 |
:alt: plus |
225 |
.. |minus| image:: img/minus.png |
226 |
:alt: plus |
227 |
.. |export| image:: img/export.png |
228 |
:alt: export |
229 |
.. |print| image:: img/print.png |
230 |
:alt: impression |
231 |
|
232 |
|
233 |
Consultation d'une page de supervision |
234 |
-------------------------------------- |
235 |
Cette fonctionnalité permet de consulter la page Nagios de l'hôte actuellement |
236 |
sélectionné (voir la section `Sélection d'un hôte`_). |
237 |
|
238 |
L'activation s'effectue par un clic sur le bouton « Liens externes » dans la |
239 |
barre de sélection de l'hôte, suivi par un clic sur le bouton « Page Nagios ». |
240 |
|
241 |
L'affichage s'effectue dans une page distincte, comme le montre l'illustration |
242 |
suivante : |
243 |
|
244 |
.. figure:: img/nagios_page.png |
245 |
|
246 |
Exemple d'une page de supervision Nagios. |
247 |
|
248 |
|
249 |
Consultation de l'ensemble des graphes de métrologie d'un hôte |
250 |
-------------------------------------------------------------- |
251 |
Cette fonctionnalité permet de consulter l'ensemble des graphes de métrologie |
252 |
de l'hôte actuellement sélectionné (voir la section `Sélection d'un hôte`_). |
253 |
|
254 |
L'activation s'effectue par un clic sur le bouton « Liens externes » dans la |
255 |
barre de sélection de l'hôte, suivi par un clic sur le bouton « Page de |
256 |
métrologie ». |
257 |
|
258 |
L'affichage s'effectue dans une page distincte, comme le montre l'illustration |
259 |
suivante : |
260 |
|
261 |
.. figure:: img/metrology_page.png |
262 |
|
263 |
Vue synthétique de tous les graphes d'un hôte. |
264 |
|
265 |
|
266 |
Impression d'un graphe |
267 |
---------------------- |
268 |
Cette fonctionnalité permet d'imprimer le graphe courant, tel |
269 |
qu'il est actuellemnet présenté à l'écran. |
270 |
|
271 |
L'activation de l'impression s'effectue par un clic sur le bouton |print| de la |
272 |
fenêtre de visualisation du graphe. |
273 |
|
274 |
Une fenêtre d'impression s'affiche alors. |
275 |
|
276 |
.. figure:: img/print_dialog.png |
277 |
|
278 |
Fenêtre d'impression d'un graphe. |
279 |
|
280 |
Après renseignement des paramètres d'impression et validation, cette fenêtre se |
281 |
referme et l'impression commence. |
282 |
|
283 |
.. note:: |
284 |
Si plusieurs graphes sont affichés à l'écran au moment de l'activation de |
285 |
l'impression, ils seront tous imprimés. |
286 |
|
287 |
Export d'un graphe |
288 |
------------------ |
289 |
Cette fonctionnalité permet d'exporter le graphe courant. |
290 |
|
291 |
L'activation de l'export s'effectue par un clic sur le bouton |export| de la |
292 |
fenêtre de visualisation du graphe, suivi par un clic sur nom de l'indicateur à |
293 |
exporter (ou sur le label « Tous » pour exporter simultanément tous les |
294 |
indicateurs du graphe). |
295 |
|
296 |
La fenêtre d'export s'affiche alors, comme sur l'illustration suivante : |
297 |
|
298 |
.. figure:: img/export_dialog.png |
299 |
|
300 |
Fenêtre de sauvegarde des données exportées. |
301 |
|
302 |
Une fois l'une des options validée, la fenêtre se referme. Le fichier généré |
303 |
est consultable à l'aide d'un tableur. Le contenu se présente comme suit : |
304 |
|
305 |
.. figure:: img/oocalc.png |
306 |
|
307 |
Données exportées vues dans un tableur. |
308 |
|
309 |
La sortie par défaut d'un fichier au format CSV se caractérise comme suit : |
310 |
|
311 |
- Les valeurs sont entourées par des guillemets droits (") et séparées par des |
312 |
points virgules (;). |
313 |
- Le contre-oblique (\) est utilisé en tant que caractère d'échappement. |
314 |
- La première ligne du fichier contient un en-tête composé des libellés des |
315 |
champs dans leur ordre d'apparition (« Timestamp » puis l'indicateur ou la |
316 |
série d'indicateurs exportés). |
317 |
- Les lignes suivantes correspondent aux valeurs de chaque indicateur à |
318 |
l'instant identifié par la valeur de la colonne « Timestamp ». |
319 |
- Les lignes sont triées par ordre chronologique croissant. |
320 |
|
321 |
L'administrateur peut choisir de paramétrer différemment l'export (notamment |
322 |
les caractères utilisés pour la séparation des valeurs, leur délimitation ou le |
323 |
caractère d'échappement). Consultez votre administrateur afin de connaître le |
324 |
format exact des fichiers générés. |
325 |
|
326 |
Rafraîchissement automatique d'un graphe |
327 |
---------------------------------------- |
328 |
Cette fonctionnalité permet de réactualiser un graphe périodiquement. |
329 |
|
330 |
La période figure dans un fichier de configuration ; elle est exprimée en |
331 |
secondes. Par défaut, elle est initialisée à 30 secondes. Cette donnée n'est |
332 |
pas modifiable via l'application. Elle est gérée par l'administrateur système. |
333 |
|
334 |
L'activation s'effectue par un clic sur le bouton |auto_refresh_enabled| de la |
335 |
fenêtre de visualisation du graphe. Le bouton apparaît alors enfoncé. |
336 |
|
337 |
.. |auto_refresh_enabled| image:: img/auto_refresh_enabled.png |
338 |
:alt: rafraîchissement automatique |
339 |
|
340 |
La désactivation s'effectue aussi par un clic sur le même bouton. Celui-ci |
341 |
apparaît alors relâché. L'illustration suivante présente l'état du bouton selon |
342 |
que le rafraîchissement automatique est activé ou non : |
343 |
|
344 |
.. image:: img/auto_refresh.png |
345 |
|
346 |
Illustration : Rafraîchissement automatique activé (à gauche) et désactivé (à |
347 |
droite) |
348 |
|
349 |
Un bouton global |auto_refresh_global| permet également d'activer ou de |
350 |
désactiver le rafraîchissement automatique sur l'ensemble des graphes visibles |
351 |
à l'écran. |
352 |
|
353 |
.. |auto_refresh_global| image:: img/auto_refresh_global.png |
354 |
:alt: rafraîchissement automatique global |
355 |
|
356 |
Le comportement de ce bouton est similaire à celui du bouton positionné sur |
357 |
chaque fenêtre de graphe : un clic permet d'activer le rafraîchissement (le |
358 |
bouton apparaît alors enfoncé), un nouveau clic désactive le rafraîchissement |
359 |
(le bouton apparaît alors relâché). |
360 |
|
361 |
Sauvegarde de l'affichage |
362 |
------------------------- |
363 |
Cette fonctionnalité permet de sauvegarder un ensemble de graphes affichés à |
364 |
l'écran pour des opérations ultérieures. |
365 |
|
366 |
La sauvegarde s'effectue via le navigateur, en ajoutant un marque-page. |
367 |
Par exemple, sous Firefox : |
368 |
|
369 |
- Cliquer sur le menu « Marque-Pages ». |
370 |
- Choisir l'option « Marquer cette page ». |
371 |
- Saisir un nom pour le marque-page (ou laisser la valeur par défaut). |
372 |
- Choisir un dossier de destination (par exemple « Barre personnelle »). |
373 |
- Valider par un clic sur le bouton « Terminer ». |
374 |
|
375 |
Le rappel de la sélection s'effectue également via le navigateur ; par exemple, |
376 |
sous Firefox : |
377 |
|
378 |
- Cliquer sur le menu « Marque-Pages ». |
379 |
- Sélectionner l'élément créé précédemment lors de l'ajout du marque-page . |
380 |
|
381 |
Moteur de recherche |
382 |
------------------- |
383 |
En plus de la fonctionnalité de recherche accessible directement depuis la page |
384 |
d'accueil (voir la section `Recherche`_), VigiGraph est livré avec un moteur de |
385 |
recherche qui peut être utilisé directement depuis la barre de recherche de |
386 |
votre navigateur. |
387 |
|
388 |
La procédure qui suit décrit l'ajout et l'utilisation de ce moteur de recherche |
389 |
depuis Firefox ; dans le cas où vous souhaiteriez utiliser un autre navigateur |
390 |
pour accéder à VigiGraph, reportez-vous au manuel dudit navigateur pour savoir |
391 |
comment adapter cette procédure. |
392 |
|
393 |
Pour enregistrer le moteur de recherche sous Firefox (cette manipulation n'est |
394 |
à effectuer qu'une seule fois) : |
395 |
|
396 |
- Cliquer sur le bouton à gauche de la zone des moteurs de recherche. |
397 |
→ La liste des moteurs actuellement enregistrés s'affiche, ainsi que des |
398 |
actions possibles. |
399 |
- Cliquer sur la ligne « Ajouter "Recherche Vigilo" ». |
400 |
→ Le moteur de recherche de VigiGraph est ajouté à la liste des moteurs de |
401 |
recherche disponibles et la liste disparaît de l'écran. |
402 |
|
403 |
Une fois le moteur de recherche enregistré, il apparaît dans le navigateur sous |
404 |
la forme d'une zone de saisie. |
405 |
|
406 |
Pour effectuer une recherche : |
407 |
|
408 |
- Cliquer sur le bouton à gauche et choisir « Recherche Vigilo » (représenté |
409 |
par l'icône de Vigilo : un œil vert) dans la liste des moteurs de recherche. |
410 |
- Saisir un intitulé dans la zone de saisie. |
411 |
- Cliquer sur le bouton en forme de loupe à droite ou valider à l'aide de la |
412 |
touche « Entrée ». |
413 |
|
414 |
→ Une page présentant des informations sur les serveurs répondant à la requête |
415 |
s'affiche alors. |
416 |
|
417 |
Un exemple de résultats obtenus lors de la recherche du terme « local » est |
418 |
présenté sur l'illustration suivante : |
419 |
|
420 |
.. figure:: img/opensearch_results.png |
421 |
|
422 |
Résultat de l'utilisation du moteur de recherche. |
423 |
|
424 |
Dans cette page, sur chaque ligne, figurent : |
425 |
|
426 |
- le nom de l'équipement ; |
427 |
- un lien vers la page de supervision (voir la section `Consultation d'une page |
428 |
de supervision`_) ; |
429 |
- un lien vers la métrologie de l'hôte, c'est-à-dire la liste de ses graphes |
430 |
(voir la section `Consultation de l'ensemble des graphes de métrologie d'un |
431 |
hôte`_). |
432 |
|
433 |
Un clic sur l'un de ces liens remplace la page courante par la page demandée. |
434 |
|
435 |
|
436 |
.. vim: set tw=79 : |