Jobstatus mit Pub/Sub-Benachrichtigungen und BigQuery beobachten

In diesem Dokument wird erläutert, wie Sie Job- und Aufgabenstatusänderungen durch Einrichten von Pub/Sub-Benachrichtigungen überwachen können. Sie können die Benachrichtigungen für verschiedene Anwendungsfälle verwenden. In diesem Dokument wird beispielsweise erläutert, wie Sie die Benachrichtigungen in eine BigQuery-Tabelle streamen, um die Daten zu analysieren. Weitere Informationen zu den Anwendungsfällen für Pub/Sub-Benachrichtigungen finden Sie in der Pub/Sub-Dokumentation unter Abotyp auswählen.

Hinweise

  • Wenn Sie Batch noch nicht verwendet haben, lesen Sie Erste Schritte mit Batch. Aktivieren Sie Batch, indem Sie die Voraussetzungen für Projekte und Nutzer erfüllen.
  • Wenn Sie Pub/Sub-Benachrichtigungen für Ihre Batchjobs einrichten möchten, gehen Sie so vor:

    1. Pub/Sub API aktivieren.

      Aktivieren Sie die API

    2. Bitten Sie Ihren Administrator, Ihnen die IAM-Rolle Pub/Sub Editor (roles/pubsub.editor) für ein Projekt zu gewähren, um die Berechtigungen zu erhalten, die Sie zum Konfigurieren eines Pub/Sub-Themas und -Abos benötigen. Weitere Informationen zum Zuweisen von Rollen finden Sie unter Zugriff verwalten.

      Möglicherweise können Sie die erforderlichen Berechtigungen auch über benutzerdefinierte Rollen oder andere vordefinierte Rollen erhalten.

  • Die zusätzlichen Anforderungen variieren je nach Art des Abos, das Sie konfigurieren. Wenn Sie beispielsweise Benachrichtigungen in eine BigQuery-Tabelle streamen und analysieren möchten, müssen Sie Folgendes tun:

    1. BigQuery API aktivieren.

      Aktivieren Sie die API

    2. Bitten Sie Ihren Administrator, dem Pub/Sub-Dienstkonto die IAM-Rolle BigQuery-Dateneditor (roles/bigquery.dataEditor) für das Projekt des Pub/Sub-Themas zu gewähren, damit das Pub/Sub-Dienstkonto die erforderlichen Berechtigungen zum Streamen von Pub/Sub-Benachrichtigungen an BigQuery hat.

      Weitere Informationen zum Zuweisen dieser Rolle finden Sie unter Dem Pub/Sub-Dienstkonto BigQuery-Rollen zuweisen.

    3. Achten Sie darauf, dass alle Nutzer, die Benachrichtigungen in BigQuery analysieren möchten, die erforderlichen Berechtigungen haben.

      Bitten Sie Ihren Administrator, Ihnen die folgenden IAM-Rollen zu gewähren, damit Sie die erforderlichen Berechtigungen zum Abfragen von Pub/Sub-Benachrichtigungen in BigQuery erhalten:

Pub/Sub-Benachrichtigungen für Batch einrichten

Batch unterstützt Pub/Sub-Benachrichtigungen bei Änderungen an Job- und Aufgabenstatus, die Sie für Warnmeldungen, Beobachtbarkeit oder Analysen verwenden können.

Führen Sie die in den folgenden Abschnitten beschriebenen Schritte aus, um Pub/Sub-Benachrichtigungen für einen oder mehrere Batchjobs einzurichten:

  1. Pub/Sub-Thema für Batchjobs erstellen oder identifizieren
  2. Erstellen Sie mindestens ein Abo für Ihr Thema, um die zugehörigen Benachrichtigungen zu erhalten und zu verwenden.
  3. Konfigurieren Sie Jobs so, dass Benachrichtigungen an Ihr Thema gesendet werden.

Nachdem Sie Pub/Sub-Benachrichtigungen für Batch eingerichtet haben, können Sie jeden Job optional so konfigurieren, dass bestimmte Benachrichtigungen gesendet werden. Sie können Benachrichtigungen erhalten, wenn sich Job- oder Aufgabenstatus ändern. Sie können sie aber auch nach bestimmten Job- oder Aufgabenstatus filtern. Pub/Sub sendet keine Benachrichtigungen für den ersten Status, den ein Job oder eine Aufgabe eingibt. Pub/Sub sendet nur Benachrichtigungen, wenn ein Job von einem Status in einen anderen wechselt. Weitere Informationen zu den Attributen, die Sie für Pub/Sub-Benachrichtigungen konfigurieren können, finden Sie unter Job erstellen und ausführen, der Pub/Sub-Statusbenachrichtigungen sendet.

Pub/Sub-Thema für Batch erstellen oder identifizieren

Erstellen Sie ein neues Pub/Sub-Thema oder identifizieren Sie ein vorhandenes Pub/Sub-Thema, das Sie für Batch-Benachrichtigungen verwenden möchten.

Wie weiter unten in diesem Dokument erläutert, können Jobs erst dann Benachrichtigungen an dieses Pub/Sub-Thema senden, wenn Ihr Administrator zusätzliche Berechtigungen erteilt hat, die dies zulassen.

Erstelle ein Abo, um Benachrichtigungen zu erhalten und zu verwenden

