Rapports

Il existe plusieurs options pour attribuer un contexte aux rapports, c'est-à-dire pour les remplir avec les données provenant d'ordinateurs hôtes et de services spécifiques. Par conséquent, les rapports doivent être appelés de différentes manières afin de contenir des informations pertinentes. Si le contexte est manquant, c'est-à-dire si vous ne précisez pas quels ordinateurs hôtes et services doivent être inclus dans le rapport, vous n'obtiendrez pas le résultat escompté, mais uniquement des messages d'erreur surlignés en rouge :

La différence réside dans l'endroit où le contexte est spécifié :

Réfléchissez à nouveau au snap-in « Reporting » mentionné ci-dessus : celui-ci vous amène directement aux rapports générés sans aucune présélection ni restriction supplémentaire, etc. — par conséquent, seuls les rapports disposant d’un contexte intégré ont réellement un sens ici. Les rapports dont le contexte est uniquement créé via des vues (filtrées) peuvent donc être exclus en toute sécurité du menu « Monitor » ainsi que du snap-in via l’option « Hide this report in the monitor menu ».

Vous pouvez utiliser les fonctions suivantes pour l'édition de vos propres rapports :

Une description des différentes options disponibles figure dans les sections suivantes.

Les choses se compliquent légèrement si vous souhaitez créer un rapport entièrement nouveau plutôt qu’une copie d’un rapport existant. À titre d’exemple, vous allez créer ci-dessous un aperçu simple de tous les services problématiques sur votre site, c’est-à-dire tous les services dont le statut est « WARN », « CRIT » ou « UNKNOWN ». Cet aperçu sera intitulé « critical_services ».

Vous créez un nouveau rapport sur la page Edit Reports via Reports > Add report.

Dans un premier temps, laissez le filtre « Select specific object type » sur la sélection « No restrictions to specific objects » et passez directement à la page de sélection suivante avec « » et « Continue ».

Comme pour la copie d'un rapport existant, spécifiez d'abord une Unique ID et une Title :

Dans la section « Context / Search Filters », sous « Service », sélectionnez maintenant « Service states », puis, en cliquant sur « Add filter », vous pouvez définir les états souhaités :

Avec l'option « » (Créer un rapport) et « Save & go to list » (Nouveau rapport), le nouveau rapport sera ajouté à la section « Customized » (Rapports créés) de la liste d'aperçu des rapports.

Si vous ouvrez maintenant ce rapport avec une joyeuse anticipation, le résultat est décevant. La page du rapport présente une mise en page initiale ainsi qu'un en-tête, mais elle est par ailleurs vide. Ce n'est pas exactement le résultat qui impressionnera votre patron…​

Vous devez donc maintenant définir la mise en page du contenu du rapport. L' vous mènera à la page permettant de définir le contenu à inclure dans le rapport. La sélection des éléments du rapport s'effectue en trois étapes, chacune étant séparée par un clic sur Continue.

Commencez par cliquer sur Add content. Pour cet exemple, sous Step 1, sélectionnez le type d’élément Availability table. Définissez Step 2 sur All services et Step 3 sur No restrictions to specific objects. Laissez les autres options de la page suivante inchangées pour le moment. Cliquez plutôt directement sur Save. Affichez maintenant la vue de votre rapport :

À gauche, vous pouvez voir l'aperçu, ici pour le rapport de critical_services. À droite, les éléments du rapport sont affichés sous forme de liste. Ces éléments peuvent être édités, copiés, supprimés et réorganisés.

Vous pouvez désormais personnaliser de manière flexible ce rapport simple que vous avez créé vous-même en y ajoutant des éléments supplémentaires selon vos besoins (voir ci-dessous) et le consulter à tout moment, par exemple depuis la barre latérale.

À presque chaque étape de la création d'un rapport, il est possible d'adapter le contenu à vos besoins.

Dans un premier temps, vous pouvez définir un filtre et limiter le rapport à un ordinateur hôte ou une source de données spécifique, tels que des interfaces réseau, des agrégations BI, des capteurs, etc.

