View Source

Contexte

Le check Files Matching [$KEY$] SIZE by WinRM permet de vérifier la taille des fichiers présents dans un répertoire, en fonction d'un filtre spécifique ou d'une liste de fichiers.

Shinken Entreprise V02.08.02 > Files Matching $KEY$ SIZE by WinRM > 192.168.1.143_7766_elements_hosts_e13fde66341811f1aab1080027a9c43d_tab=checks&shinken_documentation=1 (18).png

Paramétrage

Le check utilise la ligne de commande suivante :

$WINDOWS-BY-WINRM__SHINKEN__PLUGINSDIR$/check_windows_health_by_winrm_rust --check check_files_matching
          --hostname "$HOSTADDRESS$"
          --port "$_HOSTWINDOWS_BY_WINRM__PORT$"
          --username "$_HOSTWINDOWS_BY_WINRM__DOMAINUSER$"
          --password "$_HOSTWINDOWS_BY_WINRM__DOMAINPASSWORD$"
          --auth_method "$_HOSTWINDOWS_BY_WINRM__AUTHMETHOD$"
          --timeout "$_HOSTWINDOWS_BY_WINRM__TIMEOUT$"

          --path "$ARG1$"
          --filter "$ARG2$"

          --size-warn "$ARG3$"
          --size-crit "$ARG4$"
          --size-unit "$ARG5$"

          --recursive "$ARG6$"
          --include_hidden "$ARG7$"

          --kind "size"

Données utilisées provenant du modèle

Données communes pour les checks du modèle

Données spécifiques pour ce check

Nom

Modifiable sur

Valeur par défaut

Description

WINDOWS_BY_WINRM__FILES-MATCHING-SIZE__SIZE-WARN

l'Hôte

( Onglet Données )

100

Taille d'un fichier à partir de laquelle le check passe en statut ATTENTION

Ce seuil est définie par WINDOWS_BY_WINRM__FILES-MATCHING-SIZE__SIZE-WARN ou par la position $ARG3$ de la DFE WINDOWS_BY_WINRM__FILES-MATCHING-SIZE.

WINDOWS_BY_WINRM__FILES-MATCHING-SIZE__SIZE-CRIT

l'Hôte

( Onglet Données )

200

Taille d'un fichier à partir de laquelle le check passe en statut CRITIQUE

Ce seuil est définie par WINDOWS_BY_WINRM__FILES-MATCHING-SIZE__SIZE-CRIT ou par la position $ARG4$ de la DFE WINDOWS_BY_WINRM__FILES-MATCHING-SIZE.

WINDOWS_BY_WINRM__FILES-MATCHING-SIZE__UNIT

l'Hôte

( Onglet Données )

MB

Unité utilisée pour l’affichage des tailles de fichiers ainsi que pour l’évaluation des seuils (SIZE-WARN et SIZE-CRIT).

Valeurs supportées : B , KB , MB , GB ou TB .

L'unité est définie par WINDOWS_BY_WINRM__FILES-MATCHING-SIZE__UNIT ou par la position $ARG5$ de la DFE WINDOWS_BY_WINRM__FILES-MATCHING-SIZE.

Les données DFE ( Duplicate Foreach )

Nom

Modifiable sur

Valeur par défaut

Description

Exemple

WINDOWS_BY_WINRM__FILES-MATCHING-SIZE

l'Hôte

( Onglet Données )

--

Valeur

Explication

Exemple

$KEY$

Nom utilisé pour garantir l'unicité des checks DFE générés.

LOGS

$ARG1$

Répertoire principal à analyser.

C:\shinken

$ARG2$

Filtre à appliquer sur ce répertoire. Il peut prendre deux formes différentes :

un pattern
une liste de noms de fichiers

*.log
[fichier1.log,fichier2.log] ou fichier1.log;fichier2.log

$ARG3$

Seuil à partir duquel le check passe en status ATTENTION .

Hérite de WINDOWS_BY_WINRM__FILES-MATCHING-SIZE__SIZE-WARN.

10

$ARG4$

