Sommaire

Contexte

Le check [$KEY$] Restarts by SSH permet de vérifier le nombre de restarts effectués par un conteneur.

Quand un conteneur Docker rencontre une erreur, il arrive que celui-ci se relance automatiquement pour tenter de résoudre l'erreur rencontrée. Dans certains cas, l'erreur ne se corrige pas et le conteneur va redémarrer continuellement.


Le changement de statut repose sur une seule règle :

  • Si le nombre de redémarrages du conteneur dépasse les seuils définis ( warning ou critical ), alors le statut du check évolue automatiquement.
  • Les redémarrages provenant d'une action volontaire de l'utilisateur ne sont pas pris en compte par ce check.


Ce check permet donc :

  • de repérer rapidement si le conteneur est instable,

  • d’identifier si le conteneur est mal configuré,

  • de repérer une anomalie empêchant l’exécution continue du service.

Pour résumer, ce check est un indicateur utile pour assurer la stabilité des conteneurs.

Paramétrage

Le check utilise la ligne de commande suivante :

$SHINKEN_DOCKER-ON-LINUX-BY-SSH_PLUGINSDIR$/check_docker_SSH.py 
	-H "$HOSTADDRESS$"
	-u "$_HOSTDOCKER-ON-LINUX-BY-SSH__SSH-USER$"
	-p "$_HOSTDOCKER-ON-LINUX-BY-SSH__SSH-PORT$"
	-k "$_HOSTDOCKER-ON-LINUX-BY-SSH__SSH-KEY$"
	-x "$_HOSTDOCKER-ON-LINUX-BY-SSH__SSH-PASSPHRASE$"
	-m "restarts"
	-w "$_HOSTDOCKER-ON-LINUX-BY-SSH__RESTARTS__RESTARTS-WARN$"
	-c "$_HOSTDOCKER-ON-LINUX-BY-SSH__RESTARTS__RESTARTS-CRIT$"
	-s "$ARG1$"

Données utilisées provenant du modèle

Données communes pour les checks du modèle

NomModifiable surUnitéDéfautValeur par défaut à l'installation du packDescription
DOCKER-ON-LINUX-BY-SSH__SSH-PORT

l'Hôte

( Onglet Données )

--

22

22

Port de connexion SSH.

_DOCKER-ON-LINUX-BY-SSH__SSH-USER

l'Hôte

( Onglet Données )

--

user-service-shinken

user-service-shinken

Nom de l'utilisateur pour se connecter sur le serveur supervisé.

_DOCKER-ON-LINUX-BY-SSH__SSH-KEY

l'Hôte

( Onglet Données )

--

/var/lib/shinken/.ssh/id_rsa

/var/lib/shinken/.ssh/id_rsa

Chemin vers la clé SSH privée de l'utilisateur   shinken, sur le serveur hébergeant le Poller qui exécutera le check. 

  • Cette clé doit être présente dans les clés autorisées du  compte utilisateur utilisé pour se connecter  sur le serveur Linux supervisé (  voir la donnée SSH_USER ci-dessous ) .
_DOCKER-ON-LINUX-BY-SSH__SSH-PASSPHRASE

l'Hôte

( Onglet Données )

--

$SSH_KEY_PASSPHRASE$

$SSH_KEY_PASSPHRASE$

Phrase secrète utilisée pour déchiffrer la clé privée de l'utilisateur (  si celle-ci est protégée par une passphrase  ). La clé privée déchiffrée est ensuite utilisée pour authentifier l'utilisateur.

Données spécifiques pour ce check

NomModifiable surUnitéDéfautValeur par défaut à l'installation de ShinkenDescription
DOCKER-ON-LINUX-BY-SSH__RESTARTS__RESTARTS-CRIT

l'Hôte

( Onglet Données )

--10 10

Définit le nombre de restarts à partir duquel le check passe en CRITIQUE.

  • Il suffit qu'il franchisse ce seuil pour que le check change d'état.
DOCKER-ON-LINUX-BY-SSH__RESTARTS__RESTARTS-WARN

l'Hôte

( Onglet Données )

--5 5

