Supervisar el estado

Las instancias de Workbench de Gemini Enterprise Agent Platform proporcionan varios métodos para supervisar el estado de los notebooks. En esta página, se describe cómo usar cada método.

Métodos para supervisar el estado

Puedes supervisar el estado de tus instancias de Agent Platform Workbench de diferentes maneras. En esta página, se describe cómo usar los siguientes métodos:

Antes de comenzar

  1. Accede a tu cuenta de Google Cloud . Si eres nuevo en Google Cloud, crea una cuenta para evaluar el rendimiento de nuestros productos en situaciones reales. Los clientes nuevos también obtienen $300 en créditos gratuitos para ejecutar, probar y, además, implementar cargas de trabajo.

  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  3. Verify that billing is enabled for your Google Cloud project.

  4. Enable the Notebooks API.

    Roles required to enable APIs

    To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

    Enable the API

  5. Instala Google Cloud CLI.

  6. Si usas un proveedor de identidad externo (IdP), primero debes acceder a la gcloud CLI con tu identidad federada.

  7. Para inicializar gcloud CLI, ejecuta el siguiente comando: 

    gcloud init

  8. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  9. Verify that billing is enabled for your Google Cloud project.

  10. Enable the Notebooks API.

    Roles required to enable APIs

    To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

    Enable the API

  11. Instala Google Cloud CLI.

  12. Si usas un proveedor de identidad externo (IdP), primero debes acceder a la gcloud CLI con tu identidad federada.

  13. Para inicializar gcloud CLI, ejecuta el siguiente comando: 

    gcloud init

Usa atributos de invitado para informar el estado del sistema

Puedes usar los atributos de invitado para informar el estado del sistema de los siguientes servicios principales:

  • Servicio de Docker
  • Agente de proxy inverso de Docker
  • Servicio de Jupyter
  • API de Jupyter

Los atributos de invitado son un tipo específico de metadatos personalizados en los que las aplicaciones pueden escribir mientras se ejecutan en la instancia de Agent Platform Workbench. Para obtener más información sobre los atributos de invitado, consulta Información sobre los metadatos de VM.

Cómo las instancias usan los atributos de invitado para informar el estado del sistema

El servicio notebooks-collection-agent ejecuta un proceso de Python en segundo plano que verifica el estado de los servicios principales de la instancia de Agent Platform Workbench y actualiza los atributos de invitado como 1 si no se detectan problemas o -1 si se detecta una falla.

Para usar el servicio notebooks-collection-agent a fin de informar sobre el estado de la instancia de Agent Platform Workbench, debes habilitar los siguientes atributos de invitado mientras creas una instancia de Agent Platform Workbench:

  • enable-guest-attributes=TRUE: Habilita los atributos de invitado en la instancia de Agent Platform Workbench. Todas las instancias nuevas habilitan este atributo de forma predeterminada
  • report-event-health=TRUE: Registra los resultados de la verificación de estado del sistema en los atributos de invitado.

El servicio notebooks-collection-agent no necesita ningún permiso especial para escribir en los atributos de invitado de la instancia.

Crea una instancia de Agent Platform Workbench con los atributos de invitado del estado del sistema habilitados

Para usar los atributos de invitado del estado del sistema para informar sobre el estado de la instancia de Agent Platform Workbench, debes seleccionar la casilla de verificación Habilitar informe de estado del sistema cuando crees una instancia de Agent Platform Workbench.

Puedes habilitar el informe de estado del sistema con la Google Cloud consola o Google Cloud CLI.

Console

  1. En la consola de Google Cloud , ve a la página Instancias.

    Ir a Instancias

  2. Haz clic en  Crear nuevo.

  3. En el cuadro de diálogo Instancia nueva, haz clic en Opciones avanzadas.

  4. En el diálogo Crear instancia, en la sección Detalles, proporciona la siguiente información para tu instancia nueva:

    • Nombre: Proporciona un nombre para la instancia nueva.

    • Región y Zona: Elige una región y una zona para la instancia nueva. Para obtener el mejor rendimiento de red, selecciona la región que se encuentra más cerca de tu ubicación geográfica. Consulta las ubicaciones de Agent Platform Workbench disponibles.

  5. En la sección Estado del sistema, en Informes, selecciona Informar el estado del sistema.

  6. Completa el resto del diálogo de creación de la instancia y, luego, haz clic en Crear.

