Contexte
Le check Broker - $KEY$ - Module Report Builder - Performance permet de suivre l'utilisation qui est faite du module broker--module-report-builder ( voir la page Module broker--module-report-builder ) au niveau du démon Broker ( voir la page Le Broker ).
Paramétrage
Le check utilise la ligne de commande suivante :
$PLUGINSDIR$/check_shinken_broker_module_report_builder.py -H "$HOSTADDRESS$" -p "$ARG1$" -r "$ARG2$" -m "$ARG3$" --timeout "$_HOSTCHECK_SHINKEN_TIMEOUT$" --shinkenversion "$SHINKENVERSION$" -n "$_HOSTNB_LINE_UNAVAILABILITY$"
Données utilisées provenant du modèle
Données communes pour les checks du modèle
| Nom | Modifiable sur | Unité | Défaut | Valeur par défaut à l'installation de Shinken | Description |
|---|---|---|---|---|---|
CHECK_SHINKEN_TIMEOUT | l'Hôte ( Onglet Données ) | seconde | 3 | 3 | Temps maximum durant lequel le check va attendre une réponse du démon. |
Données spécifiques pour ce check
| Nom | Modifiable sur | Unité | Défaut | Valeur par défaut à l'installation de Shinken | Description |
|---|---|---|---|---|---|
BROKER_PORT | Modèle d'hôte ( Onglet Données ) | --- | 7772 | 7772 | Configuration du port de communication avec le Broker. |
REPORT_BUILDER_MODULE_NAME | Modèle d'hôte ( Onglet Données ) | --- | broker--module-report-builder | broker--module-report-builder | Nom du module de rapport pour lequel chercher les informations. |
NB_LINE_UNAVAILABILITY | l'Hôte ( Onglet Données ) | --- | 5 | 5 | Nombre des dernières configurations reçues, ainsi que le temps d'indisponibilité du module causé par leur réception à afficher dans le résultat long.. |
Les données DFE ( Duplicate Foreach )
| Nom | Modifiable sur | Unité | Défaut | Valeur par défaut à l'installation de Shinken | Description |
|---|---|---|---|---|---|
MODULE_REPORT_BUILDER_LIST | l'Hôte ( Onglet Données ) | --- | broker-master-broker--module-report-builder$($_HOSTBROKER_PORT$)$$($_HOSTREPORT_BUILDER_MODULE_NAME$)$$($_HOSTREPORT_BUILDER_MODULE_SLA_MODULE_NAME)$ | broker-master-broker--module-report-builder$($_HOSTBROKER_PORT$)$$($_HOSTREPORT_BUILDER_MODULE_NAME$)$ | Liste de modules de rapport à superviser sur le Broker. |
Données utilisées provenant du check
Pas de données spécifiques pour ce check.
Données globales
Nom | Modifiable sur | Unité | Défaut | Valeur par défaut à l'installation de Shinken | Description |
|---|---|---|---|---|---|
PLUGINSDIR | Non modifiable ( Sauf Admin Shinken ) | --- | /var/lib/shinken/libexec | /var/lib/shinken/libexec | Chemin absolu du dossier contenant la sonde ( non modifiable ). |
SHINKENVERSION | Non modifiable | --- | --- | --- | Numéro de version du shinken utilisé pour la comparaison avec le shinken surveillé. |
Propriétés de l'hôte
l'Hôte ( Onglet Général ) --- Adresse de l'hôteNom Modifiable sur Unité Défaut Valeur par défaut à l'installation de Shinken Description HOSTADDRESS
Nom de l'hôte Nom de l'hôte
Résultat
Exemple
Interprétation
Statut
Il peut prendre les valeurs OK / CRITIQUE / ATTENTION / INCONNU .
- Le statut va dépendre du retour de sonde et de la configuration spécifique du check pour les données suivantes :
- CHECK_SHINKEN_TIMEOUT
- CHECK_SHINKEN_TIMEOUT
Voici un tableau récapitulatif du statut attendu suivant le retour de sonde :
Les vérifications spécifiques
Situation | Statut |
|---|---|
Le module broker--module-report-builder n'est pas présent sur le Broker, ou son nom ne correspond pas. | CRITIQUE |
Le Broker est en cours d'arrêt. | ATTENTION |
Si la sonde n'a pas eu de réponse avant le temps maximum :
| INCONNU |
Résultat
Charge de travail du module
Le check remonte le taux d'occupation par une génération de rapport sur la dernière minute.
Résumé des rapports en attente de génération
Le check affiche au format texte :
- le nombre de rapports en attente ;
- le temps d'attente moyen pour commencer la génération d'un rapport sur les dernières 24 heures ;
Lorsqu'il y a des rapports en attente de génération, le check affiche également depuis combien de temps patiente le prochain rapport dans la liste ( au moment où le check est exécuté ).
Statistiques des générations de rapports effectuées
Le check affiche au format texte :
- le nombre de rapports générés sur les dernières 24 heures ;
- le temps moyen pour générer un rapport sur les dernières 24 heures ;
Résultat Long
Ce check va afficher deux tableaux :
- un top 5 des demandes de rapports,
- un récapitulatif des durées de génération des rapports sur les dernières 24 heures.
Le top des requêtes va indiquer :
- l'utilisateur à l'initiative de la demande de rapport,
- le format demandé ( WEB ou CSV ),
- le type de rapport demandé ( History, SLA ou History & SLA ),
- la requête de filtrage,
- l'intervalle de recherche,
- le nombre d'éléments trouvés,
- le temps d'attente ( entre l'heure de la demande et le début effectif de la génération ),
- le temps de génération du rapport,
- la date de génération du rapport.
Le récapitulatif des durées de génération des rapports va regrouper les temps mis pour créer les rapports selon les intervalles définis dans la configuration du module ( voir la page Module broker--module-report-builder ) pour les dénombrer.
Description des erreurs
Le module n'a pas été trouvé sur le Broker
Lorsqu'il est impossible de trouver un module de génération de rapport avec le bon nom sur le Broker, le check le remonte comme une erreur :
Le Broker est en cours d'arrêt
Lorsque le Broker est en cours d'arrêt, le check le signale, et les informations relatives au module ne sont plus disponibles :
Métriques
| Nom | Unité | Description |
|---|---|---|
nb_pending_reports | --- | Nombre de rapports en attente de génération. |
nb_running_reports | --- | Nombre de rapports en cours de génération. |
nb_done_reports_in_last_24h | --- | Nombre de rapports générés sur les dernières 24 heures. |
nb_done_reports_in_last_minute | --- | Nombre de rapports générés sur la dernière minute. |
next_pending_report_wait_time | seconde | Durée depuis laquelle le prochain rapport qui sera traité est dans la liste d'attente. |
average_report_pending_time_in_last_24h | seconde | Temps d'attente moyen pour commencer la génération d'un rapport sur les dernières 24 heures. |
average_report_generation_time_in_last_24h | seconde | Temps moyen pour générer un rapport sur les dernières 24 heures. |
work_load_on_builder_in_last_minute | % | Taux d'occupation par une génération de rapport sur la dernière minute. |
reports_per_generation_time_X_Y_s reports_per_generation_time_X_s_and_more | --- | Ces métriques représentent la répartition du temps de génération de rapports. Le nombre de métriques générées va dépendre de la configuration du module, comme expliqué dans l'onglet Résultat Long.
|
Exemple
Avec la configuration suivante pour le module :
# ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
# │ ──────────────────────────────────────── STATISTICS ───────────────────────────────────────── │ #
# └─────────────────────────────────────────────────────────────────────────────────────────────────────┘ #
# ─── Ranges definition for the performance check ───
# ───
# Default : 5,10,20,30,60,120,300,600 ( seconds ) ───
# ─── ───
broker__module_report_builder__exec_stats_ranges 90, 180, 240
Les métriques suivantes seront générées :
| Nom | Unité | Description |
|---|---|---|
reports_per_generation_time_0_90_s | --- | Nombre de rapports dont la génération a pris moins de 90 secondes. |
reports_per_generation_time_90_180_s | --- | Nombre de rapports dont la génération a pris entre 90 secondes et 180 secondes. |
reports_per_generation_time_180_240_s | --- | Nombre de rapports dont la génération a pris entre 180 secondes et 240 secondes. |
reports_per_generation_time_240_s_and_more | --- | Nombre de rapports dont la génération a pris plus de 240 secondes. |