Firebase-Benachrichtigungsereignisse an Workflows weiterleiten

Ein Eventarc-Trigger deklariert Ihr Interesse an einem bestimmten Ereignis oder einer Reihe von Ereignissen. Sie können das Ereignisrouting konfigurieren. Legen Sie dazu Filter für den Trigger fest, einschließlich der Ereignisquelle und des Zielworkflows.

Ereignisse werden im CloudEvents-Format über eine HTTP-Anfrage zugestellt. Der Workflow-Dienst konvertiert das Ereignis in ein JSON-Objekt (gemäß derCloudEvents-Spezifikation) und übergibt das Ereignis als Workflow-Laufzeitargument in die Workflow-Ausführung. Achten Sie darauf, dass die Ereignisgröße 512 KB nicht überschreitet. Ereignisse, die größer als die maximale Argumentgröße von Workflows sind, lösen keine Workflow-Ausführungen aus.

In dieser Anleitung erfahren Sie, wie Sie das Ereignisrouting konfigurieren, damit die Ausführung Ihres Workflows als Reaktion auf ein direktes Firebase Alerts-Ereignis ausgelöst wird. Weitere Informationen finden Sie in der Liste der unterstützten direkten Ereignisse.

Anfragen an Ihren Dienst werden als Reaktion auf ein Ereignis ausgelöst, wenn eine Firebase-Benachrichtigung von einem Firebase-Dienst veröffentlicht wird.

Hinweis: Wenn sowohl direkte als auch Audit-Log-Ereignisse für einen Google-Anbieter unterstützt werden, empfehlen wir die Erstellung eines Triggers, der nach dem direkten Ereignis filtert. Direkte Ereignisse bieten gegenüber Audit-Log-Ereignissen eine Reihe von Vorteilen. Weitere Informationen finden Sie unter Ereignisrouten.

Erstellung eines Triggers vorbereiten

Führen Sie die folgenden Aufgaben aus, bevor Sie einen Eventarc-Trigger für einen Zielworkflow erstellen.

Console

1. Wählen Sie in der Google Cloud Console auf der Seite der Projektauswahl ein Google Cloud-Projekt aus oder erstellen Sie eines.

   Hinweis: Wenn Sie die Ressourcen, die Sie in diesem Verfahren erstellen, nicht behalten möchten, erstellen Sie ein Projekt, anstatt ein vorhandenes Projekt auszuwählen. Wenn Sie fertig sind, können Sie das Projekt löschen und dadurch alle mit ihm verknüpften Ressourcen entfernen.

   Zur Projektauswahl

2. Aktivieren Sie die Eventarc, Eventarc Publishing, Workflows und Workflow Executions APIs.

   Aktivieren Sie die APIs

3. Aktivieren Sie gegebenenfalls die API, die mit den direkten Ereignissen verbunden ist. Aktivieren Sie beispielsweise für Firebase Alerts-Ereignisse die Firebase Alerts API.

4. Erstellen Sie ein nutzerverwaltetes Dienstkonto, falls Sie noch keines haben, und weisen Sie ihm dann die erforderlichen Rollen und Berechtigungen zu, damit Eventarc Ereignisse für einen Zielworkflow verwalten kann.

   1. Rufen Sie in der Google Cloud Console die Seite Dienstkonten auf:

      Zur Seite „Dienstkonten“

   2. Wählen Sie Ihr Projekt aus.

   3. Geben Sie im Feld Dienstkontoname einen Namen ein. Die Google Cloud Console füllt das Feld Dienstkonto-ID anhand dieses Namens aus.

      Geben Sie im Feld Dienstkontobeschreibung eine Beschreibung ein. Beispiel: Service account for event trigger

   4. Klicken Sie auf Erstellen und fortfahren.

   5. Wählen Sie in der Liste Rolle auswählen die erforderlichen IAM-Rollen (Identitäts- und Zugriffsverwaltung) aus, die Ihrem Dienstkonto zugewiesen werden sollen. Weitere Informationen finden Sie unter Rollen und Berechtigungen für Workflows-Ziele.

      Klicken Sie auf Weitere Rolle hinzufügen, um weitere Rollen hinzuzufügen.

   6. Klicken Sie auf Weiter.

   7. Klicken Sie zum Abschließen der Erstellung des Dienstkontos auf Fertig.

gcloud