Damit Sie in einem Pub/Sub-Thema veröffentlichte Nachrichten empfangen und verwenden können, müssen Sie mindestens ein Abo für dieses Thema erstellen.

Eine Option besteht beispielsweise darin, das Thema so zu konfigurieren, dass seine Benachrichtigungen an BigQuery gestreamt werden. Wenn Sie dann Jobs ausführen, die Benachrichtigungen veröffentlichen, können Sie die Benachrichtigungen in einer BigQuery-Tabelle empfangen und analysieren. Weitere Informationen finden Sie in diesem Dokument unter Beispiel: Pub/Sub-Benachrichtigungen in BigQuery empfangen und verwenden.

Andernfalls finden Sie in der Pub/Sub-Dokumentation unter Aboübersicht weitere Informationen zu Abos und anderen Abooptionen.

Jobs zum Senden von Benachrichtigungen an Ihr Thema konfigurieren

Folgen Sie der Anleitung auf der Seite Job erstellen und ausführen, der Pub/Sub-Statusbenachrichtigungen sendet, um Jobs zu konfigurieren, die Pub/Sub-Benachrichtigungen an Ihr Thema senden. Führen Sie insbesondere folgende Schritte aus:

  1. Falls noch nicht geschehen, bitten Sie Ihren Administrator, alle Berechtigungen zu gewähren, die Jobs zum Senden von Benachrichtigungen an Ihr Pub/Sub-Thema benötigen. Diese Berechtigungen sind im Abschnitt Erforderliche Rollen auf dieser Seite aufgeführt.
  2. Erstellen Sie einen Job, der Pub/Sub-Benachrichtigungen aktiviert, und führen Sie ihn aus. Definieren Sie dazu das Feld notifications des Jobs.

Beispiel: Pub/Sub-Benachrichtigungen in BigQuery empfangen und verwenden

In den folgenden Abschnitten wird ein Anwendungsfall für das Empfangen und Verwenden von Pub/Sub-Benachrichtigungen in BigQuery erläutert. Wenn Sie ein Abo konfigurieren, mit dem die Pub/Sub-Benachrichtigungen Ihres Themas an eine BigQuery-Tabelle gestreamt werden, können Sie den Verlauf der Job- und Aufgabenstatusänderungen beibehalten und diese Änderungen abfragen.

Abo konfigurieren, das Benachrichtigungen an BigQuery streamt

Konfigurieren Sie ein Pub/Sub-Abo, das Benachrichtigungen von einem Thema in eine BigQuery-Tabelle streamt. Gehen Sie dazu so vor:

  1. Erstellen oder identifizieren Sie ein Pub/Sub-Thema für Batch, falls noch nicht geschehen.

  2. Erstellen Sie ein BigQuery-Dataset, sofern Sie noch keines haben.

  3. Erstellen Sie eine BigQuery-Tabelle mit der folgenden Schemadefinition:

    [
  {
    "name": "data",
    "type": "STRING"
  },
  {
    "name": "subscription_name",
    "type": "STRING"
  },
  {
    "name": "message_id",
    "type": "STRING"
  },
  {
    "name": "attributes",
    "type": "JSON"
  },
  {
    "name": "publish_time",
    "type": "TIMESTAMP",
    "mode": "NULLABLE"
  }
]

  4. Erstellen Sie ein Pub/Sub-Abo, das an BigQuery streamt, und geben Sie die folgenden Optionen an:

    • Thema: Wählen Sie das Pub/Sub-Thema für Batch aus.
    • Project (Projekt): Wählen Sie das Projekt aus, das Ihre BigQuery-Tabelle enthält.
    • Dataset: Wählen Sie das Dataset aus, das Ihre BigQuery-Tabelle enthält.
    • Tabelle: Wählen Sie die Tabelle aus, die Sie im vorherigen Schritt erstellt haben.
    • Wählen Sie Schema des Themas verwenden aus.
    • Wählen Sie Metadaten schreiben aus.

Wenn nun eine Pub/Sub-Benachrichtigung an dieses Thema gesendet wird, streamt Pub/Sub diese Benachrichtigung an die BigQuery-Tabelle. Nachdem Sie Jobs zum Senden von Pub/Sub-Benachrichtigungen konfiguriert haben, können Sie Benachrichtigungen in BigQuery analysieren.

Benachrichtigungen in BigQuery analysieren

Sie können Benachrichtigungen in BigQuery analysieren, nachdem Sie ein Abo für eine BigQuery-Tabelle für Ihr Thema konfiguriert und Jobs ausgeführt haben, die Benachrichtigungen an Ihr Thema senden. Zum Analysieren der Benachrichtigungen in BigQuery führen Sie eine Abfrage in der Spalte attributes der BigQuery-Tabelle aus. Welche Attribute Sie abfragen können, hängt davon ab, ob Sie Benachrichtigungen für Aufgaben oder Jobs konfiguriert haben.

Sie können die folgenden Attribute von Aufgabenbenachrichtigungen abfragen:

  • JobUID
  • NewTaskState
  • Region
  • TaskName
  • TaskUID
  • Type

Sie können die folgenden Attribute von Jobbenachrichtigungen abfragen:

  • JobUID
  • JobName
  • NewJobState
  • Region
  • Type

Die folgende Abfrage zeigt beispielsweise das JobUID, das jeder Benachrichtigung zugeordnet ist:

select attributes.JobUID from `example-table`

Nächste Schritte