Recoger datos de errores con Error Reporting

En este documento se enumeran los entornos compatibles con Error Reporting y se incluyen enlaces a guías específicas de cada lenguaje para desarrolladores de aplicaciones. Te recomendamos que uses las bibliotecas de cliente específicas de cada lenguaje o que te decantes por las entradas de registro recogidas automáticamente. Sin embargo, puedes escribir datos de errores con la API Cloud Logging o la API 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 basado en Cloud Logging que puede analizar entradas de registro cuando se cumplen todas las condiciones siguientes:

  • 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 cifrado gestionadas por el cliente (CMEK) están inhabilitadas en todos los segmentos de registro que almacenan la entrada de registro. Error Reporting no puede almacenar entradas de registro en segmentos de registro que tengan habilitada la CMEK. Para obtener información sobre cómo determinar la configuración de CMEK de un contenedor de registro, consulta Verificar la habilitación de claves.
  • El contenedor de registro cumple una de las siguientes condiciones:
    • El segmento de registro 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, a continuación, ese proyecto almacenó las entradas de registro en un segmento de registro de su propiedad.

Compatibilidad con la nube privada virtual

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

Para reducir el riesgo de filtración externa de datos, usa Controles de Servicio de VPC para crear un perímetro de servicio alrededor de tus servicios gestionados por Google. Para obtener información sobre Controles de Servicio de VPC y cómo crear un parámetro de servicio, consulta la documentación de Controles de Servicio de VPC.

Configurar entornos para que envíen automáticamente datos de errores

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

Instrumentar aplicaciones con bibliotecas de 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 de cada lenguaje:

Escribir datos de error mediante una API

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

  • Si necesitas la autenticación basada en claves de API, debes usar la API Error Reporting. Para registrar un evento de error mediante la API 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 Error Reporting, se generan automáticamente entradas de registro con mensajes de error con el formato adecuado 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

    Como las entradas de registro se generan mediante llamadas a report, es posible que se te apliquen costes de ingestión de Cloud Logging. Para controlar qué entradas de registro se ingieren, consulta Filtros de exclusión.

    Si informa de eventos de error mediante la API Error Reporting, el resto de este documento no se aplica.

  • Si quiere usar la API Cloud Logging, debe 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 Errores de formato en los registros.