Se usó la API de Cloud Translation para traducir esta página.

Registro

Cuando desarrollas cualquier tipo de app, es recomendable que registres información para ayudar a diagnosticar fallas durante el desarrollo, identificar y diagnosticar problemas de clientes y para otros fines.

Apps Script proporciona tres mecanismos diferentes para el registro:

El registro de ejecución de Apps Script integrado Este registro es ligero y se transmite en tiempo real, pero persiste solo por un período breve.
La interfaz de Cloud Logging en Play Console, que proporciona registros que se conservan durante muchos días después de su creación.
La interfaz de Error Reporting en Play Console, que recopila y registra errores que ocurren mientras se ejecuta tu secuencia de comandos.

Estos se describen en las siguientes secciones. Además de estos mecanismos, también puedes compilar tu propio código de registrador que, por ejemplo, escriba información en una hoja de cálculo o una base de datos de JDBC de registro.

Usa el registro de ejecución de Apps Script

Un enfoque básico para el acceso en Apps Script es usar el registro de ejecución integrado. Para ver estos registros, en la parte superior del editor, haz clic en Registro de ejecución. Cuando ejecutas una función o usas el depurador, los registros se transmiten en tiempo real.

Puedes usar los servicios de registro Logger o console en el registro de ejecución integrado.

Estos registros están diseñados para verificaciones simples durante el desarrollo y la depuración, y no se conservan por mucho tiempo.

Por ejemplo, considera la siguiente función:

utils/logging.gs

Ver en GitHub

/**
 * Logs Google Sheet information.
 * @param {number} rowNumber The spreadsheet row number.
 * @param {string} email The email to send with the row data.
 */
function emailDataRow(rowNumber, email) {
  console.log('Emailing data row ' + rowNumber + ' to ' + email);
  try {
    const sheet = SpreadsheetApp.getActiveSheet();
    const data = sheet.getDataRange().getValues();
    const rowData = data[rowNumber - 1].join(' ');
    console.log('Row ' + rowNumber + ' data: ' + rowData);
    MailApp.sendEmail(email, 'Data in row ' + rowNumber, rowData);
  } catch (err) {
    // TODO (developer) - Handle exception
    console.log('Failed with error %s', err.message);
  }
}

Cuando se ejecuta esta secuencia de comandos con las entradas “2” y “john@example.com”, se escriben los siguientes registros:

[16-09-12 13:50:42:193 PDT] Envío de datos por correo electrónico de la fila 2 a john@example.com
[16-09-12 13:50:42:271 PDT] Row 2 data: Cost 103.24

Cloud Logging

Apps Script también proporciona acceso parcial al servicio de Cloud Logging de Google Cloud Platform (GCP). Cuando necesitas registros que persisten durante varios días o necesitas una solución de registro más compleja para un entorno de producción multiusuario, Cloud Logging es la opción preferida. Consulta las cuotas y los límites de Cloud Logging para obtener información sobre la retención de datos y otros detalles sobre las cuotas.

Si necesitas una mayor cuota de registro, puedes enviar una solicitud de cuota de Google Cloud Platform. Esto requiere que tengas acceso al proyecto de Cloud Platform que usa tu secuencia de comandos.

Usa Cloud Logging

Los registros de Cloud se adjuntan al proyecto de Google Cloud asociado con Apps Script. Puedes ver una versión simplificada de estos registros en el panel de Apps Script.

Para aprovechar al máximo Cloud Logging y sus capacidades, usa un proyecto estándar de Google Cloud con tu proyecto de secuencia de comandos. Esto te permite acceder a los registros de Cloud directamente en GCP Console y te brinda más opciones de visualización y filtrado.

Cuando realizas el registro, es una buena práctica de privacidad evitar registrar información personal sobre el usuario, como direcciones de correo electrónico. Los registros de Cloud se etiquetan de forma automática con claves de usuario activas que puedes usar para ubicar los mensajes de registro de un usuario específico cuando sea necesario.

Puedes registrar strings, strings con formato y hasta objetos JSON con las funciones que proporciona el servicio console de Apps Script.

En el siguiente ejemplo, se muestra cómo usar el servicio console para registrar información en Cloud Operations.

utils/logging.gs

Ver en GitHub

