Sommaire

Contexte

Le check [$KEY$] Status by SSH permet de vérifier le status du conteneur sélectionné.

Il remonte, pour celui-ci, le status constaté par docker au moment de la vérification.


Plusieurs statuts existent et peuvent être remontés par un conteneur, mais seul le statut "running" assure que le conteneur fonctionne de manière optimale. Le changement de statut repose donc sur une seule règle :

  • Si l’état du conteneur n'est pas "running", le check remontera en warning ou critique ( Basé sur la gravité du status remonté )


Ce check permet donc :

  • de détecter rapidement un comportement anormal,

  • de signaler un arrêt inattendu,

  • de confirmer que les services sont bien actifs.

Pour résumer, ce check est un indicateur clé pour vérifier le fonctionnement normal d'un groupe de 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 "status"
	-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

Pas de données spécifique pour ce check

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.

    • Voici un tableau récapitulatif du statut attendu suivant le retour de sonde :

Situation Statut Exemple
  • Le status est différent de "running" ET de gravité intermédiaire.

ATTENTION

  • Le status est différent de "running" ET de gravité élevée.

CRITIQUE


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

INCONNU

Résultat

Le résultat court affiche, en une ligne, un résumé du status. 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 statut du conteneur.

Métriques

Pas de métriques pour ce check.

Erreurs et pré-requis

Error rendering macro 'excerpt-include'

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