Contexte

Le check Health by API permet de superviser l’état de santé ( health status ) du conteneur spécifié sur l'instance Docker, basé sur les checks “HEALTHCHECK” définis dans la configuration Docker.


Le check interroge, pour chaque conteneur supervisé :

  • s’il possède un check health actif,

  • et quel est son état de santé à un instant donné.


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

  • Si un conteneur est en état unhealthy, alors le statut du check passe à warning ou critical, selon les paramètres définis.


Ce check permet :

  • de détecter rapidement un service applicatif non-fonctionnel,

  • de confirmer qu’un conteneur “vivant” est réellement opérationnel,

  • de cibler les conteneurs dont l’application interne est partiellement ou totalement indisponible.

En résumé, ce check offre une supervision plus fine, en s’appuyant sur les mécanismes internes de Docker pour valider le bon fonctionnement interne du conteneur, au-delà de sa simple exécution.


Un check health est une commande déclarée dans le Dockerfile ou via les options de lancement du conteneur ( --health-cmd ), permettant d’évaluer régulièrement si l’application à l’intérieur du conteneur fonctionne correctement.
Il repose généralement sur des tests simples : ping HTTP, connexion à un port, vérification de fichier, etc.

Docker exécute cette commande à intervalles réguliers ( paramétrables via --health-interval, --health-retries, etc. ).
En fonction du résultat, Docker attribue au conteneur un état parmi les suivants :

  • starting (le conteneur est en cours de test, suite à son lancement),

  • healthy (le test a réussi),

  • unhealthy (le test a échoué plusieurs fois de suite).

Paramétrage

Le check utilise la ligne de commande suivante :

$SHINKEN_DOCKER-BY-API_PLUGINSDIR$/check_docker.py 
	--connection "$HOSTADDRESS$":"$_HOSTDOCKER-BY-API__PORT$" 
	--health 
	--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

Pas de données spécifiques pour ce check

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.

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


Situation Statut Exemple
  • L'état du healthcheck n'est pas ' Healthy '

CRITIQUE


  • Le conteneur ne possède pas de healthcheck

UNKNOWN

Résultat

Le résultat court affiche l’état retourné par le check health. Généralement indiqué par les valeurs : starting, healthy, ou unhealthy.

Résultat Long

Pas de résultat long pour ce check.

Métriques

Pas de métriques pour ce check.