Instrumenta las apps de Node.js para Error Reporting

Puedes enviar informes de errores a Error Reporting desde aplicaciones de Node.js mediante la biblioteca de Error Reporting para Node.js. Usa la biblioteca de Error Reporting para Node.js si quieres crear grupos de errores en los siguientes casos:

• Tu bucket de registros tiene claves de encriptación administradas por el cliente (CMEK).
• Tus buckets de registros no están en la región global.
• Deseas informar eventos de error personalizados.

Error Reporting está integrado en algunos servicios de Google Cloud, como Cloud Functions y App Engine, Compute Engine y Google Kubernetes Engine. Error Reporting muestra los errores que registran las aplicaciones que se ejecutan en esos servicios en Cloud Logging. Para obtener más información, ve a Ejecuta en Google Cloud en esta página.

También puedes enviar datos de errores a Error Reporting mediante Logging. Para obtener información sobre los requisitos de formato de datos, consulta Dale formato a los mensajes de error en Logging.

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. En la página del selector de proyectos de la consola de Google Cloud, selecciona o crea un proyecto de Google Cloud.

   Nota: Si no planeas conservar los recursos que creaste durante este procedimiento, crea un proyecto en lugar de seleccionar uno existente. Cuando termines, puedes borrar el proyecto y quitar todos los recursos asociados con él.

   Ir al selector de proyectos

3. Asegúrate de que la facturación esté habilitada para tu proyecto de Google Cloud.

4. Habilita Error Reporting API .

   Habilita la API

5. En la página del selector de proyectos de la consola de Google Cloud, selecciona o crea un proyecto de Google Cloud.

   Nota: Si no planeas conservar los recursos que creaste durante este procedimiento, crea un proyecto en lugar de seleccionar uno existente. Cuando termines, puedes borrar el proyecto y quitar todos los recursos asociados con él.

   Ir al selector de proyectos

6. Asegúrate de que la facturación esté habilitada para tu proyecto de Google Cloud.

7. Habilita Error Reporting API .

   Habilita la API

8. Prepara el entorno para el desarrollo en Node.js.

   Ir a la guía de configuración de Node.js

Instala la biblioteca cliente

La biblioteca de Error Reporting para Node.js te permite supervisar y ver los errores que informan las aplicaciones de Node.js que se ejecutan prácticamente en cualquier sitio.

1. Usa npm para instalar el paquete:

   npm install --save @google-cloud/error-reporting

2. Importa la biblioteca y crea una instancia de cliente para comenzar a informar errores:

   // Imports the Google Cloud client library
   const {ErrorReporting} = require('@google-cloud/error-reporting');
   
   // Instantiates a client
   const errors = new ErrorReporting();
   
   // Reports a simple error
   errors.report('Something broke!');

Para obtener más información sobre la instalación, lee la documentación de la biblioteca de Error Reporting para Node.js. También puedes informar problemas con el seguimiento de problemas.

Cómo configurar la biblioteca cliente

Puedes personalizar el comportamiento de la biblioteca de Error Reporting para Node.js. Consulta la configuración de la biblioteca para obtener una lista de las opciones de configuración posibles. Estas opciones se pueden pasar en el objeto options que se transfiere al constructor de la biblioteca.

Otras integraciones

Si deseas obtener más información sobre las integraciones entre la biblioteca de Error Reporting para Node.js y otros frameworks web de Node.js, consulta el repositorio de la biblioteca en GitHub.

Ejecuta apps en Google Cloud

Para crear grupos de errores con projects.events.report, tu cuenta de servicio requiere el rol de escritor de Error Reporting (roles/errorreporting.writer).

Algunos servicios de Google Cloud otorgan automáticamente la función de escritor de Error Reporting (roles/errorreporting.writer) a la cuenta de servicio adecuada. Sin embargo, debes otorgar esta función a la cuenta de servicio correspondiente para algunos servicios.

Entorno flexible de App Engine

App Engine otorga automáticamente la función de escritor de Error Reporting (roles/errorreporting.writer) a la cuenta de servicio predeterminada.

Se puede usar la biblioteca de Error Reporting para Node.js sin necesidad de proporcionar credenciales de forma explícita.

Error Reporting se habilita de manera automática para las aplicaciones del entorno flexible de App Engine. No se requiere ninguna configuración adicional.

Nota: Error Reporting procesa automáticamente los registros de errores escritos en stderr, sin necesidad de usar la biblioteca de Error Reporting para Node.js directamente.

Google Kubernetes Engine

Para usar Error Reporting con Google Kubernetes Engine, haz lo siguiente:

1. Asegúrate de que la cuenta de servicio que usa el contenedor tenga la función de escritor de Error Reporting (roles/errorreporting.writer).

   Puedes usar la cuenta de servicio predeterminada de Compute Engine o una personalizada.

   Para obtener información sobre cómo otorgar roles, consulta Administra el acceso a proyectos, carpetas y organizaciones.

2. Crea tu clúster y otórgale el permiso de acceso cloud-platform.

   Por ejemplo, en el siguiente comando de creación, se especifica el permiso de acceso cloud-platform y una cuenta de servicio:

   gcloud container clusters create CLUSTER_NAME --service-account  SERVICE_ACCT_NAME --scopes=cloud-platform
   

Nota: Después de crear un clúster, no puedes cambiar la cuenta de servicio.

Compute Engine

Para usar Error Reporting con instancias de VM de Compute Engine, haz lo siguiente:

1. Asegúrate de que la cuenta de servicio que usará tu instancia de VM tenga la función de escritor de Error Reporting (roles/errorreporting.writer).

   Puedes usar la cuenta de servicio predeterminada de Compute Engine o una personalizada.

   Para obtener información sobre cómo otorgar roles, consulta Administra el acceso a proyectos, carpetas y organizaciones.