Seuil à partir duquel le check passe en status CRITIQUE .

Hérite de WINDOWS_BY_WINRM__FILES-MATCHING-SIZE__SIZE-CRIT.

20

$ARG5$

Unité utilisée pour l'affichage ainsi que pour l'évaluation des seuils.

Hérite de WINDOWS_BY_WINRM__FILES-MATCHING-SIZE__UNIT.

B, KB, MB, GB ou TB.

$ARG6$

Active ou désactive la recherche récursive dans le répertoire principal. Il peut accepter 2 types de données :

un booléen
un nombre entier

true/ false
Note : À "true", le check analysera le répertoire et tous ses dossiers jusqu'à la profondeur maximale.
3 (Le check analysera le répertoire et ses dossiers à une profondeur maximale de 3).

$ARG7$

Active ou désactive la prise en compte des fichiers cachés.

true/ false

Mode pattern :

LOGS$(C:\shinken)$(*.log)$$(10)$$(20)$$(MB)$$(true)$$(true)$

Mode l ist :

LOGS$(C:\shinken)$([fichier1.log,fichier2.log])$$(10)$$(20)$$(MB)$$(true)$$(true)$

Si aucune valeur n'est renseignée pour un $ARGn$ sur un check, la valeur définie sur la donnée associée dont il hérite est utilisée à la place. Cette donnée peut à son tour avoir sa propre valeur par défaut.

Tous les checks DFE générés à partir du modèle NEW_PAGE - SPAC-27 - windows-by-WinRM__files-one-property-per-check héritent de ses valeurs par défaut. Cela implique que :

Effet global : tant que $ARGn$ n'est pas renseigné sur une instance, celle-ci lit la variable hôte définie par le modèle. Si plusieurs instances laissent $ARGn$ vide, elles partagent toutes la même valeur. Modifier la variable hôte (ou la valeur par défaut du modèle) se répercute donc sur toutes les instances qui n'ont pas renseigné $ARGn$.
Comportement spécifique à une instance : la seule façon de donner à une instance un comportement différent est de renseigner explicitement le $ARGn$ concerné sur cette instance. Toucher au modèle ou à la variable host ne permet pas de différencier une instance des autres — ça déplace seulement la valeur partagée.

Exemple — $ARG5$ (unité) du check Files Matching [$KEY$] SIZE :

Si $ARG5$ n'est pas renseigné sur l'instance, le modèle utilise la variable host WINDOWS_BY_WINRM__FILES-MATCHING-SIZE__UNIT.
Si cette variable n'est pas définie, elle prend sa propre valeur par défaut, MB.
Conséquence : plusieurs instances générées sans $ARG5$ utiliseront toutes MB. Pour qu'une instance particulière utilise GB, il faut renseigner $ARG5$ = GB sur cette instance ; modifier WINDOWS_BY_WINRM__FILES-MATCHING-SIZE__UNIT à GB ferait basculer toutes les instances sans surcharge à GB.

Données utilisées provenant du check

Pas de données provenant du check

Résultat

Exemple

Shinken Entreprise V02.08.02 > Files Matching $KEY$ SIZE by WinRM > 192.168.1.143_7766_elements_hosts_e13fde66341811f1aab1080027a9c43d_tab=checks&shinken_documentation=1 (18).png

Interprétation

Statut

Il peut prendre quatre valeurs OK / CRITIQUE / ATTENTION / INCONNU .
- Le statut dépend du retour de sonde et de la configuration spécifique du check pour les données suivantes :
  - WINDOWS_BY_WINRM__FILES-MATCHING-SIZE__SIZE-WARN ou DFE position $ARG3$
  - WINDOWS_BY_WINRM__FILES-MATCHING-SIZE__SIZE-CRIT ou DFE position $ARG4$
- Voici un tableau récapitulatif du statut attendu suivant le retour de sonde :

Le texte de la colonne "Affichage des seuils" montre les paramètres utilisés et leur valeur définie sur l'équipement supervisé.

