Consulta los registros de errores de los complementos de Google Workspace

Cuando un complemento de Google Workspace publicado devuelve un error, la interfaz del complemento muestra un mensaje genérico que indica que "se produjo un error al ejecutar el complemento". Sin embargo, estos errores se registran en el Explorador de registros de Cloud.

En esta guía, se describe cómo consultar los registros de errores de complementos en el Explorador de registros de Cloud para que puedas hacer lo siguiente:

  • Saber si los usuarios encuentran errores
  • Consulta la frecuencia con la que ocurren los errores y cuáles son los más frecuentes.
  • Leer mensajes de error descriptivos que te ayudan a corregirlos

Requisitos previos

Antes de consultar los registros de errores del complemento, haz lo siguiente:

  • Habilita la "API de Cloud Logging" en el proyecto de Google Cloud del complemento. Para habilitar una API, consulta Crea un proyecto de Cloud y habilita la API.
  • Publica el complemento en Google Workspace Marketplace. Para publicar un complemento en Marketplace, consulta Publica una app.

Consulta los registros de errores del complemento

Para obtener registros de un complemento, haz lo siguiente:

  1. Abre Google Cloud Console
  2. Junto a "Google Cloud Platform", haz clic en la flecha hacia abajo y selecciona el proyecto del complemento.
  3. En la esquina superior izquierda, haz clic en Menú > Registro. Se abrirá el Explorador de registros.

  4. Para los registros de errores de complementos, en el compilador de consultas, ingresa la siguiente consulta:

    severity>=ERROR
protoPayload.serviceName="gsuiteaddons.googleapis.com"

  5. Para ver los errores recientes, haz clic en Ejecutar consulta. O bien, para ver los errores a medida que ocurren, haz clic en Transmitir registros. Los registros de errores de los complementos aparecen en el panel "Resultados de la consulta".

Para obtener más información sobre el Explorador de registros de Cloud y cómo escribir consultas, consulta los siguientes recursos:

Cómo habilitar o inhabilitar el registro de errores

De forma predeterminada, el registro de errores está habilitado. Cuando se habilita el registro de errores, el archivo de manifiesto tiene lo siguiente:

"exceptionLogging": "STACKDRIVER",

Para inhabilitar el registro de errores, reemplaza "exceptionLogging": "STACKDRIVER", por la siguiente línea en el archivo de manifiesto:

// Disable error logging
"exceptionLogging": "NONE"

Para volver a habilitar el registro de errores, reemplaza "exceptionLogging": "NONE" por "exceptionLogging": "STACKDRIVER",.

Consideraciones

A medida que trabajas con los registros de errores de complementos en el Explorador de registros de Cloud, ten en cuenta estas consideraciones:

  • Los complementos solo registran errores en el Explorador de registros. No se registran otros tipos de registros.
  • Los mensajes de error siempre se escriben en inglés.
  • Cloud Logging genera costos. Para obtener más información sobre los precios de Cloud Logging, consulta Precios de Google Cloud Observability.