Benachrichtigungen für fehlgeschlagene Workflowaufrufe konfigurieren

In diesem Dokument wird beschrieben, wie Sie mit dem Log-Explorer logbasierte Benachrichtigungen für fehlgeschlagene Dataform-Workflowaufrufe konfigurieren.

Mit Cloud Monitoring können Sie Trends in Cloud Logging-Logs für Dataform-Workflowaufrufe beobachten und Sie benachrichtigen, wenn von Ihnen beschriebene Bedingungen eintreten.

Jeder Aufruf eines Dataform-Workflows wird mithilfe von Cloud Logging protokolliert. Logging ist für Dataform-Workflowaufrufe automatisch aktiviert, für die Gebühren für Cloud Logging anfallen können. Weitere Informationen finden Sie unter Dataform-Preise.

Wenn Sie benachrichtigt werden möchten, wenn ein Dataform-Workflowaufruf fehlschlägt, können Sie logbasierte Benachrichtigungen erstellen.

Sie können logbasierte Benachrichtigungen auf der Seite Log-Explorer der Google Cloud Console oder mithilfe der Monitoring API erstellen. In diesem Leitfaden wird beschrieben, wie Sie mit dem Log-Explorer logbasierte Benachrichtigungen für Fehler beim Aufruf eines Dataform-Workflows erstellen.

Hinweise

Zum Erstellen und Verwalten logbasierter Benachrichtigungen muss Ihre Identity and Access Management-Rolle die unter Berechtigungen für logbasierte Benachrichtigungen beschriebenen Berechtigungen haben.

Logbasierte Benachrichtigungen für fehlgeschlagene Dataform-Workflow-Aufrufe konfigurieren

So konfigurieren Sie logbasierte Benachrichtigungen für fehlgeschlagene Dataform-Workflowaufrufe:

  1. Wählen Sie in der Google Cloud Console Logging und dann Log-Explorer aus:

    Zu „Log-Explorer“

  2. Wählen Sie im Bereich Abfrage die Option Abfrage anzeigen aus und geben Sie die folgende Abfrage ein:

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

    Mit dieser Abfrage werden Sie über alle fehlgeschlagenen Dataform-Workflowaufrufe informiert.

    1. Optional: Wenn Sie fehlgeschlagene Workflowaufrufe nach einer Releasekonfiguration filtern möchten, hängen Sie Folgendes an die Abfrage an:

      jsonPayload.releaseConfigId="RELEASE_CONFIGURATION_ID"

    2. Optional: Wenn Sie fehlgeschlagene Workflowaufrufe nach einer Workflowkonfiguration filtern möchten, hängen Sie Folgendes an die Abfrage an:

      jsonPayload.workflowConfigId="WORKFLOW_CONFIGURATION_ID"

    Die folgende Abfrage benachrichtigt, wenn ein Dataform-Workflowaufruf sowohl zur Releasekonfiguration daily als auch zur Workflowkonfiguration production fehlschlägt:

     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. Optional: Verwenden Sie im Bereich Abfrageergebnisse die Option Abfrage ausführen, um die Abfrage zu validieren.

  4. Klicken Sie im Header des Bereichs Abfrageergebnisse auf Benachrichtigung erstellen. Wenn das Fenster schmal ist, wird stattdessen möglicherweise die Option Benachrichtigung erstellen im Menü Aktionen angezeigt.

  5. Geben Sie im Bereich Benachrichtigungsdetails einen Namen und eine Beschreibung für die Benachrichtigung ein:

    1. Geben Sie im Feld Benachrichtigungsname einen Namen für die Benachrichtigung ein. Beispiel: „Dataform: Workflowfehler“.

    2. Geben Sie eine Beschreibung dieser Benachrichtigung ein. Sie können auch Informationen angeben, die dem Empfänger einer Benachrichtigung helfen können, das Problem zu diagnostizieren. Der folgende String fasst den Grund für die Benachrichtigung zusammen:

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

      Informationen zum Formatieren und Anpassen des Inhalts dieses Felds finden Sie unter Markdown und Variablen in Dokumentationsvorlagen verwenden.

  6. Um mit dem nächsten Schritt fortzufahren, klicken Sie auf Weiter.

  7. Prüfen Sie im Bereich Logs auswählen, die in die Benachrichtigung aufgenommen werden sollen die Abfrage und die Ergebnisse. Klicken Sie dazu auf Logvorschau ansehen.

    Wir empfehlen, die Abfrage im Bereich Abfrage des Log-Explorers zu erstellen. Die Abfrage, die Sie im Bereich Query erstellt haben, wird ebenfalls in diesem Bereich angezeigt.

    Bei Bedarf können Sie die Abfrage in diesem Bereich bearbeiten. Prüfen Sie beim Bearbeiten der Abfrage die Ergebnisse. Klicken Sie dazu auf Logs anzeigen.

  8. Klicken Sie auf Next (Weiter).

  9. Wählen Sie die Mindestdauer zwischen Benachrichtigungen aus. Mit diesem Wert können Sie die Anzahl der Benachrichtigungen dieser Art steuern, wenn sie mehrmals ausgelöst wird. Wählen Sie für dieses Beispiel 5 Min. aus den Optionen aus.

  10. Optional: Wählen Sie die Dauer für das automatische Schließen von Vorfällen aus. Die Dauer für das automatische Schließen von Vorfällen ist standardmäßig auf 7 Tage eingestellt.

  11. Klicken Sie auf Next (Weiter).

  12. Wählen Sie einen oder mehrere Benachrichtigungskanäle für Ihre Benachrichtigung aus. Wählen Sie für dieses Beispiel einen E-Mail-Benachrichtigungskanal aus.

    Wenn Sie bereits einen E-Mail-Benachrichtigungskanal konfiguriert haben, können Sie ihn aus der Liste auswählen. Wenn nicht, klicken Sie auf Benachrichtigungskanäle verwalten und fügen Sie einen E-Mail-Kanal hinzu. Informationen zum Erstellen von Benachrichtigungskanälen finden Sie unter Benachrichtigungskanäle verwalten.

  13. Klicken Sie auf Speichern.

Ihre logbasierte Benachrichtigung kann jetzt getestet werden. Eine Anleitung zum Testen der Benachrichtigung finden Sie unter Beispiel für eine logbasierte Benachrichtigung testen.

Nächste Schritte