Configurar alertas para invocações de fluxo de trabalho com falha

Este documento mostra como configurar alertas com base em registros para invocações de fluxo de trabalho do Dataform com falha usando o Explorador de registros.

Você pode usar o Cloud Monitoring para observar tendências nos registros do Cloud Logging para invocações de fluxo de trabalho do Dataform e receber notificações quando as condições descritas ocorrerem.

Cada invocação de fluxo de trabalho do Dataform é registrada usando o Cloud Logging. A geração de registros é ativada automaticamente para invocações de fluxo de trabalho do Dataform, o que pode gerar cobranças do Cloud Logging. Para mais informações, consulte Preços do Dataform.

Para receber alertas quando uma invocação de fluxo de trabalho do Dataform falhar, crie alertas com base em registros.

É possível criar alertas com base em registros na página Explorador de registros no console do Google Cloud ou usando a API Monitoring. Este guia descreve como criar alertas com base em registros para falhas de invocação de fluxo de trabalho do Dataform usando o Explorador de registros.

Antes de começar

Para criar e gerenciar alertas com base em registros, verifique se o papel de gerenciamento de identidade e acesso inclui as permissões descritas em Permissões para alertas com base em registros.

Configurar alertas baseados em registros para invocações de fluxo de trabalho do Dataform com falha

Para configurar alertas baseados em registros para invocações de fluxo de trabalho do Dataform com falha, siga estas etapas:

  1. No console do Google Cloud, selecione Logging e, em seguida, selecione Análise de registros:

    Acesse o Explorador de registros

  2. No painel Consulta, selecione Mostrar consulta e insira a seguinte consulta:

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

    Essa consulta alerta você sobre todas as invocações de fluxo de trabalho do Dataform com falha.

    1. Opcional: para filtrar invocações de fluxo de trabalho com falha por uma configuração de lançamento, adicione o seguinte à consulta:

      jsonPayload.releaseConfigId="RELEASE_CONFIGURATION_ID"

    2. Opcional: para filtrar invocações de fluxo de trabalho com falha por uma configuração de fluxo de trabalho, adicione o seguinte à consulta:

      jsonPayload.workflowConfigId="WORKFLOW_CONFIGURATION_ID"

    A consulta a seguir alerta quando uma invocação de fluxo de trabalho do Dataform relacionada à configuração de lançamento daily e à configuração de fluxo de trabalho production falha:

     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 Executar consulta no painel Resultados da consulta para validar a consulta.

  4. No cabeçalho do painel Resultados da consulta, clique em Criar alerta. Quando a janela estiver estreita, a opção Create alert poderá aparecer no menu Actions.

  5. No painel Detalhes do alerta, forneça um nome e uma descrição para o alerta:

    1. Digite um nome para o alerta no campo Nome do alerta. Por exemplo: "Dataform: workflow failure".

    2. Digite uma descrição deste alerta. Você também pode incluir informações que possam ajudar o destinatário de uma notificação a diagnosticar o problema. A string a seguir resume o motivo do alerta:

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

      Para informações sobre como formatar e adaptar o conteúdo desse campo, consulte Como usar o Markdown e variáveis em modelos de documentação.

  6. Para avançar para a próxima etapa, clique em Próxima.

  7. No painel Escolher registros a serem incluídos no alerta, verifique a consulta e os resultados clicando em Visualizar registros.

    Recomendamos criar a consulta no painel Consulta do Explorador de registros. A consulta que você criou no painel Consulta também é exibida nesse painel.

    É possível editar a consulta neste painel, se necessário. Se você editar a consulta, verifique os resultados clicando em Visualizar registros.

  8. Clique em Próxima.

  9. Selecione o tempo mínimo entre as notificações. Esse valor permite controlar o número de notificações recebidas desse alerta, se ele for acionado várias vezes. Neste exemplo, selecione 5 minutos nas opções.

  10. Opcional: selecione a duração do fechamento automático do incidente. Por padrão, a duração do fechamento automático de incidentes é definida como 7 dias.

  11. Clique em Próxima.

  12. Selecione um ou mais canais de notificação para seu alerta. Neste exemplo, selecione um canal de notificação por e-mail.

    Se você já tiver um canal de notificação por e-mail configurado, selecione-o na lista. Caso contrário, clique em Gerenciar canais de notificação e adicione um canal de e-mail. Para saber mais sobre como criar canais de notificação, consulte Como gerenciar canais de notificação.

  13. Clique em Save.

Seu alerta com base em registros está pronto para ser testado. Para instruções sobre como testar o alerta, consulte Testar o exemplo de alerta com base em registro.

A seguir