1. Aktivieren Sie Cloud Shell in der Google Cloud Console.

   Cloud Shell aktivieren

   Unten in der Google Cloud Console wird eine Cloud Shell-Sitzung gestartet und eine Eingabeaufforderung angezeigt. Cloud Shell ist eine Shell-Umgebung, in der das Google Cloud CLI bereits installiert ist und Werte für Ihr aktuelles Projekt bereits festgelegt sind. Das Initialisieren der Sitzung kann einige Sekunden dauern.

2. Aktivieren Sie die Eventarc, Eventarc Publishing, Workflows und Workflow Executions APIs:

   gcloud services enable eventarc.googleapis.com \
       eventarcpublishing.googleapis.com \
       workflows.googleapis.com \
       workflowexecutions.googleapis.com
   

3. Aktivieren Sie gegebenenfalls die API, die mit den direkten Ereignissen verbunden ist. Aktivieren Sie beispielsweise für Firebase Alerts-Ereignisse firestore.googleapis.com.

4. Erstellen Sie ein nutzerverwaltetes Dienstkonto, falls Sie noch keines haben, und weisen Sie ihm dann die erforderlichen Rollen und Berechtigungen zu, damit Eventarc Ereignisse für einen Zielworkflow verwalten kann.

   1. Erstellen Sie das Dienstkonto:

      gcloud iam service-accounts create SERVICE_ACCOUNT_NAME

      SERVICE_ACCOUNT_NAME durch den Namen des Dienstkontos. Der Name des Dienstkontos muss zwischen 6 und 30 Zeichen lang sein und darf alphanumerische Zeichen in Kleinschreibung sowie Bindestriche enthalten. Nachdem Sie ein Dienstkonto erstellt haben, können Sie den Namen nicht mehr ändern.

   2. Erteilen Sie die erforderlichen IAM-Rollen oder -Berechtigungen (Identity and Access Management). Weitere Informationen finden Sie unter Rollen und Berechtigungen für Workflows-Ziele.

Trigger erstellen

Sie können einen Eventarc-Trigger mit einem bereitgestellten Workflow als Ereignisempfänger erstellen. Verwenden Sie dazu die Google Cloud CLI (gcloud oder Terraform) oder die Google Cloud Console.

Hinweis: Die Filterung erfolgt über eine exakte Übereinstimmung und unterstützt keine Platzhalter oder regulären Ausdrücke. Sie können jedoch das Flag --event-filters-path-pattern im folgenden Befehl der gcloud CLI verwenden oder ein Pfadmuster über die Konsole definieren. Weitere Informationen finden Sie unter Informationen zu Pfadmustern.

Console

1. Rufen Sie in der Google Cloud Console die Seite mit den Eventarc-Triggern auf.

   Zur Seite "Trigger"

2. Klicken Sie auf Trigger erstellen.
3. Geben Sie einen Triggernamen ein.

   Dies ist die ID des Triggers. Sie muss mit einem Buchstaben beginnen. Sie kann bis zu 63 Kleinbuchstaben, Ziffern oder Bindestriche enthalten.

4. Wählen Sie als Triggertyp die Option Google-Quellen aus.
5. Wählen Sie in der Liste Ereignisanbieter die Option Firebase Alerts aus.

   Beachten Sie, dass der Name des Ereignisanbieters, der in der zugehörigen Google Cloud-Dokumentation verwendet wird, möglicherweise nicht das Präfix Cloud oder Google Cloud hat. In der Console wird Memorystore for Redis beispielsweise als Google Cloud Memorystore for Redis bezeichnet.

6. Wählen Sie in der Liste Ereignistyp aus den Ereignissen Direkt einen Ereignistyp aus.
7. Wählen Sie zur Angabe der Codierung der Ereignisnutzlast in der Liste Inhaltstyp des Ereignisdaten die Option application/json oder application/protobuf aus.

   Beachten Sie, dass eine im JSON-Format formatierte Ereignisnutzlast größer als eine in Protobuf formatierte ist. Dies kann sich auf die Zuverlässigkeit auswirken, je nach Ereignisziel und Limits der Ereignisgröße. Weitere Informationen finden Sie unter Bekannte Probleme.

8. Wählen Sie in der Liste Region die Option Global aus.

   Weitere Informationen finden Sie unter Eventarc-Standorte.

9. Im Feld Attribut 1 fungiert die Ressourcen-ID alerttype als Ereignisfilter. Wählen Sie für diesen Filter einen Operator aus:
   • Gleich
   • Pfadmuster

     Weitere Informationen finden Sie unter Informationen zu Pfadmustern.