2. En el panel de navegación de la consola de Google Cloud, elige Compute Engine y, luego, Instancias de VM.

   Ir a Instancias de VM

3. Selecciona la instancia de VM que deseas que reciba el permiso de acceso de cloud-platform.

4. Haz clic en Detener y, luego, en Editar.

5. En la sección Identidad y acceso a la API, selecciona una cuenta de servicio que tenga el rol de escritor de Error Reporting (roles/errorreporting.writer).

6. En la sección Permisos de acceso, selecciona Permitir el acceso total a todas las APIs de Cloud y, luego, guarda los cambios.

7. Haz clic en Iniciar/Reanudar.

Cloud Functions

Cloud Functions otorga la función de escritor de Error Reporting (roles/errorreporting.writer) a la cuenta de servicio predeterminada de forma automática.

Se puede usar la biblioteca de Error Reporting para Node.js sin necesidad de proporcionar credenciales de forma explícita.

Cloud Functions está configurado para usar Error Reporting de manera automática. Las excepciones de JavaScript no administradas aparecerán en Logging y Error Reporting las procesará sin la necesidad de usar la biblioteca de Error Reporting para Node.js.

Nota: Las entradas de registro se procesan de forma automática si contienen un seguimiento de pila y no especifican ninguna gravedad de registro o una gravedad de registro de al menos ERROR, sin necesidad de usar la biblioteca de Error Reporting para Node.js.

Ejemplo:

// Imports the Google Cloud client library
const {ErrorReporting} = require('@google-cloud/error-reporting');

// Instantiates a client
const errors = new ErrorReporting({
  projectId: 'your-project-id',
  keyFilename: '/path/to/key.json',
});

// Reports a simple error
errors.report('Something broke!');

Ejemplo

Para informar un error de forma manual, llama al método report, como se muestra en el siguiente ejemplo:

// Imports the Google Cloud client library
const {ErrorReporting} = require('@google-cloud/error-reporting');

// Instantiates a client
const errors = new ErrorReporting();

// Use the error message builder to customize all fields ...
const errorEvent = errors.event();

// Add error information
errorEvent.setMessage('My error message');
errorEvent.setUser('root@nexus');

// Report the error event
errors.report(errorEvent, () => {
  console.log('Done reporting error event!');
});

// Report an Error object
errors.report(new Error('My error message'), () => {
  console.log('Done reporting Error object!');
});

// Report an error by provided just a string
errors.report('My error message', () => {
  console.log('Done reporting error string!');
});

Informa sobre errores con Express.js

La biblioteca de Error Reporting para Node.js puede integrar Error Reporting en frameworks web populares de Node.js, como Express.js:

const express = require('express');

// Imports the Google Cloud client library
const {ErrorReporting} = require('@google-cloud/error-reporting');

// Instantiates a client
const errors = new ErrorReporting();

const app = express();

app.get('/error', (req, res, next) => {
  res.send('Something broke!');
  next(new Error('Custom error message'));
});

app.get('/exception', () => {
  JSON.parse('{"malformedJson": true');
});

// Note that express error handling middleware should be attached after all
// the other routes and use() calls. See the Express.js docs.
app.use(errors.express);

const PORT = process.env.PORT || 8080;
app.listen(PORT, () => {
  console.log(`App listening on port ${PORT}`);
  console.log('Press Ctrl+C to quit.');
});

Ejecuta apps en un entorno de desarrollo local

Si deseas usar la biblioteca de Error Reporting para Node.js en un entorno de desarrollo local, como ejecutar la biblioteca en tu propia estación de trabajo, debes proporcionar la biblioteca de Error Reporting para Node.js con las credenciales predeterminadas de la aplicación local. Si deseas obtener más información, consulta Autentícate en Error Reporting.

Para usar las muestras de Node.js de esta página desde un entorno de desarrollo local, instala e inicializa la CLI de gcloud y, luego, configura las credenciales predeterminadas de la aplicación con tus credenciales de usuario.

1. Instala Google Cloud CLI.

2. Para inicializar la CLI de gcloud, ejecuta el siguiente comando:

   gcloud init

3. Crea credenciales de autenticación locales para tu Cuenta de Google:

   gcloud auth application-default login

   Nota: Si la CLI de gcloud imprime una advertencia que indica que tu cuenta no tiene el permiso serviceusage.services.use, es posible que algunos comandos de la CLI de gcloud y bibliotecas cliente no funcionen. Solicita a un administrador que te otorgue el rol de IAM Consumidor de Service Usage (roles/serviceusage.serviceUsageConsumer) y, luego, ejecuta este comando:

   gcloud auth application-default set-quota-project PROJECT_ID

Para obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.

El método projects.events.report también admite claves de API. Si deseas usar claves de API para la autenticación, no necesitas configurar un archivo local de credenciales predeterminadas de la aplicación. Para obtener más información, consulta Crea una clave de API en la documentación de autenticación de Google Cloud.

Ejemplo:

// Imports the Google Cloud client library
const {ErrorReporting} = require('@google-cloud/error-reporting');

// Instantiates a client
const errors = new ErrorReporting({
  projectId: 'your-project-id',
  keyFilename: '/path/to/key.json',
});

// Reports a simple error
errors.report('Something broke!');

Ve informes de errores

En el panel de navegación de la consola de Google Cloud, selecciona Error Reporting y, luego, tu proyecto de Google Cloud:

Ir a Error Reporting

Para obtener más información, consulta Cómo visualizar errores.