gcloud

  1. Desde Cloud Shell o cualquier entorno en el que Google Cloud CLI esté instalado, escribe el siguiente comando de Google Cloud CLI:

    gcloud workbench instances create INSTANCE_NAME \
    --vm-image-project=cloud-notebooks-managed \
    --vm-image-family=IMAGE_FAMILY \
    --machine-type=MACHINE_TYPE \
    --location=ZONE \
    --metadata=enable-guest-attributes=TRUE,report-event-health=TRUE

    Reemplaza lo siguiente:

    • INSTANCE_NAME: nombre de tu instancia nueva
    • IMAGE_FAMILY: Es el nombre de la familia de imágenes que deseas usar para crear tu instancia.
    • MACHINE_TYPE: Es el tipo de máquina de la VM de tu instancia; por ejemplo, n1-standard-4.
    • ZONE: Es la zona en la que deseas que se ubique la instancia nueva, por ejemplo, us-west1-a.

  2. Accede a tu instancia desde la consola deGoogle Cloud .

Supervisa el estado del sistema mediante atributos de invitado

Para las instancias de Agent Platform Workbench que tienen los atributos de invitado relacionados habilitados, puedes recuperar los valores de los atributos de invitado del estado del sistema con la consola de Google Cloud , Google Cloud CLI con comandos de Compute Engine o Google Cloud CLI con comandos de Gemini Enterprise Agent Platform Workbench.

Console

  1. En la consola de Google Cloud , ve a la página Instancias.

    Ir a Instancias

  2. Haz clic en el nombre de la instancia del que deseas ver el estado del sistema.

  3. En la página Detalles de la instancia, haz clic en la pestaña Estadp. Revisa el estado de tu instancia y sus servicios principales.

gcloud con Compute Engine 

gcloud compute instances get-guest-attributes INSTANCE_NAME \
    --zone ZONE

Reemplaza lo siguiente:

  • INSTANCE_NAME: el nombre de tu instancia
  • ZONE: La zona en la que se encuentra la instancia.

Si tus servicios principales están en buen estado, los resultados se verán de la siguiente manera. Un valor de 1 significa que no se detectó ninguna falla.

 NAMESPACE   KEY                         VALUE
 notebooks   docker_proxy_agent_status   1
 notebooks   docker_status               1
 notebooks   jupyterlab_api_status       1
 notebooks   jupyterlab_status           1
 notebooks   system-health               1
 notebooks   updated                     2023-06-20 17:00:00.12345

Si alguno de los cuatro servicios principales falla, el estado del sistema informa un valor -1 para indicar una falla del sistema. En la mayoría de los casos, una falla del sistema significa que JupyterLab no es accesible.

Un ejemplo de un resultado de falla podría verse de la siguiente manera.

 NAMESPACE   KEY                         VALUE
 notebooks   docker_proxy_agent_status   -1
 notebooks   docker_status               -1
 notebooks   jupyterlab_api_status       1
 notebooks   jupyterlab_status           1
 notebooks   system-health               -1
 notebooks   updated                     2023-06-20 17:00:00.12345

Informa métricas personalizadas a Monitoring

Las instancias de Agent Platform Workbench te permiten recopilar el estado del sistema y las métricas de JupyterLab, y, luego, informarlos a Cloud Monitoring. Estas métricas personalizadas son diferentes de las métricas estándar que se informan cuando instalas Monitoring en tu instancia de Agent Platform Workbench.

Las métricas personalizadas que se informan a Monitoring incluyen las siguientes:

  • El estado del sistema de los servicios principales de Agent Platform Workbench:

    • Servicio de Docker
    • Agente de proxy inverso de Docker
    • Servicio de Jupyter
    • API de Jupyter

  • Las siguientes métricas de JupyterLab:

    • Cantidad de kernels
    • Cantidad de terminales
    • Número de conexiones
    • Cantidad de sesiones
    • Máximo de memoria
    • Capacidad de memoria alta
    • Memoria actual

Cómo las instancias informan las métricas personalizadas a Monitoring

Para informar métricas personalizadas a Monitoring, debes habilitar el parámetro de configuración de metadatos report-notebook-metrics mientras creas una instancia de Agent Platform Workbench.

También debes asegurarte de que la cuenta de servicio de la instancia de Agent Platform Workbench tenga permisos de escritor de métricas de Monitoring (roles/monitoring.metricWriter). Para obtener más información, consulta Administra el acceso a proyectos, carpetas y organizaciones.

Crea una instancia de Gemini Enterprise Agent Platform Workbench que informe métricas personalizadas a Monitoring

Para informar métricas personalizadas a Monitoring, debes seleccionar la casilla de verificación Informar métricas personalizadas a Cloud Monitoring cuando crees una instancia de Agent Platform Workbench.

Puedes habilitar las métricas personalizadas de informes en Cloud Monitoring con la Google Cloud consola o gcloud CLI.