10. Geben Sie im Feld Attributwert 1 eine der folgenden Optionen ein:
    • appDistribution.inAppFeedback: Das Ereignis wird gesendet, wenn ein Tester In-App-Feedback für eine bestimmte Anwendung sendet
    • appDistribution.newTesterIosDevice: das Ereignis wird gesendet, wenn ein neues iOS-Tester-Gerät für eine bestimmte App registriert ist.
    • billing.planAutomatedUpdate: Das Ereignis wird gesendet, wenn der Abrechnungstarif für ein Firebase-Projekt automatisch aktualisiert wird. Das ist beispielsweise der Fall, wenn ein Tarif aufgrund von Zahlungsproblemen herabgestuft wird.
    • billing.planUpdate: Das Ereignis wird gesendet, wenn der Abrechnungstarif für ein Firebase-Projekt von einem Nutzer geändert wird. Beispiel: Ein Rechnungskonto wird mit einem Projekt verknüpft oder von diesem getrennt.
    • crashlytics.missingSymbolFile: Das Ereignis wird gesendet, wenn Firebase Crashlytics feststellt, dass es nicht die entsprechenden Fehlerbehebungssymbole hat, um einen eingehenden Absturzbericht zu symbolisieren.
    • crashlytics.newAnrIssue: Das Ereignis wird gesendet, wenn bei einer Anwendung ein neuer ANR-Fehler (Application not responding, Anwendung reagiert nicht) auftritt (nicht für nachfolgende, identische Ereignisse).
    • crashlytics.newFatalIssue: Das Ereignis wird gesendet, wenn bei einer Anwendung ein neuer schwerwiegender Absturz auftritt (nicht für nachfolgende, identische Ereignisse).
    • crashlytics.newNonfatalIssue: Das Ereignis wird gesendet, wenn bei einer Anwendung ein neuer nicht schwerwiegender Fehler auftritt (nicht für nachfolgende, identische Ereignisse).
    • crashlytics.regression: Das Ereignis wird gesendet, wenn eine Anwendung bei einem Problem abstürzt, das für eine frühere Anwendungsversion als geschlossen gekennzeichnet wurde.
    • crashlytics.stabilityDigest: Das Ereignis wird gesendet, wenn eine Benachrichtigung über die häufigsten Trendprobleme in Crashlytics vorhanden ist.
    • crashlytics.velocity: Das Ereignis wird gesendet, wenn ein einzelnes Problem dafür verantwortlich ist, dass eine beträchtliche Anzahl von Anwendungssitzungen abstürzt.
    • performance.threshold: Ereignis wird gesendet, wenn die Leistung eines Messwerts den festgelegten Schwellenwert überschreitet
11. Optional können Sie Ereignisse für eine bestimmte Firebase-App-ID filtern. Klicken Sie auf Filter hinzufügen und geben Sie die appid an.
12. Wählen Sie das Dienstkonto aus, das Ihren Dienst oder Workflow aufruft.

    Alternativ können Sie ein neues Dienstkonto erstellen.

    Dies gibt die E-Mail-Adresse des IAM-Dienstkontos (Identity and Access Management) an, die dem Trigger zugeordnet ist und für die Sie zuvor bestimmte Rollen zugewiesen haben, die für Eventarc erforderlich sind.

13. Wählen Sie in der Liste Ereignisziel die Option Workflows aus.
14. Wählen Sie einen Workflow aus.
    

    Dies ist der Name des Workflows, an den Ereignisse übergeben werden. Ereignisse für eine Workflowausführung werden transformiert und als Laufzeitargumente an den Workflow übergeben.

    Weitere Informationen finden Sie unter Trigger für Workflows erstellen.

15. Klicken Sie auf Erstellen.

Nachdem ein Trigger erstellt wurde, können die Ereignisquellenfilter nicht mehr geändert werden. Erstellen Sie stattdessen einen neuen Trigger und löschen Sie den alten. Weitere Informationen finden Sie unter Trigger verwalten.

gcloud

gcloud eventarc triggers create TRIGGER \
    --location=global \
    --destination-workflow=DESTINATION_WORKFLOW  \
    --destination-workflow-location=DESTINATION_WORKFLOW_LOCATION \
    --event-filters="type=google.firebase.firebasealerts.alerts.v1.published" \
    --event-filters="alerttype=ALERT_TYPE" \
    --event-data-content-type="EVENT_DATA_CONTENT_TYPE" \
    --service-account="MY_SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com"