Définit le nombre de restarts à partir duquel le check passe en ATTENTION.

  • Il suffit qu'il franchisse ce seuil pour que le check change d'état.

Données DFE ( Duplicate Foreach )

NomModifiable sur UnitésDéfautValeur par défaut à l'installation de ShinkenDescription
DOCKER-ON-LINUX-BY-SSH__CONTAINERS

l'Hôte

( Onglet Données )

---containers1$(containers1)$ containers1$(containers1)$

Nom du ou des conteneurs ( séparés par une virgule ), exemple "prod01$(prod01)$,php$(php)$".

Check(s) impacté(s) :

Données utilisées provenant du check

Pas de données provenant du check pour ce modèle

Données globales

NomModifiable surUnitéDéfautValeur par défaut à l'installationDescription
USERPLUGINSDIR

Non modifiable

( Sauf Admin Shinken )

--/var/lib/shinken-user/libexec /var/lib/shinken-user/libexec

Chemin absolu contenant les sondes installées par Shinken.

SHINKEN_DOCKER-ON-LINUX-BY-SSH_VENDOR

Non modifiable

( Sauf Admin Shinken )

--shinken-additional-packs shinken-additional-packs

Dossier fourni par Shinken.

SHINKEN_DOCKER-ON-LINUX-BY-SSH_PACKNAME

Non modifiable

( Sauf Admin Shinken )


docker-on-linux-by-SSH__shinken docker-on-linux-by-SSH__shinken

Dossier contenant les sondes.

SHINKEN_DOCKER-ON-LINUX-BY-SSH_PLUGINSDIR

Non modifiable

( Sauf Admin Shinken )

--
$USERPLUGINSDIR$/$SHINKEN_DOCKER-ON-LINUX-BY-SSH_VENDOR$/$SHINKEN_DOCKER-ON-LINUX-BY-SSH_PACKNAME$
/var/lib/shinken-user/libexec/shinken-additional-packs/docker-on-linux-by-SSH__shinken

Chemin absolu du dossier contenant les sondes du pack docker-on-linux-by-SSH__shinken  ( non modifiable ).

Propriétés de l'hôte

NomModifiable surUnitéDéfautValeur par défautDescription
HOSTADDRESS

l'Hôte

( Onglet Général )

--

Nom de l'hôte Nom de l'hôte

Adresse de l'hôte

Résultat

Exemple

Interprétation des données

Statut

  • Il peut prendre 4 états 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 :

      • DOCKER-ON-LINUX-BY-SSH__RESTARTS__RESTARTS-WARN 
      • DOCKER-ON-LINUX-BY-SSH__RESTARTS__RESTARTS-CRIT
    • 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é.

Situation Statut Exemple
  • Le nombre de restarts dépasse la valeur de :
    • DOCKER-ON-LINUX-BY-SSH__RESTARTS__RESTARTS-WARN 
ATTENTION

  • Le nombre de restarts dépasse la valeur de :
    • DOCKER-ON-LINUX-BY-SSH__RESTARTS__RESTARTS-CRIT

CRITIQUE

  • Le conteneur spécifié dans la donnée "DOCKER-ON-LINUX-BY-SSH__CONTAINERS" n'as pas été trouvé

INCONNU

Résultat

Le résultat court affiche, en une ligne, un résumé de l'état du conteneur. Ce retour compact permet de pouvoir visualiser l'information même avec la taille des lignes réduites dans l'interface de visualisation.

Résultat Long

Le résultat long affiche un tableau affichant le nombre de restarts enregistrés sur le conteneur.

Métriques

Interprétation des métriques

Nom de la métriqueUnitéDescriptionSeuil d'avertissementSeuil critique
(nom-du-container)_restarts nb_restartsRetourne le nombre de restart non intentionnels effectués par un conteneur depuis sa mise en fonctionnement.

DOCKER-ON-LINUX-BY-SSH__RESTARTS__RESTARTS-WARN 

DOCKER-ON-LINUX-BY-SSH__RESTARTS__RESTARTS-CRIT

Exemple

Erreurs et pré-requis

Error rendering macro 'excerpt-include'

User 'null' does not have permission to view the page.