Shinken Web UI version 2

Posted by Frédéric MOHIER on 15 Sep 2015 in Shinken | 0 comments

Après plusieurs mois sans activité, la nouvelle version de l’interface Web de Shinken a été publiée il y a quelques jours et mise à disposition de la communauté sur le site shinken.io. Cette nouvelle version est une refonte quasi complète de l’application Web UI (User Interface) qui améliore et enrichit les fonctionnalités des versions précédentes :

• interface utilisateur moderne et responsive compatible avec la majorité des Web browsers
• consultation en temps réel des données du framework Shinken (hosts, services, contacts, groups, timeperiods, …)
• application opérationnelle dès l’installation
• gestion des utilisateurs et de leur rôle
• filtrage performant des ressources de supervision (hosts/services)
• tactical views: worldmap, minemap, disponibilité, logs, …

Dans la suite de cet article, nous reviendrons sur les principales fonctionnalités de l’interface Shinken Web UI.

Nouvelle version

Pourquoi une refonte plutôt que des évolutions ? Moderniser l’interface Web de Shinken nécessitait l’utilisation de composants logiciels plus récents apportant également des possibilités fonctionnelles plus riches … nous avons fait le choix de ne pas toucher à l’architecture existante, de conserver le micro serveur Web Bottle et de migrer toute l’interface utilisateur vers Bootstrap 3, puis de construire une interface moderne, performante et facile à utiliser sur cette base.

Parmi les principes qui ont guidé cette nouvelle version, nous voulions mettre l’accent sur plusieurs points essentiels :

• la disponibilité de cette interface sur le plus grand nombre de terminaux : du smartphone au desktop …
• la simplicité d’installation : idéalement, installer le module webui doit suffire pour que l’interface soit fonctionnelle et disponible …
• la simplicité d’utilisation et la clarté de l’interface : une interface épurée et claire qui permet de comprendre d’un coup d’oeil …
• la richesse des fonctionnalités : pouvoir consulter tous les éléments, filtrer, disposer de vues adaptées, …

Cet article présente uniquement les principales fonctionnalités de l’interface Web UI de Shinken sans rentrer dans le détail. Il introduit également ce que nous appelons nos killer features.

J’espère pouvoir rédiger, par la suite, des articles plus ciblés sur certaines fonctionnalités pour faire découvrir aux lecteurs toute la richesse de cette nouvelle version.

Principales fonctionnalités

Gestion des utilisateurs

Qui dit interface utilisateur, dit utilisateurs, login et donc authentification.

Login page Shinken WebUI

Quelle que soit la méthode d’authentification utilisée, un utilisateur habilité à se connecter à l’interface   est forcément un contact connu du framework Shinken. Il sera, une fois connecté, un administrateur ou un simple utilisateur.

La nouvelle version de la Web UI dispose de ses propres modules d’authentification et, de ce fait, il n’est plus nécessaire d’installer, de base, des modules pour autoriser le login d’un utilisateur dans l’interface.

L’authentification peut se faire par la simple vérification d’un mot de passe dans les propriétés du contact, par la vérification d’un mot de passe crypté dans un fichier de type Apache htpasswd ou par l’authentification mise en place par un serveur Web en front-end de la Web UI.

D’autres méthodes d’authentification sont disponibles sous la forme de modules externes installables dans la Web UI : authentification Active Directory, authentification auprès de GLPI.

Dashboard

Dès sa connexion acceptée, l’utilisateur accède à l’application dans le dashboard qui lui présente tous les éléments avec lesquels il a une relation en tant que contact de Shinken. S’il est administrateur, il a la vision de tous les éléments sans nécessairement qu’une relation existe.

Dashboard page Shinken WebUI

Les principaux éléments présentés permettent d’obtenir rapidement une vue de l’état général du système supervisé par Shinken. Une synthèse des états des hôtes, services, problèmes et impacts et présentée au dessus d’un ensemble de widgets personnalisables que l’utilisateur peut positionner et configurer pour se créer une vue personnelle.

Problèmes

La page des problèmes, accessible par le menu Problems, présente la liste filtrée de toutes les ressources supervisées par Shinken.

Problems page Shinken Web UI

Toutes les ressources présentes sur cette page sont filtrées selon différents critères modifiables par l’utilisateur:

• type de ressource: host ou service
• état de l’hôte et/ou du service
• appartenance à un groupe
• criticité (propriété business_impact)
• …

Des filtres prédéfinis sont disponibles et les filtres construits par l’utilisateur peuvent être mémorisés dans des bookmarks pour être réutilisés par la suite.

La page se rafraîchit périodiquement pour actualiser les données présentées et notifier les nouveaux problèmes détectés. L’utilisateur, s’il en a les droits, peut agir sur chaque élément présenté dans la liste par l’intermédiaire de boutons d’actions: soumettre un résultat de check, acquitter un problème, programmer un downtime, … Ainsi, les problèmes notifiés par Shinken sont pris en charge, au fur et à mesure, de leur apparition.

Consultation d’un host/service

La page de consultation d’un élément (element view) présente toutes les informations connues de Shinken sur un élément, que ce soit un hôte ou un service d’un hôte. Les informations sont regroupées par catégorie dans des onglets.

Element page Shinken Web UI – information tab

Les principales données présentées sur cette page :

• les informations générales sur l’host/service
• les variables de configuration (customs)
• les métriques reçues dans les perfdata
• le graphe des dépendances
• l’historique des logs
• …

Depuis cette page, l’utilisateur peut lancer des commandes sur l’élément consulté. Les principales commandes :

• acquitter un problème
• relancer un check
• programmer une maintenance (downtime)
• activer / désactiver les checks ou les notifications

Note: la richesse du contenu de cette page ne peut pas être présentée en quelques lignes …

Killer features

Au delà du simple relooking, quelques « killer features » ont été introduites dans cette nouvelle version pour améliorer l’expérience utilisateur. Cet article ne présente que quelques unes de ces killer features, mais il n’est pas inintéressant de les citer pour vous donner envie de jeter un œil : minemap, worldmap, custom view, … de prochains articles à venir présenteront ces fonctionnalités.

Filtrage et groupes

Comme évoqué précédemment, un outil de filtrage performant a été intégré dans la Web UI. Mais ce n’est pas tout, la Web UI prend en compte également :

• les groupes : hostgroups, servicegroups et contactgroups
• les tags (templates) des hosts et services
• le niveau de criticité (business_impact)

Grâce à ces fonctionnalités, l’utilisateur peut ainsi affiner la vision qu’il souhaite avoir des ressources supervisées.

Quelques exemples de filtres :

• les problèmes des hosts membre du groupe windows-servers et portant le tag http
• les hosts qui sont actuellement en maintenance (downtime scheduled)
• les services WARNING et ACK qui sont en relation avec le contact admin

Tous les filtres peuvent être mémorisés dans des bookmarks que l’utilisateur pourra retrouver lors de sa prochaine connexion. Les bookmarks peuvent également être mis à disposition des autres utilisateurs de l’application.

Logs et disponibilité

L’application met à disposition des utilisateurs les logs produits par le framework Shinken ainsi qu’un calcul de disponibilité simplifié pour les hosts supervisés. Ces informations sont accessibles aux administrateurs pour leur permettre de consulter l’état de fonctionnement de Shinken et des hosts supervisés.

Les logs sont également disponibles sous la forme d’un historique dans la vue d’un élement. Pour un hôte, l’historique présentera les derniers logs disponibles pour l’hôte et ses services. Pour un service, l’historique ne présentera que les derniers logs du service.

La disponibilité d’un host est également consultable dans un onglet de cette page sous la forme de graphiques.

Note: Cette fonctionnalité est disponible dans la WebUI grâce à l’utilisation du nouveau module mongo-logs installé dans le broker de Shinken.

La suite …

Maintenant que cette nouvelle interface est disponible et déjà en cours de test par certains d’entre vous, que sera la suite ?

Nous prévoyons déjà de sortir prochainement une version 2.1 pour laquelle nous mettrons l’accent sur quelques nouvelles fonctionnalités pour enrichir encore l’interface utilisateur :

• une timeline pour les hosts/services
• un enrichissement de la worldmap
• de nouvelles fonctionnalités de filtrage

Et, enfin, last but not least, nous comptons sur de nombreux retours d’utilisateurs pour améliorer cette nouvelle interface et en faire un outil qui réponde le mieux possible aux besoins des utilisateurs.