Console

  1. En la consola de Google Cloud , ve a la página Instancias.

    Ir a Instancias

  2. Haz clic en  Crear nuevo.

  3. En el cuadro de diálogo Instancia nueva, haz clic en Opciones avanzadas.

  4. En el diálogo Crear instancia, en la sección Detalles, proporciona la siguiente información para tu instancia nueva:

    • Nombre: Proporciona un nombre para la instancia nueva.
    • Región y Zona: Elige una región y una zona para la instancia nueva. Para obtener el mejor rendimiento de red, selecciona la región que se encuentra más cerca de tu ubicación geográfica. Consulta las ubicaciones de Agent Platform Workbench disponibles.

  5. En la sección Estado del sistema, en Informes, selecciona Informar métricas personalizadas a Cloud Monitoring.

  6. Completa el resto del diálogo de creación de la instancia y, luego, haz clic en Crear.

gcloud

  1. Desde Cloud Shell o cualquier entorno en el que Google Cloud CLI esté instalado, escribe el siguiente comando de Google Cloud CLI:

    gcloud workbench instances create INSTANCE_NAME \
    --vm-image-project=cloud-notebooks-managed \
    --vm-image-family=IMAGE_FAMILY \
    --machine-type=MACHINE_TYPE \
    --location=ZONE \
    --metadata=report-notebook-metrics=TRUE

    Reemplaza lo siguiente:

    • INSTANCE_NAME: nombre de tu instancia nueva
    • IMAGE_FAMILY: Es el nombre de la familia de imágenes que deseas usar para crear tu instancia.
    • MACHINE_TYPE: Es el tipo de máquina de la VM de tu instancia, por ejemplo, n1-standard-4.
    • ZONE: Es la zona en la que deseas que se ubique la instancia nueva, por ejemplo, us-west1-a.

  2. Accede a tu instancia desde la consola deGoogle Cloud .

Otorga permisos de escritor de métricas de Monitoring a la cuenta de servicio

Después de crear la instancia nueva de Agent Platform Workbench, otorga permisos de escritor de métricas de Monitoring (roles/monitoring.metricWriter) a la cuenta de servicio para la instancia de Agent Platform Workbench. Para obtener más información, consulta Administra el acceso a proyectos, carpetas y organizaciones.

Supervisa métricas personalizadas a través de Monitoring

Para las instancias de Agent Platform Workbench que tienen informes de métricas personalizadas habilitados, puedes supervisar tus métricas personalizadas con la Google Cloud consola.

  1. En la consola de Google Cloud , ve a la página Instancias.

    Ir a Instancias

  2. Haz clic en el nombre de la instancia del que deseas ver las métricas personalizadas.

  3. En la página Detalles de la instancia, haz clic en la pestaña Monitoring. Revisa las métricas personalizadas de tu instancia.

Instala Monitoring en una instancia

Con esta opción, se instala Monitoring de forma automática. La instalación requiere 256 MB de espacio en disco. Se requiere una conexión a Internet para que las métricas se informen a Monitoring.

Cómo las instancias informan las métricas del sistema y de la aplicación

Para informar las métricas del sistema y de la aplicación mediante la instalación de Cloud Monitoring en tu instancia de Agent Platform Workbench, debes seleccionar la casilla de verificación Instalar agente de Cloud Monitoring cuando crees una instancia de Agent Platform Workbench. Estas métricas son diferentes de las métricas personalizadas que se informan cuando habilitas el parámetro de configuración de metadatos report-notebook-metrics.

Crea una instancia de Agent Platform Workbench que informe las métricas del sistema y de la aplicación a Monitoring

Para instalar Monitoring en tu instancia de Agent Platform Workbench, puedes usar la consola de Google Cloud o gcloud CLI.

Console

  1. En la consola de Google Cloud , ve a la página Instancias.

    Ir a Instancias

  2. Haz clic en  Crear nuevo.

  3. En el cuadro de diálogo Instancia nueva, haz clic en Opciones avanzadas.

  4. En el diálogo Crear instancia, en la sección Detalles, proporciona la siguiente información para tu instancia nueva:

    • Nombre: Proporciona un nombre para la instancia nueva.
    • Región y Zona: Elige una región y una zona para la instancia nueva. Para obtener el mejor rendimiento de red, selecciona la región que se encuentra más cerca de tu ubicación geográfica. Consulta las ubicaciones de Agent Platform Workbench disponibles.

  5. En la sección Estado del sistema, en Informes, selecciona Instalar Cloud Monitoring.

  6. Completa el resto del diálogo de creación de la instancia y, luego, haz clic en Crear.

