Instrumenta apps de Node.js para Error Reporting

La biblioteca de Error Reporting para Node.js te permite enviar eventos de error directamente desde tus aplicaciones de Node.js a Error Reporting para que puedas diagnosticar y supervisar las fallas del tiempo de ejecución. Instrumentar tu aplicación con la biblioteca te permite informar eventos de error personalizados y capturar errores incluso cuando tus buckets de registros usan claves de encriptación administradas por el cliente (CMEK).

En el caso de las aplicaciones que se ejecutan en servicios integrados Google Cloud (incluidas las funciones de Cloud Run, App Engine, Compute Engine y Google Kubernetes Engine), Error Reporting también puede inferir eventos de error automáticamente desde Cloud Logging sin la biblioteca de Error Reporting para Node.js. Para que Error Reporting infiera eventos de error a partir de los registros, las entradas de registro deben cumplir con los requisitos de formato de error y almacenarse en un bucket de registros que no sea de CMEK y que pertenezca al proyecto de origen o al proyecto de destino al que se enrutaron los registros.

Antes de comenzar

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.

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.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Error Reporting API , if it is not already enabled.

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

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.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Error Reporting API , if it is not already enabled.

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

1. 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 eventos de errores que informan las aplicaciones de Node.js que se ejecutan en casi cualquier lugar.

1. Usa npm para instalar el paquete:

   npm install @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.

Configura 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

Para 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 Google Cloud servicios otorgan automáticamente el rol de Writer de Error Reporting (roles/errorreporting.writer) a la cuenta de servicio correspondiente. Sin embargo, debes otorgar este rol a la cuenta de servicio adecuada para algunos servicios.

Cloud Run y Cloud Run Functions

La cuenta de servicio predeterminada que usa Cloud Run tiene los permisos del rol de escritor de Error Reporting (roles/errorreporting.writer).

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

Cloud Run está configurado para usar Error Reporting automáticamente. 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: Error Reporting crea automáticamente un evento de error cuando una entrada de registro contiene un seguimiento de pila y el nivel de gravedad de la entrada de registro no está configurado o está configurado en al menos ERROR.

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!');

Entorno flexible de App Engine

App Engine otorga automáticamente el rol de escritor de Error Reporting (roles/errorreporting.writer) a tu 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 las entradas del registro de errores escritas en stderr, sin necesidad de usar directamente la biblioteca de Error Reporting para Node.js.

Google Kubernetes Engine

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

1. Asegúrate de que a la cuenta de servicio que usará tu contenedor se le haya otorgado el rol de escritor de Error Reporting (roles/errorreporting.writer).

   Puedes usar la cuenta de servicio predeterminada de Compute Engine o una cuenta de servicio 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, el siguiente comando create 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 su cuenta de servicio.

Compute Engine

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

1. Asegúrate de que a la cuenta de servicio que usará tu instancia de VM se le haya otorgado el rol de escritor de Error Reporting (roles/errorreporting.writer).

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

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

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

   Ir a Instancias de VM

   Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuyo subtítulo es Compute Engine.

3. Selecciona la instancia de VM que deseas que reciba el permiso de acceso 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.

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

Para 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 a la biblioteca de Error Reporting para Node.js las credenciales predeterminadas de la aplicación local. Para obtener más información, consulta Cómo autenticarse en Error Reporting.

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

1. Instala Google Cloud CLI.

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

3. Si usas una shell local, crea credenciales de autenticación locales para tu cuenta de usuario:

   gcloud auth application-default login

   No es necesario que lo hagas si usas Cloud Shell.

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

   gcloud auth application-default set-quota-project PROJECT_ID

   Si se devuelve un error de autenticación y usas un proveedor de identidad (IdP) externo, confirma que accediste a la gcloud CLI con tu identidad federada.

Si deseas 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!');

Cómo ver grupos de errores

En la consola de Google Cloud , ve a la página Error Reporting:

Ir a Error Reporting

También puedes usar la barra de búsqueda para encontrar esta página.

Para obtener más información, consulta Cómo ver y filtrar grupos de errores.