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 para crear grupos de errores en los siguientes casos:
- Un bucket de registros que contiene tus entradas de registro tiene claves de encriptación administradas por el cliente (CMEK).
- El bucket de registros satisface una de las siguientes opciones:
- El bucket de registros se almacena en el mismo proyecto en el que se originaron las entradas de registro.
- Las entradas de registro se enrutaron a un proyecto y, luego, ese proyecto las almacenó en un bucket de registros que le pertenece.
- Quieres 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
- Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Make sure that billing is enabled for your Google Cloud project.
-
Enable the Error Reporting API .
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Make sure that billing is enabled for your Google Cloud project.
-
Enable the Error Reporting API .
- Prepara el entorno para el desarrollo en 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 en casi cualquier lugar.
-
Usa npm para instalar el paquete:
npm install --save @google-cloud/error-reporting
-
Importa la biblioteca y crea una instancia de cliente para comenzar a informar errores:
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 servicios de Google Cloud otorgan automáticamente el rol de escritor de informes de errores (roles/errorreporting.writer
) a la cuenta de servicio adecuada. Sin embargo, debes otorgar este rol a la cuenta de servicio adecuada para algunos servicios.
Cloud Run y funciones de Cloud Run
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 de forma 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.
Ejemplo:Entorno flexible de App Engine
App Engine otorga el
rol de escritor de Error Reporting (roles/errorreporting.writer
)
a tu cuenta de servicio predeterminada automáticamente.
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.Google Kubernetes Engine
Para usar Error Reporting con Google Kubernetes Engine, haz lo siguiente:
Asegúrate de que la cuenta de servicio que usará tu contenedor tenga 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.
Crea tu clúster y bríndale el nivel de acceso
cloud-platform
.Por ejemplo, el siguiente comando de creación 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
Compute Engine
Para usar Error Reporting con instancias de VM de Compute Engine, haz lo siguiente:
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.
-
En la consola de Google Cloud, ve a la página Instancias de VM.
Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuyo subtítulo es Compute Engine.
Selecciona la instancia de VM a la que deseas que se le asigne el alcance de acceso
cloud-platform
.Haz clic en Detener y, luego, en Editar.
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
).En la sección Permisos de acceso, selecciona Permitir el acceso total a todas las APIs de Cloud y, luego, guarda los cambios.
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:
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:
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 autenticar en Error Reporting.
Para usar las muestras de Node.js de esta página en un entorno de desarrollo local, instala e inicializa gcloud CLI y, luego, configura las credenciales predeterminadas de la aplicación con tus credenciales de usuario.
- Install the Google Cloud CLI.
-
To initialize the gcloud CLI, run the following command:
gcloud init
-
If you're using a local shell, then create local authentication credentials for your user account:
gcloud auth application-default login
You don't need to do this if you're using Cloud Shell.
Para obtener más información, consulta Set up authentication for a local development environment.
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.
Ve informes de errores
En la consola de Google Cloud, ve a la página 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 visualizar errores.