Recopilar datos de errores con Error Reporting

En este documento, se enumeran los entornos compatibles con Error Reporting y se incluyen vínculos a guías específicas del lenguaje para desarrolladores de aplicaciones. Te recomendamos que uses las bibliotecas cliente específicas del lenguaje o que te bases en los registros recopilados automáticamente. Sin embargo, puedes escribir datos de errores con la API de Cloud Logging o la API de Error Reporting. Por ejemplo, si usas Cloud Run, las excepciones escritas en stderr se envían de forma automática a Cloud Logging.

Error Reporting es un servicio global que analiza automáticamente los registros en tu proyecto de Google Cloud para identificar errores. Sin embargo, Error Reporting solo puede analizar entradas de registro almacenadas en buckets de Cloud Logging que se encuentran en la región global, en la que los proyectos de Google Cloud de origen y de destino son los mismos, y en las que están inhabilitadas las claves de encriptación administradas por el cliente (CMEK). Si enrutas los registros a un proyecto de Google Cloud diferente, a buckets regionalizados o habilitas CMEK, Error Reporting no captura ni analiza esos registros. Para obtener información sobre cómo verificar la configuración de tus buckets de registros, consulta Solución de problemas.

Compatibilidad con nubes privadas virtuales

Error Reporting es un servicio compatible con la nube privada virtual (VPC).

A fin de reducir el riesgo de robo de datos, usa los Controles del servicio de VPC para crear un perímetro de servicio alrededor de los servicios administrados por Google. Para obtener información sobre los Controles del servicio de VPC y cómo crear un parámetro de servicio, consulta la documentación de los Controles del servicio de VPC.

Configura entornos para informar automáticamente los datos de errores

Para obtener información sobre los requisitos de configuración específicos del entorno, consulta las siguientes guías:

Instrumenta apps con bibliotecas cliente

Si deseas obtener información sobre cómo configurar tu aplicación para que envíe informes de errores, consulta las guías de configuración específicas del lenguaje:

Escribe datos de errores con una API

Puedes informar eventos de errores a tu proyecto de Google Cloud si ejecutas el método report de la API de Error Reporting o el método write de la API de Cloud Logging.

  • Si necesitas una autenticación basada en claves de API, debes usar la API de Error Reporting. Para informar un evento de error con la API de Error Reporting, ejecuta el método report y da formato al cuerpo de la solicitud del método como un objeto ReportedErrorEvent.

    Cuando usas la API de Error Reporting, las entradas de registro con mensajes de error con el formato correcto se generan y escriben de forma automática en Cloud Logging. Estas entradas de registro se escriben en un registro cuyo logName tiene el siguiente formato:

    projects/PROJECT_ID/clouderrorreporting.googleapis.com%2Freported_errors

    Debido a que las entradas de registro se generan mediante llamadas a report, es posible que se generen costos de transferencia de Cloud Logging. Para controlar qué registros se transfieren, consulta Filtros de exclusión.

    Si informas eventos de errores con la API de Error Reporting, el resto de este documento no se aplica.

  • Si deseas usar la API de Cloud Logging, debes dar formato al objeto LogEntry para que incluya un seguimiento de pila o un objeto ReportedErrorEvent. Para obtener más información sobre los requisitos de formato, consulta Da formato a los errores en los registros.