Inoltra gli eventi di avviso Firebase a Workflows

Un trigger Eventarc dichiara il tuo interesse per un determinato evento o insieme di eventi. Puoi configurare il routing degli eventi specificando i filtri per il trigger, inclusa l'origine evento, e il flusso di lavoro target.

Gli eventi vengono distribuiti in formato CloudEvents tramite una richiesta HTTP. Il servizio Workflows converte l'evento in un oggetto JSON (in base alla specifica CloudEvents) e lo passa all'esecuzione del flusso di lavoro come argomento di runtime del flusso di lavoro. Assicurati che le dimensioni dell'evento non superino i 512 KB. Gli eventi più grandi della dimensione massima degli argomenti di Workflows non attiveranno le esecuzioni del workflow.

Queste istruzioni mostrano come configurare il routing degli eventi in modo che l'esecuzione del workflow venga attivata in risposta a un evento Firebase Alerts diretto. Per maggiori dettagli, consulta l'elenco degli eventi diretti supportati.

Le richieste al tuo servizio vengono attivate in risposta a un evento quando un servizio Firebase pubblica un avviso Firebase.

Prepararsi a creare un trigger

Prima di creare un trigger Eventarc per un flusso di lavoro di destinazione, completa le seguenti attività.

Console

  1. Nella console Google Cloud , nella pagina di selezione del progetto, seleziona o crea un progetto Google Cloud .

    Vai al selettore dei progetti

  2. Abilita le API Eventarc, Eventarc Publishing, Workflows e Workflow Executions.

    Abilita le API

  3. Se applicabile, abilita l'API relativa agli eventi diretti. Ad esempio, per gli eventi Firebase Alerts , abilita l'APIFirebase Alerts .

  4. Se non ne hai già uno, crea un account di servizio gestito dall'utente, poi concedigli i ruoli e le autorizzazioni necessari affinché Eventarc possa gestire gli eventi per un flusso di lavoro di destinazione.

    1. Nella console Google Cloud , vai alla pagina Service Accounts.

      Vai a Service account

    2. Seleziona il progetto.

    3. Nel campo Nome service account, inserisci un nome. La console Google Cloud compila il campo ID service account in base a questo nome.

      Nel campo Descrizione service account, inserisci una descrizione. Ad esempio, Service account for event trigger.

    4. Fai clic su Crea e continua.

    5. Per fornire l'accesso appropriato, nell'elenco Seleziona un ruolo, seleziona i ruoli Identity and Access Management (IAM) richiesti da concedere al service account. Per saperne di più, vedi Ruoli e autorizzazioni per le Workflows lavoro.

      Per altri ruoli, fai clic su Aggiungi un altro ruolo e aggiungi ogni ruolo aggiuntivo.

    6. Fai clic su Continua.

    7. Per completare la creazione dell'account, fai clic su Fine.

gcloud

  1. In the Google Cloud console, activate Cloud Shell.

    Activate Cloud Shell

    At the bottom of the Google Cloud console, a Cloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.

  2. Abilita le API Eventarc, Eventarc Publishing, Workflows e Workflow Executions:

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

  3. Se applicabile, abilita l'API relativa agli eventi diretti. Ad esempio, per gli Firebase Alerts eventi, attiva firestore.googleapis.com.

  4. Se non ne hai già uno, crea un account di servizio gestito dall'utente, poi concedigli i ruoli e le autorizzazioni necessari affinché Eventarc possa gestire gli eventi per un flusso di lavoro di destinazione.

    1. Crea l'account di servizio:

      gcloud iam service-accounts create SERVICE_ACCOUNT_NAME

      Sostituisci SERVICE_ACCOUNT_NAME con il nome del service account. Deve contenere da 6 a 30 caratteri e può contenere caratteri alfanumerici minuscoli e trattini. Una volta creato un account di servizio, non puoi modificarne il nome.

    2. Concedi i ruoli o le autorizzazioni IAM (Identity and Access Management) richiesti. Per saperne di più, vedi Ruoli e autorizzazioni per Workflows lavoro.

