Workbooks Azure : comment réaliser ses propres dashboards

Cet article fait partie d’une série de publications sur le composant de dashboarding dans Azure : les Workbooks. Je vous invite donc à lire la première partie de cette série qui présente ce composant et les templates intégrés dans Azure.

Dans ce deuxième volet, nous allons voir comment créer des Workbooks entièrement customisés en partant d’un template vierge pour qu’ils représentent aux mieux les KPIs essentiels de votre projet.

Comme dans le premier article, nous prenons un contexte de Modern Integration avec la supervision d’une plateforme d’intégration AIS (Azure Integration Service) pour illustrer cet article.

Création d’un Workbook

Dans un premier temps, nous allons voir comment créer un Worbook dans Azure. Dans le menu de gauche de chaque composant se trouve une partie « Monitoring » dans laquelle se trouvent les Workbooks.

En haut de page, il est possible de retrouver dans la partie « Quick Start » les templates pour créer des Workbooks. Il en existe deux :

• Default Template: qui comporte un exemple de query et un texte de présentation.
• Empty : qui est un template complètement vide.

En choisissant le template Empty, nous arrivons sur un Workbook totalement vierge de contenu.

Une fois le Workbook sauvegardé, il est possible par la suite de le trouver, comme l’ensemble des Workbooks que vous aurez créés, dans la partie WorkBooks :

Maintenant que nous avons initialisé notre Workbook, il faut le compléter avec les différents éléments que nous allons voir ci-dessous pour mettre en évidence les divers KPIs.

Création de query et manipulation

Les queries nous permettent de requêter les différents logs que l’on a collectés sur le composant auquel le Workbook est rattaché.

Dans notre exemple, nous allons voir dans le cadre du monitoring de nos APIs, d’où les utilisateurs nous appellent, les performances des temps de réponse de nos APIs et les tendances d’appels pour les différents pays au cours des derniers jours.

Ci-dessous, l’exemple de requête qui va nous permettre d’avoir les informations nécessaires pour exposer nos KPIs :

Cette query se déroule en plusieurs étapes. D’abord, avec la fonction “make-series”, on crée le tableau du nombre d’appels par heure en fonction du pays d’appel, puis nous faisons une première jointure pour obtenir le nombre total d’appels. Nous continuons avec une deuxième jointure pour récupérer les temps de traitement moyen, minimum et maximum toujours par pays. La requête se termine par une agrégation de toutes ces données pour en faire un tableau en sortie.

Dans notre query nous allons donc insérer cette requête comme suit :

On peut constater que le résultat qui est affiché est brut et difficilement lisible dans notre dashboard : c’est pour cela que Microsoft nous propose des outils afin d’améliorer la présentation de nos résultats, grâce à l’option Column Settings.

Il est possible de formater le texte affiché : nous allons les formater les durées affichées en indiquant le type que nous affichons (moyenne, maximum, minimum…) ainsi que l’unité de mesure (ici en millisecondes).

Nous allons aussi présenter graphiquement notre colonne Trend (qui montre la tendance des appels dans le temps), en transformant la colonne en graphique.

L’ensemble de ces manipulations permet de rendre le résultat beaucoup plus lisible comme on le constate ci-dessous :

Ce tableau nous permet de voir en un coup d’œil les tendances d’appels que l’on reçoit pour les différents pays et leurs temps de réponse. On peut alors ajuster la capacité des ressources ou leur location en fonction de l’activité de nos APIs.

Voyons à présent nos autres sources de KPIs : les métriques, des informations orientées sur les évènements qui ont lieu sur les divers composants.

Création de métriques

Les métriques sont des collectes d’évènements qui ont lieu sur la plateforme sur la consommation des ressources (CPU, le temps moyen de réponse, mémoire…), la santé de la plateforme (HealthCheck statut…), etc.

Dans notre exemple, nous allons montrer les types de code retour de nos APIs et leur nombre. Pour cela, après avoir ajouté un Metric à notre dashboard, il nous faut sélectionner la métrique que l’on veut afficher dans Add metric et sélectionner la métrique désirée.

Ce graphique permet de voir rapidement le taux de succès/échec des requêtes dans nos APIs, ce qui peut rapidement mettre en lumière, en cas de nombre d’erreurs très important, un incident sur l’un des composants. En corrélation avec notre premier graphique, il peut aussi servir à suivre le comportement de notre plateforme lors de périodes de pic d’activité.

Grâce aux queries et aux métriques, nous avons vu les deux outils à notre disposition pour afficher les KPIs clé de notre plateforme. Nous allons maintenant voir comment rendre le Workbook moins figé et plus interactif et clair avec les paramètres et les outils d’ajout de textes.

Création de paramètres

Afin de rendre le Workbook plus interactif, nous pouvons créer des paramètres qui seront utilisés dans une ou plusieurs queries.

Nous allons l’illustrer en créant un paramètre de type « Time range picker » qui nous permettra de choisir la durée dans laquelle nous voudrons montrer les résultats de notre requête.

Pour créer le paramètre, il faut sélectionner puis cliquer sur « Add parameters ». Un volet s’ouvrira ensuite où l’on pourra renseigner le nom, le type et les différentes configurations telles que le caractère obligatoire du paramètre ou les valeurs possibles.

Une fois le paramètre sauvegardé, nous pourrons l’utiliser dans les queries. Si nous reprenons notre exemple précédent, il faudra ajouter notre paramètre d’intervalle de temps comme suit :

Maintenant que nous avons rendu notre Workbook plus dynamique grâce aux paramètres, nous allons travailler sur la clarté de notre Workbook en y ajoutant du texte (pour des explications, illustrations ou commentaires) et le mettre en forme pour simplifier la lecture des KPIs présentés dans le Workbook.

Manipulation de textes

Tout d’abord, regardons comment mettre du texte pour illustrer notre dashboard. Pour cela, à l’endroit du workbook où nous voulons ajouter du texte, il faut choisir l’option d’ajout de texte, puis écrire le texte que l’on veut : il peut s’agir d’un titre, une explication, ou un commentaire… Il est également possible de prévisualiser le texte qui sera affiché grâce à l’option « Preview ».

Pour la mise en page, il faut utiliser l’option de markdown. Pour aller plus loin sur ces options, je vous invite à lire la notice complète.

Maintenant que nous avons abordé et ajouté l’ensemble des principales fonctionnalités des Workwooks, celui qui nous a servi d’exemple tout le long de cet article ressemble à cela :

Azure Workbook : l’essentiel à retenir

Nous avons vu dans cet article les diverses possibilités que nous offrent les templates vierges pour montrer les KPIs clés, que ce soit sur la bonne santé de votre plateforme ou sur les données qui sont traitées.

Avec cet article se conclut la série sur les Azure WorkBooks qui permettent avec un time to market très rapide de mettre en place une suite de dashboards complets montrant les KPIs clés de vos projets et la bonne santé de votre écosystème dans Azure. Bien que cette solution de Dashboarding soit limitée à une audience ayant accès au portail Azure, il est pour nous un outil de mise en place de Dahsboarding clé pour le monitoring de la plateforme grâce à ces nombreuses fonctionnalités et sa facilité de mise en place, car ce composant est déjà intégré à bon nombre de composants Azure.

Vous souhaitez en savoir plus sur le sujet ? Consultez nos autres articles de cette série :

• “Monitoring sur Azure : automatiser l’exploitation des logs et mettre en place les alertes“.
• Workbooks Azure : l’outil de Dashboarding intégré à Azure

Nos experts sont à votre écoute si vous souhaitez être accompagné dans votre transformation numérique : contactez-nous !