vigiboard / doc / util.rst @ 8ddc04ff
History | View | Annotate | Download (14.5 KB)
1 | 0075a681 | Francois POIROTTE | ******************** |
---|---|---|---|
2 | Guide d'utilisation |
||
3 | ******************** |
||
4 | |||
5 | |||
6 | Démarrage rapide |
||
7 | ================ |
||
8 | VigiBoard fournit une interface graphique accessible depuis un navigateur Web. La configuration par défaut est suffisante pour un démarrage rapide. |
||
9 | |||
10 | Accès à l'interface |
||
11 | ------------------- |
||
12 | L'utilisation de VigiBoard se fait simplement en accédant, via votre navigateur, à l'adresse indiquée par votre administrateur. Par exemple : http://supervision.example.com/vigiboard/. |
||
13 | |||
14 | Authentification |
||
15 | ---------------- |
||
16 | |||
17 | .. note:: |
||
18 | Dans le cas où un mécanisme d'authentification externe a été défini par votre |
||
19 | administrateur, il se peut qu'aucune authentification ne vous soit demandée, même lorsqu'il |
||
20 | s'agit de votre première connexion. Le reste de ce chapitre décrit le cas où une |
||
21 | authentification interne a lieu et ne s'applique donc pas au cas de figure cité ci-dessus. |
||
22 | Contactez votre administrateur pour plus d'information sur la configuration utilisée. |
||
23 | |||
24 | |||
25 | Si vous ne vous êtes jamais connecté sur VigiBoard ou si vous n'êtes plus authentifié, le formulaire d'authentification de la figure suivante s'affiche: |
||
26 | |||
27 | .. figure:: img/login_form.png |
||
28 | |||
29 | Écran d'authentification. |
||
30 | |||
31 | |||
32 | Selon le compte utilisateur auquel vous vous connecterez, vous disposerez d'un accès à plus ou moins d'hôtes et de services (et donc d'informations). |
||
33 | Les données d'authentification demandées ici vous ont normalement été transmises par votre administrateur. |
||
34 | |||
35 | - Saisir les données d'authentification en renseignant les zones de saisie « Identifiant » et « Mot de passe ». |
||
36 | - Valider la saisie en cliquant sur le bouton « Connexion » (entouré en rouge sur la figure suivante). |
||
37 | |||
38 | |||
39 | .. figure:: img/login_form_connection.png |
||
40 | |||
41 | Bouton de validation des données d'authentification. |
||
42 | |||
43 | |||
44 | En cas de succès, le bac à événements s'affiche. Sinon, le formulaire d'authentification s'affiche à nouveau, avec un message précisant la nature de l'erreur: |
||
45 | |||
46 | .. figure:: img/login_failure.png |
||
47 | |||
48 | Formulaire après un échec de l'authentification. |
||
49 | |||
50 | |||
51 | |||
52 | Fonctionnalités |
||
53 | =============== |
||
54 | |||
55 | Tableau des évènements |
||
56 | ---------------------- |
||
57 | Une fois la page d'authentification passée, le tableau des évènements |
||
58 | s'affiche, comme sur la figure qui suit. |
||
59 | Il s'agit de l'interface principale de VigiBoard. |
||
60 | |||
61 | .. figure:: img/dashboard.png |
||
62 | |||
63 | Tableau des évènements. |
||
64 | |||
65 | |||
66 | Chaque ligne de ce tableau représente l'un des évènements corrélés (incidents) |
||
67 | détectés par Vigilo. Les informations suivantes y sont détaillées : |
||
68 | |||
69 | * L'état de l'hôte ou du service sur lequel l'évènement est survenu, |
||
70 | représenté par une icône en début de ligne, dont la signification |
||
71 | est détaillée dans le tableau ci-après ; |
||
72 | * La date à laquelle il a été détecté ; |
||
73 | * La priorité avec laquelle il devrait être traité (sa gravité) ; |
||
74 | * Le nombre d'alertes remontées par Vigilo le concernant ; |
||
75 | * Le nom de l'hôte (et éventuellement du service) sur lequel il est survenu ; |
||
76 | * Le message d'alerte ; |
||
77 | * Les services de haut niveau impactés ; |
||
78 | * Le numéro de ticket associé ; |
||
79 | * Le statut de sa prise en compte par les opérateurs de supervision. |
||
80 | |||
81 | |||
82 | .. table:: Signification des icônes d'état |
||
83 | |||
84 | +--------+---------------------------------+------------------------------------+ |
||
85 | | Icône | État correspondant pour un hôte | État correspondant pour un service | |
||
86 | +========+=================================+====================================+ |
||
87 | | |img2| | Down (En panne) | Critical (Critique) | |
||
88 | +--------+---------------------------------+------------------------------------+ |
||
89 | | |img3| | Unreachable (Injoignable) | Unknown (Inconnu) | |
||
90 | +--------+---------------------------------+------------------------------------+ |
||
91 | | |img4| | **n/a** | Warning (Avertissement) | |
||
92 | +--------+---------------------------------+------------------------------------+ |
||
93 | | |img5| | Up (Fonctionnel) | OK (OK) | |
||
94 | +--------+---------------------------------+------------------------------------+ |
||
95 | |||
96 | .. |img2| image:: img/down_or_critical.png |
||
97 | |||
98 | .. |img3| image:: img/unreachable_or_unknown.png |
||
99 | |||
100 | .. |img4| image:: img/warning.png |
||
101 | |||
102 | .. |img5| image:: img/up_or_ok.png |
||
103 | |||
104 | |||
105 | Choix d'un thème |
||
106 | ---------------- |
||
107 | Plusieurs thèmes sont disponibles par défaut dans VigiBoard, dont un destiné |
||
108 | aux personnes malvoyantes et un autre prévu pour un usage dans des conditions |
||
109 | de faible luminosité. Un menu déroulant situé en haut de l'interface permet |
||
110 | de passer de l'un à l'autre sans avoir à recharger la page. |
||
111 | |||
112 | .. figure:: img/theme_selection.png |
||
113 | |||
114 | |||
115 | Le réglage du thème est ensuite conservé dans les autres écrans de l'application. |
||
116 | |||
117 | Thème Classique |
||
118 | ^^^^^^^^^^^^^^^ |
||
119 | Le thème *Classique* est utilisé par défaut dans VigiBoard. |
||
120 | Il est particulièrement adapté aux consoles de supervision grâce à son code |
||
121 | couleur qui fait ressortir l'état courant de l'hôte ou du service concerné |
||
122 | par un événement : |
||
123 | |||
124 | * Le rouge indique que l'hôte ou le service concerné est dans un état |
||
125 | critique (hôte en panne, service inopérant, etc.) ; |
||
126 | * Le jaune indique un état dans lequel l'hôte ou le service concerné lève |
||
127 | un avertissement (temps de réponse plus lent que la normale, consommation |
||
128 | excessive de ressources, etc.) ; |
||
129 | * L'absence de couleur signifie un état inconnu (impossibilité de contacter |
||
130 | l'hôte ou de tester l'état du service par exemple) ; |
||
131 | * Le vert représente un état dans lequel l'hôte ou le service concerné est |
||
132 | fonctionnel (état nominal). |
||
133 | |||
134 | |||
135 | .. figure:: img/dashboard.png |
||
136 | |||
137 | Thème Classique |
||
138 | |||
139 | |||
140 | Thème Malvoyant |
||
141 | ^^^^^^^^^^^^^^^ |
||
142 | Ce thème est, comme son nom l'indique, destiné aux personnes malvoyantes |
||
143 | ou souffrant de troubles de perception des couleurs. |
||
144 | L'interface est ainsi épurée et dépourvue de couleurs. |
||
145 | |||
146 | .. figure:: img/dashboard_visually_impaired.png |
||
147 | |||
148 | Thème Malvoyant |
||
149 | |||
150 | |||
151 | Thème Nocturne |
||
152 | ^^^^^^^^^^^^^^ |
||
153 | Le thème *Nocturne* est conçu pour un affichage dans des conditions de faible |
||
154 | luminosité afin notamment de permettre la supervision de nuit. |
||
155 | Ses couleurs ambrées visent ainsi à reposer l'œil de l'opérateur, |
||
156 | mais sont en revanche contre-indiquées en cas de fort éclairage. |
||
157 | |||
158 | .. figure:: img/dashboard_nocturnal.png |
||
159 | |||
160 | Thème Nocturne |
||
161 | |||
162 | |||
163 | Rafraîchissement automatique de la page |
||
164 | --------------------------------------- |
||
165 | Il est parfois souhaitable de rafraîchir régulièrement la page afin de prendre |
||
166 | en compte la détection de nouveaux évènements par Vigilo. |
||
167 | Une case à cocher placée en haut à droite de l'interface permet d'activer |
||
168 | ou de désactiver le rafraîchissement automatique. |
||
169 | |||
170 | .. figure:: img/autorefresh.png |
||
171 | |||
172 | |||
173 | Le texte accompagnant la case à cocher peut varier en fonction de la |
||
174 | configuration retenue par votre administrateur. De même, l'état initial |
||
175 | de cette case à cocher est configuré par l'administrateur. |
||
176 | Ce paramétrage est mémorisé durant toute votre session de consultation de |
||
177 | VigiBoard. Il n'est donc pas nécessaire de le reconfigurer à chaque changement |
||
178 | de page. |
||
179 | |||
180 | .. note:: |
||
181 | Le rafraîchissement automatique est temporairement mis en pause lorsqu'une |
||
182 | boîte de dialogue est affichée à l'écran. Dans ce cas, la case à cocher |
||
183 | reste cochée, mais son effet est inhibée tant que toutes les boîtes de |
||
184 | dialogue affichées à l'écran n'ont pas été refermées. |
||
185 | |||
186 | |||
187 | Réglage de la taille de la police |
||
188 | --------------------------------- |
||
189 | |||
190 | La taille de la police est paramétrable en cliquant sur l'une |
||
191 | des trois icônes représentées ci-dessous et situées elles aussi |
||
192 | en haut à droite de l'interface :: |
||
193 | |||
194 | .. figure:: img/fontsize_selection.png |
||
195 | |||
196 | |||
197 | Trois tailles de polices de caractères sont disponibles : |
||
198 | petite, moyenne, grande. |
||
199 | |||
200 | Filtrage des événements |
||
201 | ----------------------- |
||
202 | Il est possible de restreindre le nombre d'évènements affichés dans le tableau |
||
203 | grâce à l'outil de filtrage de VigiBoard. Celui-ci est accessible en cliquant |
||
204 | sur l'icône ci-dessous, placée en haut à droite de l'interface : |
||
205 | |||
206 | .. figure:: img/search_icon.png |
||
207 | |||
208 | |||
209 | L'outil se présente sous la forme d'une boîte de dialogue permettant de filtrer |
||
210 | les évènements par groupes d'hôtes/services, par noms d'hôte ou de service, |
||
211 | par message d'erreur, par numéro de ticket d'incident, par date de début/fin, |
||
212 | etc. |
||
213 | |||
214 | .. figure:: img/search_form.png |
||
215 | |||
216 | Outil de recherche de VigiBoard. |
||
217 | |||
218 | |||
219 | .. note:: |
||
220 | À noter qu'un mécanisme d'auto-complétion permet de n'avoir à taper |
||
221 | que les trois premières lettres de chaque champ avant de se voir proposer |
||
222 | une liste de choix. L'outil autorise en outre l'utilisation des caractères |
||
223 | jokers ``?`` et ``*`` pour représenter respectivement un caractère |
||
224 | quelconque et une suite de caractères quelconques. |
||
225 | |||
226 | |||
227 | Édition d'un événement |
||
228 | ---------------------- |
||
229 | |||
230 | L'ouverture de la boîte de dialogue d'édition d'un événement se fait |
||
231 | en cliquant sur l'icône ci-dessous, placée à la fin de la ligne de |
||
232 | l'évènement en question :: |
||
233 | |||
234 | .. figure:: img/edit_icon.png |
||
235 | |||
236 | |||
237 | Il est alors possible de modifier l'identifiant du ticket d'incident associé |
||
238 | à cet événement, et de changer l'état d'acquittement de l'évènement |
||
239 | (« Non pris en compte », « Pris en compte », « Fermé »). |
||
240 | |||
241 | Un état supplémentaire est disponible pour les utilisateurs disposant |
||
242 | en plus de la permission d'administration de VigiBoard. Il s'agit de l'état |
||
243 | « Forcer à Fermé ». Lorsque cet état est choisi, l'incident est automatiquement |
||
244 | clos (dans l'historique, le dernier état de l'hôte ou du service concerné |
||
245 | est passé à « OK »). Cette option permet par exemple de traiter le cas où |
||
246 | un équipement qui faisait l'objet d'une alerte a été retiré du parc supervisé. |
||
247 | Étant donné que l'état de cet équipement ne peut plus être interrogé, |
||
248 | il ne pourra jamais repasser à un état nominal et l'événement associé |
||
249 | ne peut pas être supprimé par des méthodes conventionnelles. |
||
250 | |||
251 | .. figure:: img/edit_form.png |
||
252 | |||
253 | Dialogue d'édition d'un évènement. |
||
254 | |||
255 | |||
256 | |||
257 | .. note:: |
||
258 | Notez qu'il est possible d'éditer plusieurs évènements simultanément en |
||
259 | cochant les cases situées à la fin de leurs lignes respectives, puis en |
||
260 | cliquant sur une icône semblable à la précédente, mais située cette fois |
||
261 | à la droite de la ligne d'en-tête du tableau. |
||
262 | |||
263 | .. figure:: img/edit_icon_header.png |
||
264 | |||
265 | .. warning:: |
||
266 | Si vous sélectionnez plusieurs événements et que vous cliquez sur l'icône |
||
267 | d'édition située à la fin de la ligne d'un événement, vous n'éditerez que |
||
268 | les informations se rapportant à cet événement bien précis. |
||
269 | |||
270 | |||
271 | Fonctionnalités avancées |
||
272 | ======================== |
||
273 | En cliquant sur l'icône située au début de la ligne d'un évènement (qui |
||
274 | représente l'état de l'élément supervisé sur lequel cet incident est survenu), |
||
275 | une boîte de dialogue détaillant les informations sur l'évènement en question |
||
276 | s'ouvre. |
||
277 | |||
278 | Dans le premier tiers de cette boîte de dialogue sont visibles l'état initial |
||
279 | et l'état courant de l'événement, ainsi que le pire état de l'élément supervisé |
||
280 | sur lequel l'évènement est survenu. |
||
281 | |||
282 | Le second tiers donne ensuite accès à plusieurs fonctionnalités avancées : |
||
283 | |||
284 | * L'historique détaillé de l'évènement corrélé, c'est à dire en réalité |
||
285 | l'historique de l'évènement brut (alerte) causant cet évènement corrélé |
||
286 | (se rapporter au glossaire pour la distinction entre événements bruts |
||
287 | et corrélés) ; |
||
288 | * La liste des évènements bruts masqués rattachés à cet événement corrélé ; |
||
289 | * L'historique de tous les évènements corrélés survenus sur cet élément |
||
290 | supervisé. |
||
291 | |||
292 | Enfin, le dernier tiers est constitué d'une liste de liens vers des |
||
293 | applications externes, telles que Nagios ou VigiGraph. |
||
294 | |||
295 | .. figure:: img/event_details.png |
||
296 | |||
297 | |||
298 | |||
299 | Historique d'un événement brut |
||
300 | ------------------------------ |
||
301 | Cette page détaille – comme son nom l'indique – l'historique d'un événement |
||
302 | brut, et liste notamment les alertes Nagios successives qui s'y rapportent. |
||
303 | Lorsque cet événement brut est la cause d'un événement corrélé, les |
||
304 | modifications apportées par les opérateurs au statut de l'évènement corrélé |
||
305 | en question sont également visibles. |
||
306 | |||
307 | .. figure:: img/event_history.png |
||
308 | |||
309 | Historique d'un évènement brut. |
||
310 | |||
311 | |||
312 | |||
313 | Liste des évènements bruts masqués |
||
314 | ---------------------------------- |
||
315 | Sur cette page sont affichés tous les évènements bruts rattachés à un événement |
||
316 | corrélé, sans en être la cause directe. Ils sont généralement la conséquence |
||
317 | d'un autre événement brut plus grave, détecté par le corrélateur comme la cause |
||
318 | principale de l'évènement corrélé. |
||
319 | |||
320 | .. figure:: img/masked_events.png |
||
321 | |||
322 | Liste des évènements bruts masqués. |
||
323 | |||
324 | |||
325 | |||
326 | Historique d'un hôte ou d'un service |
||
327 | ------------------------------------ |
||
328 | Cette page permet de visualiser instantanément l'historique complet des |
||
329 | évènements corrélés survenus sur un élément supervisé donné (hôte ou service), |
||
330 | afin par exemple de détecter un problème récurrent. Ces évènements sont triés |
||
331 | par ordre anti-chronologique. |
||
332 | |||
333 | .. figure:: img/supitem_history.png |
||
334 | |||
335 | |||
336 | |||
337 | d5a41c9b | Vincent QUEMENER | Inhibition des alertes |
338 | ------------------------------------ |
||
339 | Cette fonctionnalité permet d'empêcher l'apparition de nouvelles alertes dans |
||
340 | VigiBoard pour un hôte ou un service donné. La page listant les règles |
||
341 | d'inhibition (aussi appelées règles de mise en silence) actives est accessible |
||
342 | en cliquant sur l'icône ci-dessous située en haut à droite de l'interface : |
||
343 | |||
344 | .. figure:: img/silence_rules.png |
||
345 | |||
346 | Les règles sont triées par défaut par ordre décroissant de dernière mise à jour, |
||
347 | comme on peut le voir sur la capture ci-dessous : |
||
348 | |||
349 | .. Capture à ajouter |
||
350 | |||
351 | Depuis cette page, il est alors possible d'éditer ou de supprimer une règle |
||
352 | existante en cliquant sur l'une des deux icônes située en début de ligne : |
||
353 | |||
354 | .. figure:: img/silence_update_delete.png |
||
355 | |||
356 | L'utilisateur est également en mesure d'ajouter une nouvelle règle en cliquant |
||
357 | sur le bouton prévu à cet effet situé juste au-dessus du tableau : |
||
358 | |||
359 | .. figure:: img/silence_add.png |
||
360 | |||
361 | .. note:: |
||
362 | Les alertes déjà traitées (c'est à dire soit déjà ignorées, soit déjà |
||
363 | affichées dans VigiBoard) ne sont pas impactées par les modifications faites |
||
364 | sur les règles (ie. aucun traitement n'est réalisé a posteriori pour générer |
||
365 | des alertes ou pour détruire des alertes déjà présentes). |
||
366 | De même, ce filtrage n'impacte que la production d'alertes, il ne concerne |
||
367 | pas l'état des hôtes/services (donc l'élément peut être ``CRITICAL`` dans |
||
368 | VigiMap mais ne pas avoir d'alarme correspondante dans VigiBoard). |
||
369 | |||
370 | |||
371 | |||
372 | 0075a681 | Francois POIROTTE | Annexes |
373 | ======= |
||
374 | |||
375 | .. include:: ../../turbogears/doc/glossaire.rst |
||
376 | 3afcbc42 | Francois POIROTTE | |
377 | .. vim: set tw=79 : |