Crea un trigger

Puoi creare un trigger Eventarc con un flusso di lavoro di cui è stato eseguito il deployment come ricevitore di eventi utilizzando Google Cloud CLI (gcloud o Terraform) o tramite la console Google Cloud .

Console

  1. Nella Google Cloud console, vai alla pagina Trigger di Eventarc.

    Vai ai trigger

  2. Fai clic su Crea trigger.
  3. Digita un Nome trigger.

    Questo è l'ID del trigger e deve iniziare con una lettera. Può contenere fino a 63 lettere minuscole, numeri o trattini.

  4. Per Tipo di trigger, seleziona Origini Google.
  5. Nell'elenco Provider di eventi, seleziona Firebase Alerts.

    Tieni presente che il nome del fornitore di eventi utilizzato nella Google Cloud documentazione associata potrebbe non avere un prefisso di Cloud o Google Cloud. Ad esempio, nella console, Memorystore for Redis è indicato come Google Cloud Memorystore for Redis.

  6. Nell'elenco Tipo di evento, seleziona un tipo di evento tra quelli Diretti.
  7. Per specificare la codifica del payload dell'evento, nell'elenco Tipo di contenuti dei dati evento, seleziona application/json o application/protobuf.

    Tieni presente che un payload evento formattato in JSON è più grande di uno formattato in Protobuf. Ciò potrebbe influire sull'affidabilità a seconda della destinazione dell'evento e dei suoi limiti di dimensione. Per saperne di più, vedi Problemi noti.

  8. Nell'elenco Regione, seleziona global (globale).

    Per saperne di più, consulta Località Eventarc.

  9. Nel campo Attributo 1, l'ID risorsa alerttype funge da filtro eventi. Seleziona un operatore per questo filtro:
  10. Nel campo Valore attributo 1, inserisci uno dei seguenti valori:
    • appDistribution.inAppFeedback: l'evento viene inviato quando un tester invia un feedback in-app per una determinata app
    • appDistribution.newTesterIosDevice: l'evento viene inviato quando un nuovo dispositivo di test iOS viene registrato per una determinata app
    • billing.planAutomatedUpdate: l'evento viene inviato quando il piano di fatturazione per un progetto Firebase viene aggiornato automaticamente, ad esempio quando viene eseguito il downgrade di un piano a causa di problemi di pagamento
    • billing.planUpdate: l'evento viene inviato quando un utente modifica il piano di fatturazione per un progetto Firebase, ad esempio quando un account di fatturazione viene collegato o scollegato da un progetto
    • crashlytics.missingSymbolFile: l'evento viene inviato quando Firebase Crashlytics determina di non disporre dei simboli di debug appropriati per simbolizzare un report sugli arresti anomali in arrivo
    • crashlytics.newAnrIssue: l'evento viene inviato quando un'app riscontra un errore ANR (L'applicazione non risponde) nuovo (non per eventi identici successivi)
    • crashlytics.newFatalIssue: l'evento viene inviato quando un'app subisce un arresto anomalo irreversibile nuovo (non per eventi identici successivi)
    • crashlytics.newNonfatalIssue: l'evento viene inviato quando un'app riscontra un nuovo errore non irreversibile (non per eventi successivi identici)
    • crashlytics.regression: l'evento viene inviato quando un'app subisce un arresto anomalo per un problema contrassegnato come chiuso per una versione precedente dell'app
    • crashlytics.stabilityDigest: l'evento viene inviato quando viene visualizzata una notifica dei problemi più di tendenza in Crashlytics
    • crashlytics.velocity: l'evento viene inviato quando un singolo problema è responsabile di un numero significativo di arresti anomali delle sessioni dell'app
    • performance.threshold: l'evento viene inviato quando il rendimento di una metrica supera la soglia impostata
  11. (Facoltativo) Puoi filtrare gli eventi in base a un ID app Firebase specifico. Fai clic su Aggiungi filtro e specifica l' appid.
  12. Seleziona l'account di servizio che richiamerà il tuo servizio o flusso di lavoro.

    In alternativa, puoi creare un nuovo account di servizio.

    Specifica l'indirizzo email del account di servizio Identity and Access Management (IAM) associato al trigger e a cui hai precedentemente concesso ruoli specifici richiesti da Eventarc.

  13. Nell'elenco Destinazione evento, seleziona Workflows.
  14. Seleziona un workflow.

    Questo è il nome del flusso di lavoro a cui trasferire gli eventi. Gli eventi per l'esecuzione di un flusso di lavoro vengono trasformati e passati al flusso di lavoro come argomenti runtime.

    Per saperne di più, consulta Creare un trigger per Workflows.

  15. (Facoltativo) Per aggiungere un'etichetta, puoi fare clic su Aggiungi etichetta. Le etichette sono coppie chiave/valore che ti aiutano a organizzare le tue risorseGoogle Cloud . Per saperne di più, vedi Che cosa sono le etichette?
  16. Fai clic su Crea.
  17. Una volta creato un trigger, i filtri dell'origine eventi non possono essere modificati. Crea invece un nuovo trigger ed elimina quello precedente. Per saperne di più, consulta Gestire i trigger.

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"

Sostituisci quanto segue:

  • TRIGGER: l'ID del trigger o un identificatore completamente qualificato.
  • DESTINATION_WORKFLOW: l'ID del workflow di cui è stato eseguito il deployment che riceve gli eventi dall'attivatore. Il flusso di lavoro può trovarsi in una qualsiasi delle località supportate da Workflows e non deve trovarsi nella stessa località del trigger. Tuttavia, il workflow deve trovarsi nello stesso progetto dell'attivatore.
  • DESTINATION_WORKFLOW_LOCATION (facoltativo): la posizione in cui viene eseguito il deployment del flusso di lavoro di destinazione. Se non specificato, si presume che il workflow si trovi nella stessa posizione del trigger.
  • ALERT_TYPE: il tipo di avviso Firebase e può essere uno dei seguenti valori:
    • appDistribution.inAppFeedback: l'evento viene inviato quando un tester invia un feedback in-app per una determinata app
    • appDistribution.newTesterIosDevice: l'evento viene inviato quando un nuovo dispositivo di test iOS viene registrato per una determinata app
    • billing.planAutomatedUpdate: l'evento viene inviato quando il piano di fatturazione per un progetto Firebase viene aggiornato automaticamente, ad esempio quando viene eseguito il downgrade di un piano a causa di problemi di pagamento
    • billing.planUpdate: l'evento viene inviato quando un utente modifica il piano di fatturazione per un progetto Firebase, ad esempio quando un account di fatturazione viene collegato o scollegato da un progetto
    • crashlytics.missingSymbolFile: l'evento viene inviato quando Firebase Crashlytics determina di non disporre dei simboli di debug appropriati per simbolizzare un report sugli arresti anomali in arrivo
    • crashlytics.newAnrIssue: l'evento viene inviato quando un'app riscontra un errore ANR (L'applicazione non risponde) nuovo (non per eventi identici successivi)
    • crashlytics.newFatalIssue: l'evento viene inviato quando un'app subisce un arresto anomalo irreversibile nuovo (non per eventi identici successivi)
    • crashlytics.newNonfatalIssue: l'evento viene inviato quando un'app riscontra un nuovo errore non irreversibile (non per eventi successivi identici)
    • crashlytics.regression: l'evento viene inviato quando un'app subisce un arresto anomalo per un problema contrassegnato come chiuso per una versione precedente dell'app
    • crashlytics.stabilityDigest: l'evento viene inviato quando viene visualizzata una notifica dei problemi più di tendenza in Crashlytics
    • crashlytics.velocity: l'evento viene inviato quando un singolo problema è responsabile di un numero significativo di arresti anomali delle sessioni dell'app
    • performance.threshold: l'evento viene inviato quando il rendimento di una metrica supera la soglia impostata
    L'operatore per ALERT_TYPE deve essere uno dei seguenti:
    • Uguale; ad esempio, --event-filters="alerttype=appDistribution.inAppFeedback"
    • Pattern del percorso, ad esempio --event-filters-path-pattern="alerttype=appDistribution." o --event-filters-path-pattern="alerttype=crashlytics.new".

      Per saperne di più, vedi Informazioni sui pattern di percorso.

  • EVENT_DATA_CONTENT_TYPE: (facoltativo) la codifica del payload dell'evento. Può essere application/json o application/protobuf. La codifica predefinita è application/json.

    Tieni presente che un payload evento formattato in JSON è più grande di uno formattato in Protobuf. Ciò potrebbe influire sull'affidabilità a seconda della destinazione dell'evento e dei relativi limiti di dimensione. Per saperne di più, vedi Problemi noti.

  • SERVICE_ACCOUNT_NAME: il nome del service account IAM che hai creato a cui hai concesso ruoli specifici richiesti da Workflows.
  • PROJECT_ID: il tuo ID progetto Google Cloud

Note:

  • Il flag --location deve essere global. Per saperne di più, consulta Località Eventarc.
  • Questi flag sono obbligatori:
    • --event-filters="type=google.firebase.firebasealerts.alerts.v1.published"
    • --event-filters="alerttype=ALERT_TYPE" o --event-filters-path-pattern="alerttype=ALERT_TYPE"
  • Una volta creato un trigger, non è possibile modificare il tipo di filtro eventi. Per un tipo di evento diverso, devi creare un nuovo trigger.
  • (Facoltativo) Puoi filtrare gli eventi per un ID app Firebase specifico utilizzando il flag --event-filters="appid=APP_ID" e specificando una corrispondenza esatta.
  • --service-account: L'email del account di servizio IAM che il trigger Eventarc utilizzerà per richiamare le esecuzioni del flusso di lavoro. Ti consigliamo vivamente di utilizzare un account di servizio con i privilegi minimi necessari per accedere alle risorse richieste. Per scoprire di più sui service account, vedi Creare e gestire i service account.
  • Per impostazione predefinita, le sottoscrizioni Pub/Sub create per Eventarc vengono mantenute indipendentemente dall'attività e non scadono. Per modificare la durata dell'inattività, consulta Proprietà dell'abbonamento.

Esempio:

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"

Questo comando crea un trigger denominato firealerts-workflows-trigger per l'evento identificato come google.firebase.firebasealerts.alerts.v1.published, e per un tipo di avviso crashlytics.velocity.

Terraform

Puoi creare un trigger per un flusso di lavoro utilizzando Terraform. Per i dettagli, vedi Attivare un flusso di lavoro utilizzando Eventarc e Terraform.

Elenca un trigger

Puoi confermare la creazione di un trigger elencando i trigger Eventarc utilizzando Google Cloud CLI o tramite la console Google Cloud .

Console

  1. Nella Google Cloud console, vai alla pagina Trigger di Eventarc.

    Vai ai trigger

    Questa pagina elenca i trigger in tutte le posizioni e include dettagli come nomi, regioni, fornitori di eventi, destinazioni e altro ancora.

  2. Per filtrare i trigger:

    1. Fai clic su Filtro o sul campo Trigger del filtro.
    2. Nell'elenco Proprietà, seleziona un'opzione per filtrare i trigger.

    Puoi selezionare una singola proprietà o utilizzare l'operatore logico OR per aggiungere altre proprietà.

  3. Per ordinare i trigger, fai clic su Ordina accanto a un'intestazione di colonna supportata.

gcloud

Esegui questo comando per elencare i trigger:

gcloud eventarc triggers list --location=-

Questo comando elenca i trigger in tutte le posizioni e include dettagli come nomi, tipi, destinazioni e stati.

Passaggi successivi