Collecter des informations de débogage à l'aide de sosreport

Container-Optimized OS inclut l'utilitaire sosreport qui collecte des informations à la demande pour vous aider à résoudre les problèmes liés à une instance de machine virtuelle Container-Optimized OS. Les informations sont collectées et stockées localement sur le système de fichiers de l'instance. Google ne collecte ni ne stocke ces données ailleurs.

Si vous ouvrez une demande d'assistance auprès de l'assistance Google Cloud en raison de problèmes liés à votre instance, vous devrez peut-être fournir les données sosreport dans le cadre de l'enquête. Cette page vous explique comment collecter ces informations.

Remarque : La création du rapport consomme des ressources de processeur et de mémoire, et son stockage consomme des ressources de bande passante d'espace disque et d'E/S disque sur le nœud. La quantité de ressources consommées ne peut pas être estimée facilement.

Remarque : Lors de la résolution des problèmes de disponibilité et de démarrage des nœuds, collecter sosreport peut s'avérer difficile. La réparation automatique des nœuds s'arrête et recrée le nœud après un certain temps d'indisponibilité. Consultez la page Désactiver la réparation automatique de nœud si la collecte sosreport ne peut pas être effectuée avant que le nœud ne soit arrêté par la réparation automatique. Si la réparation automatique ne peut pas être désactivée, car le cluster est en version disponible, contactez le service client Cloud pour obtenir de l'aide.

Le résultat de sosreport est stocké sans chiffrement dans une archive .tar.xz. L'archive peut contenir des informations personnelles, car elle collecte des données à partir de nombreux composants critiques du système (par exemple, journald). L'archive peut être inspectée sur l'instance, et la plupart du contenu est en texte brut. L'outil sosreport est Open Source, et vous pouvez examiner son code.

Collecter les données sosreport

Pour créer un rapport, connectez-vous en SSH à l'instance de machine virtuelle appropriée à l'aide de la commande gcloud compute ssh:

gcloud compute ssh [INSTANCE_NAME]

Exécutez ensuite la commande sosreport suivante:

sudo sos report --all-logs --batch --tmp-dir=/var

Remarque :Pour Container-Optimized OS 85 et les versions antérieures, sosreport peut être collecté à l'aide de la commande sudo sosreport --all-logs --batch --tmp-dir=/var.

Vous pouvez modifier le répertoire dans lequel le rapport est stocké en transmettant un autre répertoire à l'option --tmp-dir. Vous pouvez également modifier le comportement par défaut de la commande en modifiant /etc/sos.conf sur l'instance.

Le résultat est stocké dans un fichier .tar.xz dans le répertoire que vous spécifiez à l'aide de l'option --tmp-dir. L'emplacement et la somme de contrôle du fichier .tar.xz sont affichés sur STDOUT.

Your sosreport has been generated and saved in:
  /var/sosreport-cos-20181106231224.tar.xz

The checksum is: 5a8b97c6020346a688254c8b04ef86ec

Afficher les données collectées

Le rapport appartient à root et n'est pas lisible par les autres utilisateurs. Exécutez les commandes suivantes pour remplacer le propriétaire par votre utilisateur actuel et pour le rendre lisible par vous. Ne le rendez pas lisible publiquement.

TARBALL=[PATH/TO/TARBALL]
sudo chown $(whoami) $TARBALL
chmod +r $TARBALL

Ensuite, si vous souhaitez afficher le contenu du rapport sur le nœud, vous pouvez l'extraire en exécutant la commande ci-dessous :

tar xvf $TARBALL

Les fichiers de rapport individuels sont désormais disponibles dans un répertoire au même emplacement que le .tar.xz. Vous pouvez afficher les journaux à l'aide de commandes telles que less, et vous pouvez utiliser des commandes telles que grep pour y rechercher des informations.

Remarque : Si vous prévoyez de partager le rapport avec Google, veuillez ne modifier aucun des fichiers du rapport. Si vous devez modifier certains fichiers, lors du partage du rapport veuillez également nous indiquer ce qui a été modifié.

Télécharger le rapport

Pour télécharger le rapport sur votre ordinateur local, utilisez la commande gcloud compute scp :

gcloud compute scp $(whoami)@[INSTANCE_NAME]:[PATH/TO/FILE] [LOCAL/PATH/TO/DIRECTORY]