Configura alertas para las invocaciones de flujo de trabajo que fallan

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

Puedes usar Cloud Monitoring para observar las tendencias en los registros de Cloud Logging de las invocaciones de flujos de trabajo de Dataform y para notificarte cuando se produzcan las condiciones que describes.

Cada invocación de flujo de trabajo de Dataform se registra con Cloud Logging. El registro se habilita automáticamente para las invocaciones de flujos de trabajo de Dataform, lo que puede generar cargos de facturación de Cloud Logging. Para obtener más información, consulta Precios de Dataform.

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

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

Antes de comenzar

Para crear y administrar alertas basadas en registros, asegúrate de que tu rol de Identity and Access Management incluya los permisos que se describen en Permisos para alertas basadas en registros.

Configura alertas basadas en registros para las invocaciones de flujo de trabajo de Dataform que fallan

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

  1. En la consola de Google Cloud, selecciona Registro 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 te alerta sobre todas las invocaciones de flujo de trabajo de Dataform que fallaron.

    1. Opcional: Para filtrar las invocaciones de flujo de trabajo fallidas por una configuración de lanzamiento, agrega lo siguiente a la consulta:

      jsonPayload.releaseConfigId="RELEASE_CONFIGURATION_ID"

    2. Opcional: Para filtrar las invocaciones de flujo de trabajo fallidas por una configuración de flujo de trabajo, agrega lo siguiente a la consulta:

      jsonPayload.workflowConfigId="WORKFLOW_CONFIGURATION_ID"

    La siguiente consulta alerta cuando falla una invocación de flujo de trabajo de Dataform relacionada con la configuración de lanzamiento de daily y la configuración del flujo de trabajo de 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: Usa Ejecutar consulta en el panel Resultados de la consulta para validar la consulta.

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

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

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

    2. Ingresa una descripción de esta alerta. También puedes incluir información que pueda ayudar al destinatario de una notificación a diagnosticar el problema. La siguiente cadena resume el motivo de la alerta:

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

      Para obtener información sobre cómo puedes dar formato y adaptar el contenido de este campo, consulta Cómo usar Markdown y variables en 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 creaste en el panel Consulta 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 de las opciones.

  10. Opcional: Selecciona la duración del cierre automático de incidentes. 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 notificaciones, consulta Cómo administrar canales de notificaciones.

  13. Haz clic en Guardar.

Tu alerta basada en registros ya está lista para probarse. Para obtener instrucciones para probar la alerta, consulta Cómo probar la alerta basada en registros de ejemplo.

¿Qué sigue?