Ersetzen Sie Folgendes:

• TRIGGER: ID des Triggers oder eine voll qualifizierte Kennzeichnung.
• DESTINATION_WORKFLOW: die ID des bereitgestellten Workflows, der die Ereignisse vom Trigger empfängt. Der Workflow kann sich an einem der von Workflows unterstützten Standorte befinden und muss sich nicht am selben Standort wie der Trigger vorhanden sein. Der Workflow muss sich jedoch im selben Projekt wie der Trigger befinden.
• DESTINATION_WORKFLOW_LOCATION (optional): der Standort, an dem der Zielworkflow bereitgestellt wird. Wenn keine Angabe erfolgt, wird davon ausgegangen, dass sich der Workflow am selben Standort wie der Trigger befindet.
• ALERT_TYPE. ist der Typ der Firebase-Benachrichtigung und kann einer der Folgenden sein:
  • appDistribution.inAppFeedback: Das Ereignis wird gesendet, wenn ein Tester In-App-Feedback für eine bestimmte Anwendung sendet
  • appDistribution.newTesterIosDevice: das Ereignis wird gesendet, wenn ein neues iOS-Tester-Gerät für eine bestimmte App registriert ist.
  • billing.planAutomatedUpdate: Das Ereignis wird gesendet, wenn der Abrechnungstarif für ein Firebase-Projekt automatisch aktualisiert wird. Das ist beispielsweise der Fall, wenn ein Tarif aufgrund von Zahlungsproblemen herabgestuft wird.
  • billing.planUpdate: Das Ereignis wird gesendet, wenn der Abrechnungstarif für ein Firebase-Projekt von einem Nutzer geändert wird. Beispiel: Ein Rechnungskonto wird mit einem Projekt verknüpft oder von diesem getrennt.
  • crashlytics.missingSymbolFile: Das Ereignis wird gesendet, wenn Firebase Crashlytics feststellt, dass es nicht die entsprechenden Fehlerbehebungssymbole hat, um einen eingehenden Absturzbericht zu symbolisieren.
  • crashlytics.newAnrIssue: Das Ereignis wird gesendet, wenn bei einer Anwendung ein neuer ANR-Fehler (Application not responding, Anwendung reagiert nicht) auftritt (nicht für nachfolgende, identische Ereignisse).
  • crashlytics.newFatalIssue: Das Ereignis wird gesendet, wenn bei einer Anwendung ein neuer schwerwiegender Absturz auftritt (nicht für nachfolgende, identische Ereignisse).
  • crashlytics.newNonfatalIssue: Das Ereignis wird gesendet, wenn bei einer Anwendung ein neuer nicht schwerwiegender Fehler auftritt (nicht für nachfolgende, identische Ereignisse).
  • crashlytics.regression: Das Ereignis wird gesendet, wenn eine Anwendung bei einem Problem abstürzt, das für eine frühere Anwendungsversion als geschlossen gekennzeichnet wurde.
  • crashlytics.stabilityDigest: Das Ereignis wird gesendet, wenn eine Benachrichtigung über die häufigsten Trendprobleme in Crashlytics vorhanden ist.
  • crashlytics.velocity: Das Ereignis wird gesendet, wenn ein einzelnes Problem dafür verantwortlich ist, dass eine beträchtliche Anzahl von Anwendungssitzungen abstürzt.
  • performance.threshold: Ereignis wird gesendet, wenn die Leistung eines Messwerts den festgelegten Schwellenwert überschreitet
  Der Operator für ALERT_TYPE muss einer der folgenden sein:
  • Gleich. Beispiel: --event-filters="alerttype=appDistribution.inAppFeedback"
  • Pfadmuster; Beispiel: --event-filters-path-pattern="alerttype=appDistribution." oder --event-filters-path-pattern="alerttype=crashlytics.new".

    Weitere Informationen finden Sie unter Informationen zu Pfadmustern.

• EVENT_DATA_CONTENT_TYPE: (Optional) Die Codierung der Ereignisnutzlast. Das kann application/json oder application/protobuf sein. Die Standardcodierung ist application/json.

  Beachten Sie, dass eine im JSON-Format formatierte Ereignisnutzlast größer als eine in Protobuf formatierte ist. Dies kann sich auf die Zuverlässigkeit auswirken, je nach Ereignisziel und Limits der Ereignisgröße. Weitere Informationen finden Sie unter Bekannte Probleme.