Ensuite, saisissez à nouveau l’Unique ID et l’Title. Pour le titre, vous pouvez également utiliser les macros fournies (= modules de texte). Choisissez ensuite une Icon sous laquelle le rapport doit apparaître dans les menus. En définissant l’option « Make this report available for other users » sur le groupe de contact, par exemple « check-mk-notify », vous donnez aux membres du groupe associé la possibilité d’accéder au rapport de manière autonome à tout moment et d’obtenir des informations par eux-mêmes.

Dans la zone « Context / Search Filters », comme d'habitude, de nombreuses options de filtrage sont disponibles, allant d'ordinateurs hôtes spécifiques à des conteneurs Docker individuels, en passant par des valeurs issues de la supervision Oracle.

Dans cet exemple, la sélection des ordinateurs hôtes est limitée à un dossier et, en outre, à des problèmes d’ordinateurs hôtes spécifiés. Cette restriction accélère la récupération des données, en particulier dans les environnements plus complexes.

En cliquant sur « Save & go to list », vous accédez à l'aperçu du rapport. L'étape suivante consiste à définir le contenu du rapport.

En utilisant l', vous accédez au contenu du rapport :

Ouvrez l'édition du contenu du rapport à l'aide de l'Reports > Add content. Utilisez cet outil pour ajouter, par exemple, des tableaux, des graphiques, des tables des matières ou du texte (également via des macros ou HTTP) au rapport. Ces éléments apparaissent les uns après les autres et déterminent ainsi la longueur finale du rapport.

Dans Step 1, sélectionnez l'élément souhaité, par exemple Multiple graphs. Vous obtiendrez ainsi, en fonction de vos autres paramètres, plusieurs graphiques du même type disposés les uns sous les autres. Vous pouvez par exemple réaliser une affectation directe entre les états des ordinateurs hôtes.

Poursuivez avec Continue. En tant que source de données pour les graphiques, pour cet exemple, à l'étape 2, sélectionnez All services, c'est-à-dire tous les services en cours d'exécution sur les ordinateurs hôtes :

Poursuivez avec Continue. À l'étape 3, vous pouvez désormais limiter le volume de données à afficher. Cette option n'est pas nécessaire pour l'exemple actuel. Passez à nouveau à la sélection suivante avec Continue.

Pour l'exemple de rapport, sous « Graph layout », dans la case « Properties », indiquez que vous souhaitez attribuer un titre à chacun des graphiques, comprenant le titre du graphique, le nom de domaine et la description du service. De plus, définissez la période affichée sur quatre heures sous « Graph time range ».

Dans la case « Context / Search Filters », vous limitez le rapport aux caractéristiques d’ordinateur hôte ou de service spécifiées. Ici, vous sélectionnez « CPU utilization » pour « Service » dans cet exemple.

En cliquant sur « Save », vous avez terminé le premier élément du rapport.

Pour le deuxième graphique de cet exercice, recommencez par « Reports > Add content » et, dans « Step 1 », sélectionnez « Metrics graph of a single service ». Passez à « Step 2 » avec « » et « Continue », puis limitez les filtres de recherche au nom de domaine et à la description du service :

En cliquant sur Save, le deuxième élément du rapport sera désormais également prêt.

Le troisième élément à créer est un aperçu des alertes actuelles. La procédure reste la même :

En cliquant sur Save, cet élément de rapport est également terminé.

Pour clarifier l'affichage, ajoutez des en-têtes :

Ouvrez « Reports > Add content » pour modifier le contenu du rapport. Dans « Step 1 », sélectionnez « Heading » comme type d'élément. Passez à « Step 2 » avec « » Continue. Vous pouvez également spécifier un niveau hiérarchique pour l'en-tête. Saisissez l'en-tête dans « The text ».

Cliquez sur Save pour revenir à l’aperçu. Cependant, le nouvel en-tête sera désormais positionné sous les graphiques dans la liste. Dans la liste des éléments de contenu, utilisez donc l’icône pour faire glisser l’en-tête vers la position souhaitée dans la liste.

