Configurare gli avvisi per le invocazioni del flusso di lavoro non riuscite

Questo documento illustra come configurare avvisi basati su log per le chiamate del flusso di lavoro Dataform non riuscite utilizzando Esplora log.

Puoi utilizzare Cloud Monitoring per osservare le tendenze nei log di Cloud Logging per le invocazioni dei flussi di lavoro di Dataform e per ricevere una notifica quando si verificano le condizioni che descrivi.

Ogni chiamata al flusso di lavoro Dataform viene registrata utilizzando Cloud Logging. La registrazione è attivata automaticamente per le invocazioni del flusso di lavoro Dataform, che possono comportare addebiti di fatturazione di Cloud Logging. Per ulteriori informazioni, consulta Prezzi di Dataform.

Per ricevere avvisi quando l'invocazione di un workflow Dataform non va a buon fine, puoi creare avvisi basati su log.

Puoi creare avvisi basati su log dalla pagina Esplora log nella console Google Cloud o utilizzando l'API Monitoring. Questa guida descrive come creare avvisi basati su log per gli errori di chiamata del flusso di lavoro Dataform utilizzando Esplora log.

Prima di iniziare

Per creare e gestire gli avvisi basati su log, assicurati che il tuo ruolo Identity and Access Management includa le autorizzazioni descritte in Autorizzazioni per gli avvisi basati su log.

Configurare gli avvisi basati su log per le invocazioni del flusso di lavoro Dataform non riuscite

Per configurare gli avvisi basati su log per le invocazioni del flusso di lavoro Dataform non riuscite:

  1. Nella console Google Cloud, seleziona Logging, quindi Esplora log:

    Vai a Esplora log

  2. Nel riquadro Query, seleziona Mostra query e inserisci la seguente query:

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

    Questa query ti avvisa di tutte le invocazioni del flusso di lavoro Dataform non riuscite.

    1. (Facoltativo) Per filtrare le chiamate del flusso di lavoro non riuscite in base a una configurazione della release, aggiungere quanto segue alla query:

      jsonPayload.releaseConfigId="RELEASE_CONFIGURATION_ID"

    2. (Facoltativo) Per filtrare le chiamate del flusso di lavoro non riuscite in base a una configurazione del flusso di lavoro, aggiungere quanto segue alla query:

      jsonPayload.workflowConfigId="WORKFLOW_CONFIGURATION_ID"

    La seguente query genera avvisi quando un'invocazione del flusso di lavoro Dataform relativa sia alla configurazione della release daily sia alla configurazione del flusso di lavoro production non va a buon fine:

     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. (Facoltativo) Utilizza Esegui query nel riquadro Risultati delle query per convalidare la query.

  4. Nell'intestazione del riquadro Risultati delle query, fai clic su Crea avviso. Quando la finestra è stretta, l'opzione Crea avviso potrebbe essere visualizzata nel menu Azioni.

  5. Nel riquadro Dettagli avviso, assegna all'avviso un nome e una descrizione:

    1. Inserisci un nome per l'avviso nel campo Nome avviso. Ad esempio: "Dataform: workflow failure".

    2. Inserisci una descrizione di questo avviso. Puoi anche includere informazioni che potrebbero aiutare il destinatario di una notifica a diagnosticare il problema. La seguente stringa riassume il motivo dell'avviso:

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

      Per informazioni su come formattare e personalizzare i contenuti di questo campo, consulta Utilizzo di Markdown e variabili nei modelli di documentazione.

  6. Per passare al passaggio successivo, fai clic su Avanti.

  7. Nel riquadro Scegli i log da includere nell'avviso, controlla la query e i risultati facendo clic su Anteprima dei log.

    Ti consigliamo di creare la query nel riquadro Query di Esplora log. In questo riquadro viene visualizzata anche la query che hai creato nel riquadro Query.

    Se necessario, puoi modificare la query in questo riquadro. Se modifichi la query, controlla i risultati facendo clic su Anteprima dei log.

  8. Fai clic su Avanti.

  9. Seleziona il tempo minimo tra le notifiche. Questo valore consente di controllare il numero di notifiche che ricevi da questo avviso se viene attivato più volte. Per questo esempio, seleziona 5 min tra le opzioni.

  10. (Facoltativo) Seleziona la durata della chiusura automatica degli incidenti. Per impostazione predefinita, la durata della chiusura automatica degli incidenti è impostata su 7 giorni.

  11. Fai clic su Avanti.

  12. Seleziona uno o più canali di notifica per il tuo avviso. In questo esempio, seleziona un canale di notifica via email.

    Se hai già configurato un canale di notifica via email, puoi selezionarlo dall'elenco. In caso contrario, fai clic su Gestisci canali di notifica e aggiungi un canale email. Per informazioni sulla creazione dei canali di notifica, consulta Gestire i canali di notifica.

  13. Fai clic su Salva.

L'avviso basato sui log è ora pronto per il test. Per le istruzioni su come testare l'avviso, consulta Eseguire il test dell'avviso basato su log di esempio.

Passaggi successivi