• SERVICE_ACCOUNT_NAME: der Name des von Ihnen erstellten IAM-Dienstkontos, dem Sie bestimmte Rollen zugewiesen haben, die für Workflows erforderlich sind.
• PROJECT_ID: Ihre Google Cloud-Projekt-ID

Hinweise:

• Das Flag --location muss global sein. Weitere Informationen finden Sie unter Eventarc-Standorte.
• Diese Flags sind erforderlich:
  • --event-filters="type=google.firebase.firebasealerts.alerts.v1.published"
  • --event-filters="alerttype=ALERT_TYPE" oder --event-filters-path-pattern="alerttype=ALERT_TYPE"
• Nachdem ein Trigger erstellt wurde, kann der Ereignisfiltertyp nicht mehr geändert werden. Für einen anderen Ereignistyp müssen Sie einen neuen Trigger erstellen.
• Optional können Sie Ereignisse für eine bestimmte Firebase-App-ID filtern. Verwenden Sie dazu das Flag --event-filters="appid=APP_ID" und geben Sie eine genaue Übereinstimmung an.
• --service-account: Die IAM-Dienstkonto-E-Mail, mit der Ihr Eventarc-Trigger die Workflow-Ausführungen aufruft. Es wird dringend empfohlen, ein Dienstkonto mit den geringsten Berechtigungen zu verwenden, die für den Zugriff auf die benötigten Ressourcen erforderlich sind. Weitere Informationen zu Dienstkonten finden Sie unter Dienstkonten erstellen und verwalten.
• Standardmäßig bleiben für Eventarc erstellte Pub/Sub-Abos unabhängig von ihrer Aktivität bestehen und laufen nicht ab. Informationen zum Ändern des Inaktivitätszeitraums finden Sie unter Abo-Attribute.

Beispiel:

gcloud eventarc triggers create firealerts-workflows-trigger \
    --location=global \
    --destination-workflow=my-workflow \
    --destination-workflow-location=europe-west4 \
    --event-filters="type=google.firebase.firebasealerts.alerts.v1.published" \
    --event-filters="alerttype=crashlytics.velocity" \
    --service-account="${SERVICE_ACCOUNT_NAME}@${PROJECT_ID}.iam.gserviceaccount.com"

Dieser Befehl erstellt einen Trigger mit dem Namen firealerts-workflows-trigger für das als google.firebase.firebasealerts.alerts.v1.published identifizierte Ereignis und für einen Benachrichtigungstyp crashlytics.velocity.

Terraform

Sie können mit Terraform einen Trigger für einen Workflow erstellen. Weitere Informationen finden Sie unter Workflow mit Eventarc und Terraform auslösen.

Hinweis: Der Trigger wird zwar sofort erstellt, es kann jedoch bis zu zwei Minuten dauern, bis er wirksam wird und Ereignisse filtert.

Trigger auflisten

Sie können die Erstellung eines Triggers bestätigen, indem Sie Eventarc-Trigger mit der Google Cloud CLI oder über die Google Cloud Console auflisten.

Console

1. Rufen Sie in der Google Cloud Console die Seite mit den Eventarc-Triggern auf.

   Zur Seite "Trigger"

   Auf dieser Seite werden Ihre Trigger an allen Standorten aufgelistet. Außerdem enthält sie Details wie Namen, Regionen, Ereignisanbieter, Ziele usw.

2. So filtern Sie die Trigger:

   1. Klicken Sie auf Filter oder das Feld Trigger filtern.
   2. Wählen Sie in der Liste Attribute eine Option aus, nach der die Trigger gefiltert werden sollen.

   Sie können ein einzelnes Attribut auswählen oder den logischen Operator OR verwenden, um weitere Attribute hinzuzufügen.

3. Klicken Sie zum Sortieren der Trigger neben jeder unterstützten Spaltenüberschrift auf Sortieren.

gcloud

Führen Sie den folgenden Befehl aus, um die Trigger aufzulisten:

gcloud eventarc triggers list --location=-

Dieser Befehl listet Ihre Trigger an allen Standorten auf und enthält Details wie Namen, Typen, Ziele und Status.

Nächste Schritte

• Workflow mit Eventarc und Terraform auslösen

• Weitere Informationen zu Eventarc