Configura alertas para las invocaciones con errores del flujo de trabajo

En este documento, se muestra cómo configurar alertas basadas en registros para invocaciones de flujos de trabajo con errores en Dataform mediante el Explorador de registros.

Puedes usar Cloud Monitoring a fin de observar las tendencias en los registros de Cloud Logging para invocaciones del flujo de trabajo de Dataform y notificarte cuando ocurren condiciones que describe.

Cada invocación de flujo de trabajo de Dataform se registra mediante Cloud Logging. Logging se habilita automáticamente para las invocaciones del flujo de trabajo de Dataform, que pueden generar cargos de facturación de Cloud Logging. Para obtener más información, consulta Precios de Dataform.

Para recibir alertas cuando una invocación del flujo de trabajo de Dataform falla, puedes crear alertas basadas en registros.

Puedes crear alertas basadas en registros desde la página Explorador de registros en Google Cloud Console o mediante la API de Monitoring. En esta guía, se describe cómo crear alertas basadas en registros para fallas de invocación del flujo de trabajo de Dataform mediante el Explorador de registros.

Antes de comenzar

A fin de crear y administrar alertas basadas en registros, asegúrate de que tu función de Identity and Access Management incluya los permisos que se describen en Permisos para alertas basadas en registros.

Configure alertas basadas en registros para invocaciones fallidas de flujos de trabajo de Dataform

Para configurar alertas basadas en registros de invocaciones fallidas de flujos de trabajo de Dataform, sigue estos pasos:

  1. En la consola de Google Cloud, selecciona Logging y, luego, Explorador de registros:

    Ir al Explorador de registros.

  2. En el panel Consulta, selecciona Mostrar consulta y, luego, ingresa la siguiente consulta:

        resource.type="dataform.googleapis.com/Repository"
    jsonPayload.@type="type.googleapis.com/google.cloud.dataform.logging.v1.WorkflowInvocationCompletionLogEntry"
    jsonPayload.terminalState="FAILED"

    Esta consulta le alerta sobre todas las invocaciones del flujo de trabajo de Dataform con errores.

    1. Opcional: Para filtrar las invocaciones con errores del flujo de trabajo según una configuración de lanzamiento, agrega lo siguiente a la consulta:

      jsonPayload.releaseConfigId="RELEASE_CONFIGURATION_ID"

    2. Opcional: Para filtrar las invocaciones con errores del flujo de trabajo mediante una configuración del flujo de trabajo, agrega lo siguiente a la consulta:

      jsonPayload.workflowConfigId="WORKFLOW_CONFIGURATION_ID"

    La siguiente consulta genera una alerta cuando falla una invocación de flujo de trabajo de Dataform relacionada con la configuración de lanzamiento daily y la configuración del flujo de trabajo production:

     resource.type="dataform.googleapis.com/Repository"
 jsonPayload.@type="type.googleapis.com/google.cloud.dataform.logging.v1.WorkflowInvocationCompletionLogEntry"
 jsonPayload.terminalState="FAILED"
 jsonPayload.releaseConfigId="daily"
 jsonPayload.workflowConfigId="production"

  3. Opcional: Use Run query en el panel Query results para validar la consulta.

  4. En el encabezado del panel Resultados de la consulta, haz clic en Crear alerta. Cuando la ventana sea limitada, la opción Crear alerta podría aparecer en el menú Acciones.

  5. En el panel Detalles de la alerta, asigne un nombre y una descripción a la alerta:

    1. Ingrese un nombre para su alerta en el campo Nombre de la alerta. Por ejemplo: “Dataform: falla en el flujo de trabajo”.

    2. Ingresa una descripción de esta alerta. También puedes incluir información que podría ayudar al destinatario de una notificación a diagnosticar el problema. En la siguiente string, se resume el motivo de la alerta:

      Log-based alert in project ${project} detected a failed Dataform workflow.

      Si deseas obtener información para dar formato al contenido de este campo y adaptarlo, consulta Cómo usar Markdown y variables en las plantillas de documentación.

  6. Para avanzar al paso siguiente, haz clic en Siguiente.

  7. En el panel Elegir registros para incluir en el alerta, haz clic en Obtener vista previa de los registros para verificar la consulta y los resultados.

    Recomendamos compilar la consulta en el panel Consulta del Explorador de registros. La consulta que compilaste en el panel Query también se muestra en este panel.

    Si es necesario, puedes editar la consulta en este panel. Si editas la consulta, haz clic en Obtener vista previa de los registros para verificar los resultados.

  8. Haz clic en Siguiente.

  9. Selecciona el tiempo mínimo entre notificaciones. Este valor te permite controlar la cantidad de notificaciones que recibes de esta alerta si se activa varias veces. Para este ejemplo, selecciona 5 min en las opciones.

  10. Selecciona la duración del cierre automático de incidentes (opcional). De forma predeterminada, la duración del cierre automático de incidentes se establece en 7 días.

  11. Haz clic en Siguiente.

  12. Selecciona uno o más canales de notificaciones para tu alerta. Para este ejemplo, selecciona un canal de notificaciones por correo electrónico.

    Si ya tienes configurado un canal de notificaciones por correo electrónico, puedes seleccionarlo de la lista. Si no es así, haz clic en Administrar canales de notificaciones y agrega un canal de correo electrónico. Para obtener información sobre cómo crear canales de notificación, consulta Administra canales de notificaciones.

  13. Haz clic en Guardar.

Tu alerta basada en registros ya está lista para probarse. Si quieres obtener instrucciones para probar la alerta, consulta Prueba la alerta basada en registros de ejemplo.

¿Qué sigue?