Recopila 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 para cada lenguaje para los desarrolladores de aplicaciones. Te recomendamos que uses las bibliotecas cliente específicas del lenguaje o que confíes en las entradas de registro recopiladas automáticamente. Sin embargo, puedes escribir datos de error 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 automáticamente a Cloud Logging.

Error Reporting es un servicio global compilado en Cloud Logging y puede analizar entradas de registro cuando se cumplen todas las siguientes condiciones:

  • Las cargas de trabajo de Assured Workloads están inhabilitadas. Para obtener más información, consulta la Descripción general de Assured Workloads.
  • Las claves de encriptación administradas por el cliente (CMEK) están inhabilitadas en todos los buckets de registros que almacenan la entrada de registro. Error Reporting no puede almacenar entradas de registro en buckets de registros que tienen habilitada la CMEK. Para obtener información sobre cómo determinar la configuración de CMEK de un bucket de registros, consulta Verifica la habilitación de la clave.
  • El bucket de registros satisface una de las siguientes condiciones:
    • 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 almacenó esas entradas de registro en un bucket de registros que le pertenece.

Compatibilidad con la nube privada virtual

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

Para reducir el riesgo de robo de datos, usa los Controles del servicio de VPC para crear un perímetro de servicio alrededor de tus 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 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

Para 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 error con una API

Puedes informar eventos de error a tu proyecto de Google Cloud ejecutando el método de la API de Error Reportingreport o el método de la API de Cloud Loggingwrite.

  • Si necesitas 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 formatea el cuerpo de la solicitud del método como un objeto ReportedErrorEvent.

    Cuando usas la API de Error Reporting, se generan automáticamente entradas de registro con mensajes de error con el formato correcto y se escriben 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

    Dado que las entradas de registro se generan a partir de llamadas a report, es posible que incurras en costos de transferencia de Cloud Logging. Para controlar qué entradas de registro se transfieren, consulta Filtros de exclusión.

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

  • Si deseas usar la API de Cloud Logging, debes darle 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 Formato de errores en los registros.