Astuce : dans l’aperçu, vous pouvez voir des lignes rouges et des messages d’erreur à la place des données réelles, car à ces endroits, le rapport dans l’éditeur manque de contexte, ici, par exemple, la spécification d’un ordinateur hôte qui ne serait révélée qu’en appelant le rapport depuis une vue de la table appropriée. Si vous souhaitez voir un aperçu exploitable, il vous suffit de filtrer un ordinateur hôte spécifique dans les paramètres du rapport, dans la zone « Context / Search Filters » (Configuration du rapport). Cela facilite grandement la conception du rapport.

Des éléments de conception complémentaires sont disponibles pour structurer l’apparence du rapport, tels qu’une ligne horizontale, une image, un cadre de page et une ligne de texte unique. Vous pouvez afficher ces éléments sur toutes les pages ou sur des pages spécifiques de votre rapport.

Pour le rapport d'exemple, insérez un cadre autour du rapport. Une fois encore, la définition s'effectue étape par étape, chacune se poursuivant en cliquant sur « ». Commencez par « Reports > Add page element ».

Étant donné que le cadre doit être visible sur toutes les pages, l'étape suivante ne nécessite aucune modification :

Le nouveau cadre de page s'affiche désormais dans l'aperçu, à la fois dans l'aperçu à gauche et dans le tableau des éléments de page statiques à droite.

Astuce : vous pouvez également utiliser les macros (= modules de texte) disponibles dans Checkmk, par exemple pour créer un autre pied de page avec les numéros de page et le nom du rapport. Pour ce faire, sélectionnez l'élément de page « One line of text » et, à l'étape suivante, indiquez la position en bas de la page ainsi que le texte incluant les macros souhaitées :

Les rapports sont immédiatement plus attrayants et présentent un aspect de meilleure qualité, par exemple avec l'ajout du logo de l'entreprise.

Ouvrez les paramètres du rapport via Reports > Edit properties :

Dans la deuxième case, vous trouverez l'élément Report Properties. C'est là que vous configurez les paramètres relatifs à la police, au format de page, à l'heure et à la date, à la mise en page du rapport et au nom de fichier pour les téléchargements.

Copiez le logo de votre entreprise dans le répertoire « ~/local/share/check_mk/reporting/images/ » et enregistrez-le sous le nom « logo_mk.png ». Désormais, ce logo s’affichera sur tous les rapports.

Remarque : pour l'instant, vous personnalisez le modèle de rapport existant en fonction de vos besoins. Vous pouvez également créer un tout nouveau modèle de rapport complet, conforme aux spécifications de votre entreprise, afin de refléter l'identité visuelle de celle-ci (CI/CD), par exemple.

Ouvrez une nouvelle planification à l'aide de Scheduled reports > Add schedule, puis sélectionnez le rapport et cliquez sur Continue.

Dans la case de dialogue « General Options », vous définissez les paramètres de base tels que le titre, l'heure de création, la période de reporting, etc.

Sous « Context / Search Filters », vous trouverez les options de filtrage habituelles, en fonction du rapport sélectionné. Enregistrez ensuite la planification pour revenir à la liste de vos rapports planifiés.

Dans cette liste, vous trouverez également des informations sur la dernière fois où le rapport a été généré/envoyé, s’il y a eu une erreur, la date à laquelle il sera généré/envoyé la prochaine fois, ainsi que d’autres informations (présentées ici sous forme légèrement abrégée) :

Les éléments de la liste sont gérés à l'aide des cinq icônes situées au début de chaque élément :

Remarque : les rapports qui ont été envoyés ne sont pas stockés sur l’instance.

Au lieu d'envoyer le rapport, vous pouvez également l'enregistrer localement. Pour ce faire, sélectionnez «Action - Store locally » :

Indiquez ensuite un nom de fichier et, si vous le souhaitez, un titre pour le rapport. Pour pouvoir constituer un historique des rapports — Checkmk fournit diverses macros (= modules de texte) afin d’éviter de remplacer la version précédente du rapport à chaque nouvelle création.

Vous pouvez accéder à l'aperçu de tous les rapports enregistrés localement dans la fenêtre «Edit Reports» via l'entrée «Reports > Stored reports»:

Les éléments de contenu s'affichent lorsque vous sélectionnez «Reports > Add content» lors de l'édition d'un rapport.

Les éléments de page sont répertoriés lorsque vous sélectionnez «Reports > Add page element» lors de l'édition d'un rapport.