Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Scroll Ignore
scroll-pdftrue
scroll-officetrue
scroll-chmtrue
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtrue
scroll-htmltrue
Panel
titleSommaire

Table of Contents
stylenone

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 ).


Panel

Paramétrage

Le check utilise la ligne de commande suivante :

Scroll Title
Code Block
languagetext
themeEmacs
$PLUGINSDIR$/check_shinken_broker_module_report_builder.py -H "$HOSTADDRESS$" -p "$ARG1$" -r "$ARG2$" -m "$ARG3$" --timeout "$_HOSTCHECK_SHINKEN_TIMEOUT$" --shinkenversion "$SHINKENVERSION$"



Données utilisées provenant du modèle

Données communes pour les checks du modèle

Excerpt Include
Modèle shinken
Modèle shinken
nopaneltrue

Données spécifiques pour ce check

Scroll Title
anchordata_for_check_sup_de_sup
NomModifiable sur UnitéDéfautValeur par défaut à l'installation de ShinkenDescription
No Format
BROKER_PORT

Modèle d'hôte

( Onglet Données )

---7772 7772

Configuration du port de communication avec le Broker.

No Format
REPORT_BUILDER_MODULE_NAME

Modèle d'hôte

( Onglet Données )

---broker--module-report-builder broker--module-report-builder

Définition du nom Nom du module sur lequel le module SLA se trouvede rapport pour lequel chercher les informations.

Les données DFE ( Duplicate Foreach )

 

Scroll Title
anchordata_for_check_sup_de_sup
NomModifiable sur UnitéDéfautValeur par défaut à l'installation de ShinkenDescription
No Format
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 à superviser sur le Broker

Données utilisées provenant du check

Pas de données spécifiques pour ce check.

Données globales

Excerpt Include
Documentation sur les packs de supervision
Documentation sur les packs de supervision
nopaneltrue

Propriétés de l'hôte

Excerpt Include
Mise en place du Pack windows
Mise en place du Pack windows
nopaneltrue

Résultat

Exemple

Panel

Interprétation

Statut

Il peut prendre deux 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

  • 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

  • Si supérieur à CHECK_SHINKEN_TIMEOUT par défaut : 3 sec )
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.

Panel

Résumé des rapports en attente de génération

Le check affiche au format texte :

  • le nombre de rapport en attente
  • le temps d'attente moyen pour commencer la génération d'un rapport sur les dernières 24 heures.
Panel

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é ).

Panel

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.


Panel

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 :

Panel

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

Panel

Métriques

Scroll Title
anchorparameter_check_metrics
NomUnitéDescription
No Format
languagetext
themeEmacs
nb_pending_reports
---

Nombre de rapports en attente de génération.

No Format
languagetext
themeEmacs
nb_running_reports
---

Nombre de rapports en cours de génération.

No Format
languagetext
themeEmacs
nb_done_reports_in_last_24h
---

Nombre de rapports générés sur les dernières 24 heures.

No Format
languagetext
themeEmacs
nb_done_reports_in_last_minute
---

Nombre de rapports générés sur la dernière minute.

No Format
languagetext
themeEmacs
next_pending_report_wait_time
seconde

Durée depuis laquelle le prochain rapport dans la liste d'attente est enregistré.

No Format
languagetext
themeEmacs
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.

No Format
languagetext
themeEmacs
average_report_generation_time_in_last_24h
seconde

Temps moyen pour générer un rapport sur les dernières 24 heures.

No Format
languagetext
themeEmacs
work_load_on_builder_in_last_minute
pourcent

Taux d'occupation par une génération de rapport sur la dernière minute.

No Format
languagetext
themeEmacs
reports_per_generation_time_X_Y_s
No Format
languagetext
themeEmacs
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.

X est un entier positif, définissant le début d'un intervalle de temps

Y est un entier positif, définissant la fin de l'intervalle de temps

_s définit l'unité ( seconde )

_and_more définit un intervalle comprenant toutes les valeurs supérieures à X



Exemple

Avec la configuration suivante pour le module :

Code Block
languagejs
themeConfluence
    # ┌─────────────────────────────────────────────────────────────────────────────────────────────────────┐ #
    # │ ────────────────────────────────────────    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 :


Scroll Title
anchorparameter_check_metrics
NomUnitéDescription
No Format
languagetext
themeEmacs
reports_per_generation_time_0_90_s
---

Nombre de rapports dont la génération a pris moins de 90 secondes

No Format
languagetext
themeEmacs
reports_per_generation_time_90_180_s
---

Nombre de rapports dont la génération a pris entre 90 secondes et 180 secondes

No Format
languagetext
themeEmacs
reports_per_generation_time_180_240_s
---

Nombre de rapports dont la génération a pris entre 180 secondes et 240 secondes

No Format
languagetext
themeEmacs
reports_per_generation_time_240_s_and_more
---

Nombre de rapports dont la génération a pris plus de 240 secondes