Contexte

Le check Status by API permet de superviser l’état du conteneur spécifié sur l'instance Docker.

Il interroge son état à un instant donné ( running, exited, etc. ).


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

  • Si l’état du conteneur est différent de celui attendu, le statut du check évolue automatiquement.


Ce check permet :

  • de détecter rapidement un comportement anormal d’un conteneur,

  • de signaler un arrêt inattendu,

  • ou de confirmer que les services sont bien actifs.


En résumé, ce check est utile pour assurer la continuité des services via une surveillance simple et efficace de l’état d’exécution de conteneur.

Paramétrage

Le check utilise la ligne de commande suivante :

$SHINKEN_DOCKER-BY-API_PLUGINSDIR$/check_docker.py 
	--connection "$HOSTADDRESS$":"$_HOSTDOCKER-BY-API__PORT$" 
	--status "$_HOSTDOCKER-BY-API__STATUS__WAITING-STATUS$" 
	--containers "$ARG1$"

Données utilisées provenant du modèle

Données communes pour les checks du modèle

Données spécifiques pour ce check

NomModifiable surUnitéDéfautValeur par défaut à l'installation de ShinkenDescription
DOCKER-BY-API__STATUS__WAITING-STATUS

l'Hôte

( Onglet Données )

--running running

Définit l'état attendu pour les conteneurs.  Un état différent fera passer le check en CRITIQUE .

  • Il suffit que l'état d'un des conteneurs diffère 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-BY-API__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és par Shinken.

SHINKEN_DOCKER-BY-API_VENDOR

Non modifiable

( Sauf Admin Shinken )

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

Dossier fournit par shinken.

SHINKEN_DOCKER-BY-API_PACKNAME

Non modifiable

( Sauf Admin Shinken )


docker-by-API__shinken docker-by-API__shinken

Dossier contenant les sondes.

SHINKEN_DOCKER-BY-API_PLUGINSDIR

Non modifiable

( Sauf Admin Shinken )

--
$USERPLUGINSDIR$/$SHINKEN_DOCKER-BY-API_VENDOR$/$SHINKEN_DOCKER-BY-API_PACKNAME$
 /var/lib/shinken-user/libexec/shinken-additional-packs/docker-by-API__shinken

Chemin absolu du dossier contenant les sondes du pack docker-by-API__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 3 valeurs  OK / CRITIQUE / INCONNU .

    • Le statut va dépendre du retour de sonde et de la configuration spécifique du check pour les données suivantes :

      • DOCKER-BY-API__STATUS__WAITING-STATUS

    • 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
  • L'état du conteneur n'est pas égale à :
    • DOCKER-BY-API__STATUS__WAITING-STATUS

CRITIQUE


Résultat

Le résultat court indique si l’état remonté correspond ou non à l’état attendu ( vérification booléenne ).

L'état attendu par défaut est "running" et peut être modifié avec la donnée "DOCKER-BY-API__STATUS__WAITING-STATUS"

Résultat Long

Pas de résultat long pour ce check.

Métriques

Pas de métriques pour ce check.

Erreurs et pré-requis