gcloud

  1. Desde Cloud Shell o cualquier entorno en el que Google Cloud CLI esté instalado, escribe el siguiente comando de Google Cloud CLI:

    gcloud workbench instances create INSTANCE_NAME \
    --vm-image-project=cloud-notebooks-managed \
    --vm-image-family=IMAGE_FAMILY \
    --machine-type=MACHINE_TYPE \
    --location=ZONE \
    --metadata=install-monitoring-agent=TRUE

    Reemplaza lo siguiente:

    • INSTANCE_NAME: nombre de tu instancia nueva
    • IMAGE_FAMILY: Es el nombre de la familia de imágenes que deseas usar para crear tu instancia.
    • MACHINE_TYPE: Es el tipo de máquina de la VM de tu instancia; por ejemplo, n1-standard-4.
    • ZONE: Es la zona en la que deseas que se ubique la instancia nueva, por ejemplo, us-west1-a.

  2. Accede a tu instancia desde la consola deGoogle Cloud .

Supervisa las métricas del sistema y de las aplicaciones a través de Monitoring

Para las instancias de Agent Platform Workbench que tienen Monitoring instalado, puedes supervisar las métricas del sistema y de la aplicación con la Google Cloud consola:

  1. En la consola de Google Cloud , ve a la página Instancias.

    Ir a Instancias

  2. Haz clic en el nombre de la instancia del que deseas ver las métricas del sistema y de la aplicación.

  3. En la página Detalles de la instancia, haz clic en la pestaña Monitoring. Revisa las métricas del sistema y de la aplicación para tu instancia. Para aprender a interpretar estas métricas, consultaRevisa las métricas de recursos.

Usa la herramienta de diagnóstico para supervisar el estado del sistema

Las instancias de Agent Platform Workbench incluyen una herramienta de diagnóstico integrada que puede ayudarte a supervisar el estado del sistema de tus instancias.

Tareas que realiza la herramienta de diagnóstico

La herramienta de diagnóstico realiza las siguientes tareas:

  • Verifica el estado de los siguientes servicios principales de Agent Platform Workbench:

    • Servicio de Docker
    • Agente de proxy inverso de Docker
    • Servicio de Jupyter
    • API de Jupyter

  • Comprueba si el espacio en el disco para el disco de arranque y de datos se usa por encima del umbral del 85%.

  • Instala lsof (se requiere conexión a Internet).

  • Recopila los siguientes registros de instancias:

    • informaciónde redes de rutas (ifconfig, netstat)
    • Registros en la carpeta /var/log/
    • Información de estado de Docker
    • Datos de lsof (archivos abiertos)
    • Estado del servicio de Docker
    • Estado del agente inverso del proxy
    • Estado del servicio de Jupyter
    • Estado de la API de Jupyter
    • Archivo de configuración del agente de proxy
    • Procesos de Python

  • Ejecuta los siguientes comandos y recopila los resultados:

    • pip freeze
    • conda list
    • gcloud compute instances describe INSTANCE_NAME
    • gcloud config list

Ejecuta la herramienta de diagnóstico

Si tu instancia usa un contenedor personalizado, consulta Ejecuta la herramienta de diagnóstico en la documentación del contenedor personalizado de Agent Platform Workbench.

Para ejecutar la herramienta de diagnóstico en una instancia que no usa un contenedor personalizado, completa los siguientes pasos:

  1. Usa SSH para conectarte a tu instancia de Agent Platform Workbench.

  2. En la terminal de SSH, ejecuta los siguientes comandos:

    sudo -i
cd /opt/deeplearning/bin/
./diagnostic_tool.sh

    La herramienta de diagnóstico recopila los registros, los comprime en un archivo .tar.gz y coloca el archivo en la carpeta /tmp/.

  3. Extrae el archivo y, luego, evalúa el contenido. El contenido incluye lo siguiente:

    • Carpeta log: Registros de la carpeta var/log/
    • report.log: Resultado de todos los comandos recopilados
    • proxy-agent-config.json: Información del archivo de configuración del proxy
    • Registro de Docker: Un archivo -json.log que incluye registros de contenedores de Docker

Puedes usar las siguientes opciones con la herramienta de diagnóstico.

Opción Descripción
-r Es una opción de reparación que intenta restablecer el estado de los servicios principales de Agent Platform Workbench con errores.
-s Se ejecuta sin una confirmación.
-b Sube el archivo .tar.gz a un bucket de Cloud Storage.
-v Una opción de depuración para solucionar problemas de la herramienta en caso de fallas
-c Captura 30 segundos de tráfico de paquetes en tu instancia de Agent Platform Workbench y filtra las conexiones SSH.
-d Es una carpeta de destino en la que se guardan los registros.
-h Ayuda

¿Qué sigue?