Recopilar información de depuración con sosreport

Container-Optimized OS incluye la utilidad sosreport, que recopila información a pedido para ayudarte a depurar problemas en una instancia de máquina virtual de Container-Optimized OS. La información se recopila y almacena de forma local en el sistema de archivos de la instancia. Google no recopila ni almacena estos datos en ninguna parte.

Si abres un caso de asistencia con la asistencia deGoogle Cloud debido a problemas con tu instancia, es posible que se te solicite que proporciones los datos de sosreport como parte de la investigación. En esta página, se muestra cómo recopilar esta información.

Nota: Crear el informe consume recursos de CPU y memoria, y el almacenamiento del informe consume espacio en el disco y recurso de ancho de banda E/S del disco en el nodo. La cantidad de recursos consumidos no se puede estimar con facilidad.

Nota: Cuando se solucionan problemas de disponibilidad y de inicio de nodos, puede ser difícil recopilar sosreport. La reparación automática del nodo finalizará y volverá a crearlo después de un tiempo de indisponibilidad. Consulta Cómo inhabilitar la reparación automática de nodos si no se puede realizar la recopilación de sosreport antes de que la reparación automática cierre el nodo. Si no se puede inhabilitar la reparación automática porque el clúster está en el canal de versiones, comunícate con Atención al cliente de Cloud para obtener ayuda.

El resultado de sosreport se almacena sin encriptación en un archivo .tar.xz. El archivo puede contener información de identificación personal (PII), ya que recopila datos de muchos componentes críticos del sistema (p. ej., journald). El archivo se puede inspeccionar en la instancia y la mayor parte del contenido está en texto sin formato. La herramienta de sosreport es de código abierto y puedes revisar su código.

Recopila los datos del informe

Para generar un sosreport, haz lo siguiente:

1. Conéctate a la instancia con el comando gcloud compute ssh.

   gcloud compute ssh [INSTANCE_NAME] --zone [ZONE] --project [PROJECT_ID]
   

2. Verifica la versión del SO:

   sudo cat /etc/os-release| egrep -w 'NAME|VERSION'
   

   El resultado es similar a este:

   NAME="Container-Optimized OS"
   VERSION=105
   

3. Ejecuta el comando sos que corresponda a la versión de tu SO:

COS 85 y versiones anteriores

Ejecuta el siguiente comando sosreport para recopilar los registros:

sudo sosreport --all-logs --batch --tmp-dir=/var

Si el comando anterior falla con sosreport: command not found, instala el paquete sosreport y, luego, ejecuta el comando sosreport anterior:

sudo toolbox
sudo apt install sosreport -y

COS 105 y versiones posteriores

Ejecuta el siguiente comando sos para recopilar los registros:

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

Si el comando anterior falla con sos: command not found, instala el paquete sosreport y, luego, ejecuta el comando sos report anterior:

sudo toolbox
sudo apt install sosreport -y

Ubuntu 18 y versiones anteriores

Ejecuta el siguiente comando sosreport para recopilar los registros:

sudo sosreport --all-logs --batch --tmp-dir=/var

Si el comando anterior falla con sosreport: command not found, instala el paquete sosreport y, luego, ejecuta el comando sosreport anterior:

sudo apt install sosreport

Ubuntu 20 y versiones posteriores

Ejecuta el siguiente comando sos para recopilar los registros:

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

Si el comando anterior falla con sos: command not found, instala el paquete sosreport y, luego, ejecuta el comando sos report anterior:

sudo apt install sosreport

Puedes cambiar el directorio en el que se almacena el informe si pasas un directorio diferente a la opción --tmp-dir. También puedes editar el comportamiento predeterminado del comando si editas /etc/sos.conf en la instancia.

El resultado se almacena en un archivo .tar.xz en el directorio que especificas con la opción --tmp-dir. La ubicación y la suma de verificación del archivo .tar.xz se muestran en STDOUT.

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

The checksum is: 5a8b97c6020346a688254c8b04ef86ec

Visualiza los datos recolectados

El informe es propiedad de root y no lo puede leer otros usuarios. Usa los siguientes comandos a fin de cambiar el propietario a tu usuario actual y hacer que sea legible para ti. No lo hagas legible en todo el mundo.

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

Luego, si deseas ver el contenido del informe en el nodo, ejecuta el siguiente comando:

tar xvf $TARBALL

Los archivos de informes individuales ahora están disponibles en un directorio en la misma ubicación que .tar.xz. Puedes ver los registros con comandos como less o puedes usar comandos como grep para encontrar información en ellos.

Nota: Si planeas compartir el informe con Google, no modifiques ningún archivo del informe. Si tienes que modificar algunos archivos, también cuéntanos qué se modificó cuando compartes el informe.

Descargue el informe

Para descargar el informe en tu máquina local, usa el comando gcloud compute scp:

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