Contexte

Le check Memory by API permet de superviser l’utilisation de la mémoire allouée aux conteneurs actifs sur une instance Docker.

Il interroge, pour chaque conteneur détecté, le pourcentage d’utilisation mémoire à un instant donné ( valeur instantanée ).


Par défaut, un conteneur Docker n'est pas limité en mémoire. Il peut consommer autant de mémoire que la machine virtuelle a à disposition. Dans ce cas, le pourcentage d'utilisation mémoire reflète la disponibilité mémoire sur le serveur entier.

Si le conteneur Docker a été limité, le pourcentage d'utilisation reflétera la disponibilité mémoire dans la limite de ce que le conteneur peut consommer.

Exemple pour un serveur avec 8GB de mémoire : 

  • conteneur non limité
    • 500Mo consommé = 6.25% d'utilisation
  • Conteneur limité à 1 GB
    • 500Mo consommé = 50% d'utilisation


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

  • Si l’utilisation mémoire dépasse les seuils définis ( warning ou critical ), alors le statut du check change automatiquement.


Ce check permet :

  • de repérer rapidement une surcharge mémoire sur l’instance Docker,

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

  • d’identifier un processus fortement consommateur,

  • ou d’anticiper une saturation mémoire.


En résumé, ce check fournit une alerte rapide sur l’état mémoire global des conteneurs Docker.

Paramétrage

Le check utilise la ligne de commande suivante :

$SHINKEN_DOCKERBYAPI_PLUGINSDIR$/check_docker.py 
	--connection "$HOSTADDRESS$":"$_HOSTDOCKER-BY-API__PORT$" 
	--memory "$_HOSTDOCKER-BY-API__MEMORY__MEMORY-WARN$":"$_HOSTDOCKER-BY-API__MEMORY__MEMORY-CRIT$":"$_HOSTDOCKER-BY-API__MEMORY__MEMORY-UNIT$"

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__MEMORY__MEMORY-CRIT

l'Hôte

( Onglet Données )

%90 90

Définit le pourcentage d'utilisation mémoire à partir duquel le check passe en CRITIQUE .

  • Il suffit que le pourcentage d'un des conteneurs franchisse ce seuil pour que le check change d'état.
DOCKER-BY-API__MEMORY__MEMORY-WARN

l'Hôte

( Onglet Données )

%80 80

Définit le pourcentage d'utilisation mémoire à partir duquel le check passe en ATTENTION .

  • Il suffit que le pourcentage d'un des conteneurs franchisse ce seuil pour que le check change d'état.
DOCKER-BY-API__MEMORY__MEMORY-UNIT

l'Hôte

( Onglet Données )

--%%

Définit l'unité de mesure de la mémoire.

Les valeurs disponibles sont : %, B, MB, GB

Données DFE ( Duplicate Foreach )

Pas de données DFE pour ce check

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 4 valeurs  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-BY-API__MEMORY__MEMORY-WARN 
      • DOCKER-BY-API__MEMORY__MEMORY-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
  • La consommation mémoire dépasse la valeur de :
    • DOCKER-BY-API__MEMORY__MEMORY-WARN  
 ATTENTION

  • La consommation mémoire dépasse la valeur de :
    • DOCKER-BY-API__MEMORY__MEMORY-CRIT

CRITIQUE


Résultat

Le résultat court affiche la liste des conteneurs détectés.

Pour chaque conteneur, la mémoire utilisée est indiquée dans l’unité définie dans le paramètre DOCKER-BY-API__MEMORY__MEMORY-UNIT ( ex : MB, GB ).

Résultat Long

Pas de résultat long pour ce check.

Métriques

Interprétation des métriques

Nom de la métriqueUnitéDescriptionSeuil d'avertissementSeuil critique
(nom-du-container)_memory_consumed%Retourne le pourcentage de mémoire utilisé au cours par le conteneur ( Correspond au % afficher dans le résultat du check ).

DOCKER-BY-API__MEMORY__MEMORY-WARN 

DOCKER-BY-API__MEMORY__MEMORY-CRIT

Exemple

Erreurs et pré-requis