/**
 * Logs the time taken to execute 'myFunction'.
 */
function measuringExecutionTime() {
  // A simple INFO log message, using sprintf() formatting.
  console.info('Timing the %s function (%d arguments)', 'myFunction', 1);

  // Log a JSON object at a DEBUG level. The log is labeled
  // with the message string in the log viewer, and the JSON content
  // is displayed in the expanded log structure under "jsonPayload".
  const parameters = {
    isValid: true,
    content: 'some string',
    timestamp: new Date()
  };
  console.log({message: 'Function Input', initialData: parameters});
  const label = 'myFunction() time'; // Labels the timing log entry.
  console.time(label); // Starts the timer.
  try {
    myFunction(parameters); // Function to time.
  } catch (e) {
    // Logs an ERROR message.
    console.error('myFunction() yielded an error: ' + e);
  }
  console.timeEnd(label); // Stops the timer, logs execution duration.
}

Claves de usuario activas

Las claves de usuario activas temporales proporcionan una forma conveniente de detectar usuarios únicos en las entradas de registro de Cloud sin revelar las identidades de esos usuarios. Las claves se usan por secuencia de comandos y cambian aproximadamente una vez al mes para proporcionar seguridad adicional en caso de que un usuario revele su identidad a un desarrollador, por ejemplo, cuando informa un problema.

Las claves de usuario activas temporales son superiores a los identificadores de registro, como las direcciones de correo electrónico, debido a lo siguiente:

No es necesario que agregues nada a tus registros; ya estarán ahí.
No requieren la autorización del usuario.
Protegen la privacidad del usuario.

Para encontrar claves de usuario activas temporales en las entradas de tus registros de Cloud, consulta los registros de Cloud en la consola de Google Cloud. Solo puedes hacer esto si tu proyecto de secuencia de comandos usa un proyecto estándar de Google Cloud al que tienes acceso. Una vez que hayas abierto el proyecto de Google Cloud en la consola, selecciona una entrada de registro que te interese y expándela para ver metadata > labels > script.googleapis.com/user_key.

También puedes obtener la clave de usuario activa temporal si llamas a Session.getTemporaryActiveUserKey() en tu secuencia de comandos. Una forma de usar este método es mostrarle la clave al usuario mientras ejecuta tu secuencia de comandos. Luego, los usuarios pueden optar por incluir sus claves cuando informan problemas para ayudarte a identificar los registros relevantes.

Registro de excepciones

El registro de excepciones envía excepciones no controladas en el código del proyecto de secuencia de comandos a Cloud Logging, junto con un seguimiento de pila.

Para ver los registros de excepciones, sigue estos pasos:

Abre el proyecto Apps Script.
A la izquierda, haz clic en Ejecuciones .
En la parte superior, haz clic en Agregar un filtro > Estado.
Selecciona las casillas de verificación Error y Se agotó el tiempo de espera.

También puedes ver las excepciones registradas en GCP Console si tu proyecto de secuencia de comandos usa un proyecto estándar de Google Cloud al que tienes acceso.

Habilitar el registro de excepciones

El registro de excepciones está habilitado de forma predeterminada para proyectos nuevos. Para habilitar el registro de excepciones para proyectos anteriores, sigue estos pasos:

Abre el proyecto de secuencia de comandos.
A la izquierda, haz clic en Configuración del proyecto .
Selecciona la casilla de verificación Registrar excepciones no detectadas en Cloud Operations.

Error Reporting

El registro de excepciones se integra de forma automática en Cloud Error Reporting, un servicio que agrega y muestra errores producidos en tu secuencia de comandos. Puedes ver los informes de errores de Cloud en la consola de Google Cloud. Si se te solicita “Configurar Error Reporting”, esto se debe a que la secuencia de comandos aún no registró ninguna excepción. No se requiere ninguna configuración además de habilitar el registro de excepciones.

Requisitos de registro

No hay requisitos para usar el registro de ejecución integrado.

Puedes ver una versión simplificada de los registros de Cloud en el panel de Apps Script. Sin embargo, para aprovechar al máximo Cloud Logging y Error Reporting, debes tener acceso al proyecto de GCP de la secuencia de comandos. Esto solo es posible si tu proyecto de secuencia de comandos usa un proyecto estándar de Google Cloud.