Shinken Entreprise V02.08.02 > Files Matching $KEY$ SIZE by WinRM > 192.168.1.143_7766_elements_hosts_ef5baa62341c11f1a0db080027a9c43d_tab=checks&shinken_documentation=1 (1).png

Situation

Statut

Exemple

Au moins un fichier dépasse la taille définie par WINDOWS_BY_WINRM__FILES-MATCHING-SIZE__SIZE-WARN (ou DFE $ARG3$)

ATTENTION

Shinken Entreprise V02.08.02 > Files Matching $KEY$ SIZE by WinRM > 192.168.1.143_7766_elements_hosts_e13fde66341811f1aab1080027a9c43d_tab=checks&shinken_documentation=1 (17).png

Au moins un fichier dépasse la taille définie par WINDOWS_BY_WINRM__FILES-MATCHING-SIZE__SIZE-CRIT (ou DFE $ARG4$ )

CRITIQUE

Shinken Entreprise V02.08.02 > Files Matching $KEY$ SIZE by WinRM > 192.168.1.143_7766_elements_hosts_e13fde66341811f1aab1080027a9c43d_tab=checks&shinken_documentation=1 (14).png

Aucun fichier ne correspond au filtre dans le répertoire ciblé

CRITIQUE

Shinken Entreprise V02.08.02 > Files Matching $KEY$ SIZE by WinRM > 192.168.1.143_7766_elements_hosts_ef5baa62341c11f1a0db080027a9c43d_tab=checks&shinken_documentation=1.png

Mode liste — au moins un fichier attendu est absent du répertoire ciblé

CRITIQUE

Shinken Entreprise V02.08.02 > Files Matching $KEY$ SIZE by WinRM > 192.168.1.143_7766_elements_hosts_e13fde66341811f1aab1080027a9c43d_tab=checks&shinken_documentation=1 (15).png

Résultat

Selon le statut, une ou plusieurs lignes :

CRITIQUE : N fichier(s) dépasse(nt) la taille critique (≥ V unité).
ATTENTION : N fichier(s) dépasse(nt) la taille d'avertissement (≥ V unité).
OK : Tous les fichiers ont une taille acceptable.
Mode liste, si au moins un fichier manquant : ligne supplémentaire en tête N fichier(s) manquant(s).
0 fichier trouvé (mode pattern) : Aucun fichier trouvé correspondant à '<filtre>' dans '<chemin>'.

Le détail fichier par fichier est dans le Résultat Long.

Résultat Long

Affiche un tableau arborescent par sévérité (Critical puis Warning) avec pour chaque fichier dépassant un seuil sa taille dans l'unité définie (ex : 150.25 MB).

En mode liste ($ARG3$ sous la forme [fichier1.log, fichier2.log, ...]), le résultat long est toujours émis :

Une table MISSING en tête si au moins un nom de la liste est absent du répertoire.
Puis, pour les fichiers présents, les tables Critical/Warning normales si des seuils sont dépassés.

Métriques

Définition

Nom	Unité	Description	Seuil d'avertissement	Seuil critique
files_size_(NOM_FICHIER)	B	Retourne la taille en octets de chaque fichier détecté.	WINDOWS_BY_WINRM__FILES-MATCHING-SIZE__SIZE-WARN	WINDOWS_BY_WINRM__FILES-MATCHING-SIZE__SIZE-CRIT
files_total_size_(CONTEXTE)	B	Retourne la taille totale en octets de l'ensemble des fichiers détectés. CONTEXTE est composé du répertoire supervisé et du filtre utilisé.	—	—

Exemple

Shinken Entreprise V02.08.02 > Files Matching $KEY$ SIZE by WinRM > 192.168.1.143_7766_elements_hosts_e13fde66341811f1aab1080027a9c43d_tab=checks&shinken_documentation=1 (16).png

Contexte

Paramétrage

Données utilisées provenant du modèle

Données communes pour les checks du modèle

Données spécifiques pour ce check

Les données DFE ( Duplicate Foreach )

Données utilisées provenant du check

Résultat

Exemple

Interprétation

Statut

Résultat

Résultat Long

Métriques

Définition

Exemple

Erreurs et pré-requis