Instrada eventi Firebase Alert a Workflows

Anteprima — Firebase Alerts direct events

Questa funzionalità è regolata dai Termini delle offerte pre-GA dei Termini di servizio di Google Cloud. Le funzionalità pre-GA potrebbero avere supporto limitato e le modifiche a queste funzionalità potrebbero non essere compatibili con altre versioni pre-GA. Per ulteriori informazioni, consulta le descrizioni della fase di lancio.

Un trigger Eventarc dichiara il tuo interesse per un determinato evento o set di eventi. Puoi configurare il routing degli eventi specificando filtri per il trigger, tra cui l'origine dell'evento e il flusso di lavoro di destinazione.

Nota: per l'evento che vuoi indirizzare, se sono supportate sia le opzioni di log diretto sia quelle di controllo, ti consigliamo di creare un trigger per instradare l'evento diretto. Gli eventi diretti offrono una serie di vantaggi rispetto agli eventi dei log di controllo. Per saperne di più, consulta Opzioni di routing degli eventi.

Eventarc fornisce eventi attivati dalle origini su Cloud Pub/Sub. Gli eventi consegnati vengono trasformati e trasmessi a Workflows come argomenti di runtime per eseguire il flusso di lavoro. Assicurati che le dimensioni dell'evento non superino i 512 kB. Gli eventi superiori alla dimensione massima degli argomenti Workflows non attiveranno le esecuzioni del flusso di lavoro.

Queste istruzioni mostrano come viene attivata una nuova esecuzione del flusso di lavoro 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 viene pubblicato da un servizio Firebase.

Preparati a creare un trigger

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

Console

1. Nella pagina del selettore dei progetti, nella console Google Cloud, seleziona o crea un progetto Google Cloud.

   Nota: se non prevedi di conservare le risorse che crei in questa procedura, crea un progetto invece di selezionarne uno esistente. Dopo aver completato questi passaggi, puoi eliminare il progetto e rimuovere tutte le risorse associate.

   Vai al selettore progetti

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

   Abilitare le API

3. Se applicabile, abilita l'API relativa agli eventi diretti. Ad esempio, per gli eventi Cloud Functions, abilita cloudfunctions.googleapis.com.

4. Se non ne hai già uno, crea un account di servizio gestito dall'utente, quindi assegnagli i ruoli e le autorizzazioni necessari in modo che Eventarc possa gestire gli eventi per un flusso di lavoro di destinazione.

   1. Nella console Google Cloud, vai alla pagina Account di servizio.

      Vai agli account di servizio

   2. Seleziona il progetto e fai clic su Crea account di servizio.

   3. Inserisci un nome nel campo Service account name (Nome account di servizio). La console Google Cloud viene compilata nel campo ID account di servizio in base a questo nome.

      Nel campo Descrizione account di servizio, 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 seguenti da concedere al tuo account di servizio.

      • Eventarc > Ricevitore eventi Eventarc
      • Workflows > Invoker flussi di lavoro

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

      Nota: il campo Ruolo influisce sulle risorse a cui il tuo account di servizio può accedere nel tuo progetto. Puoi revocare questi ruoli o concedere ruoli aggiuntivi in un secondo momento. Negli ambienti di produzione, non concedere i ruoli Proprietario, Editor o Visualizzatore. Concedi invece un ruolo predefinito o un ruolo personalizzato che soddisfi le tue esigenze.

      Per ulteriori informazioni su come controllare l'accesso alle risorse Workflows, consulta Utilizzare IAM per controllare l'accesso.

   6. Fai clic su Continua.

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

gcloud

1. In Google Cloud Console, attiva Cloud Shell.

   Attiva Cloud Shell

   Nella parte inferiore di Google Cloud Console, viene avviata una sessione di Cloud Shell e viene visualizzato un prompt della riga di comando. Cloud Shell è un ambiente shell con Google Cloud CLI già installato e con valori già impostati per il progetto corrente. L'inizializzazione della sessione può richiedere alcuni secondi.

2. Abilita le API Eventarc, Eventarc Publicationing, Workflows ed 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 eventi Cloud Functions, abilita cloudfunctions.googleapis.com.

4. Concedi all'utente il ruolo di amministratore Eventarc (roles/eventarc.admin):

   gcloud projects add-iam-policy-binding PROJECT_ID \
      --member=PRINCIPAL \
      --role="roles/eventarc.admin"
   

   Sostituisci i seguenti valori:

   • PROJECT_ID: l'ID del progetto Google Cloud.
   • PRINCIPAL: l'entità per cui aggiungere l'associazione. Deve essere nel formato user|group|serviceAccount:email o domain:domain.

     Esempi: user:[e-mail], group:[e-mail], serviceAccount:[e-mail] o domain:example.domain.com

5. Se non ne hai già uno, crea un account di servizio gestito dall'utente, quindi assegnagli i ruoli e le autorizzazioni necessari in modo che Eventarc possa gestire gli eventi per un flusso di lavoro di destinazione.

   1. Crea l'account di servizio:

      TRIGGER_SA=MY_SERVICE_ACCOUNT
      gcloud iam service-accounts create ${TRIGGER_SA}

      Sostituisci MY_SERVICE_ACCOUNT con il nome dell'account di servizio. Deve essere compreso tra 6 e 30 caratteri e può contenere caratteri alfanumerici minuscoli e trattini. Dopo aver creato un account di servizio, non puoi modificare il nome.

   2. Concedi i ruoli all'account di servizio:

      Esegui il comando seguente una volta per ciascuno dei seguenti ruoli IAM:

      • roles/eventarc.eventReceiver
      • roles/workflows.invoker

      gcloud projects add-iam-policy-binding PROJECT_ID \
        --member="serviceAccount:${TRIGGER_SA}@PROJECT_ID.iam.gserviceaccount.com" \
        --role="ROLE"

      Sostituisci quanto segue:

      • PROJECT_ID: l'ID progetto in cui hai creato l'account di servizio
      • ROLE: il ruolo da concedere all'account di servizio
      Nota: il flag --role influisce sulle risorse a cui il tuo account di servizio può accedere nel tuo progetto. Puoi revocare questi ruoli o concedere ruoli aggiuntivi in un secondo momento. Negli ambienti di produzione, non concedere i ruoli Proprietario, Editor o Visualizzatore. Concedi invece un ruolo predefinito o un ruolo personalizzato che soddisfi le tue esigenze.

      Per ulteriori informazioni su come controllare l'accesso alle risorse Workflows, consulta Utilizzare IAM per controllare l'accesso.

Crea un trigger

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

Nota: i filtri vengono eseguiti attraverso una corrispondenza esatta e non supportano i caratteri jolly o le espressioni regolari. Tuttavia, puoi utilizzare il flag --event-filters-path-pattern nel seguente comando dell'interfaccia a riga di comando gcloud o definire un pattern di percorso tramite la console. Per saperne di più, consulta Comprendere i pattern del percorso.

Console

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

   Vai a Trigger

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

   Si tratta dell'ID dell'attivatore 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.
6. Nell'elenco Evento, in Diretto, seleziona un evento.
7. Nell'elenco Regione, seleziona globale (globale).

   Per ulteriori informazioni, consulta Località Eventarc.

8. Nel campo Attributo 1, l'ID risorsa alerttype funge da filtro di evento. Seleziona un operatore per questo filtro:
   • Uguale
   • Pattern del percorso

     Per saperne di più, consulta Informazioni sui pattern dei percorsi.

9. Nel campo Valore attributo 1, inserisci una delle seguenti opzioni:
   • 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 viene registrato un nuovo dispositivo tester iOS 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 del 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 associato o scollegato da un progetto
   • crashlytics.newAnrIssue: viene inviato un evento quando un'app rileva un nuovo errore dell'applicazione che non risponde (ANR) (non per eventi successivi identici)
   • crashlytics.newFatalIssue: viene inviato un evento quando un'app subisce un nuovo arresto anomalo irreversibile (non per eventi successivi identici)
   • crashlytics.newNonfatalIssue: viene inviato un evento quando un'app genera un nuovo errore non irreversibile (non per eventi successivi identici)
   • crashlytics.regression: viene inviato un evento quando un'app riscontra un arresto anomalo per un problema contrassegnato come chiuso per una versione precedente dell'app
   • crashlytics.stabilityDigest: l'evento viene inviato quando viene inviata una notifica relativa ai principali problemi di tendenza in Crashlytics
   • crashlytics.velocity: l'evento viene inviato quando un singolo problema è responsabile di causare l'arresto anomalo di un numero significativo di sessioni dell'app
   • performance.threshold: l'evento viene inviato quando il rendimento di una metrica supera la soglia impostata
10. Facoltativamente, puoi filtrare gli eventi in base a un ID app Firebase specifico. Fai clic su Aggiungi filtro e specifica l'appid.
11. Seleziona l'account di servizio che richiami il servizio o il flusso di lavoro.

    In alternativa, puoi creare un nuovo account di servizio.

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

12. Nell'elenco Destinazione evento, seleziona Workflows.
13. Seleziona un flusso di lavoro.
    

    Si tratta del nome del flusso di lavoro a cui trasferire gli eventi. Gli eventi per un'esecuzione del flusso di lavoro vengono trasformati e trasmessi al flusso di lavoro come argomenti di runtime.

    Per ulteriori informazioni, vedi Creare un trigger per Workflows.

14. Fai clic su Crea.

Una volta creato un attivatore, i filtri dell'origine evento non possono essere modificati. Crea invece un nuovo attivatore 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" \
    --service-account="MY_SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com"

Sostituisci quanto segue:

• TRIGGER: l'ID del trigger o un identificatore completo.
• DESTINATION_WORKFLOW: l'ID del flusso di lavoro di cui è stato eseguito il deployment che riceve gli eventi dal trigger. Il flusso di lavoro può trovarsi in una qualsiasi delle località supportate in Workflows e non deve trovarsi nella stessa località del trigger. Tuttavia, il flusso di lavoro deve trovarsi nello stesso progetto del trigger.
• DESTINATION_WORKFLOW_LOCATION (facoltativo): la località in cui viene eseguito il deployment del flusso di lavoro di destinazione. Se non specificato, si presume che il flusso di lavoro si trovi nella stessa località del trigger.
• ALERT_TYPE: il tipo di avviso di 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 viene registrato un nuovo dispositivo tester iOS 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 del 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 associato o scollegato da un progetto
  • crashlytics.newAnrIssue: viene inviato un evento quando un'app rileva un nuovo errore dell'applicazione che non risponde (ANR) (non per eventi successivi identici)
  • crashlytics.newFatalIssue: viene inviato un evento quando un'app subisce un nuovo arresto anomalo irreversibile (non per eventi successivi identici)
  • crashlytics.newNonfatalIssue: viene inviato un evento quando un'app genera un nuovo errore non irreversibile (non per eventi successivi identici)
  • crashlytics.regression: viene inviato un evento quando un'app riscontra un arresto anomalo per un problema contrassegnato come chiuso per una versione precedente dell'app
  • crashlytics.stabilityDigest: l'evento viene inviato quando viene inviata una notifica relativa ai principali problemi di tendenza in Crashlytics
  • crashlytics.velocity: l'evento viene inviato quando un singolo problema è responsabile di causare l'arresto anomalo di un numero significativo di 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ù, consulta Informazioni sui pattern dei percorsi.

• MY_SERVICE_ACCOUNT: nome dell'account di servizio 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 ulteriori informazioni, consulta Località Eventarc.
• Questi flag sono obbligatori:
  • --event-filters="type=google.firebase.firebasealerts.alerts.v1.published"
  • --event-filters="alerttype=ALERT_TYPE" oppure --event-filters-path-pattern="alerttype=ALERT_TYPE"
• Dopo aver creato un attivatore, il tipo di filtro dell'evento non può essere modificato. Per un tipo di evento diverso, devi creare un nuovo attivatore.
• Facoltativamente, 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'indirizzo email dell'account di servizio IAM che il trigger Eventarc utilizzerà per richiamare le esecuzioni del flusso di lavoro. Consigliamo vivamente di utilizzare un account di servizio con i privilegi minimi necessari per accedere alle risorse richieste. Per scoprire di più sugli account di servizio, consulta la sezione Creare e gestire gli account di servizio.
• Per impostazione predefinita, le sottoscrizioni Pub/Sub create per Eventarc rimangono indipendentemente dall'attività e non scadono. Per modificare la durata dell'inattività, consulta Proprietà delle sottoscrizioni.

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="${TRIGGER_SA}@${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 maggiori dettagli, vedi Attivare un flusso di lavoro utilizzando Eventarc e Terraform.

Nota: anche se il trigger viene creato immediatamente, la propagazione e il filtro degli eventi possono richiedere fino a due minuti.

Elenca un attivatore

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

Console

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

   Vai a Trigger

   Questa pagina elenca i tuoi trigger in tutte le località e include dettagli quali nomi, aree geografiche, provider di eventi, destinazioni e altro ancora.

2. Per filtrare i trigger:

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

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

3. Per ordinare gli attivatori, fai clic su Ordina accanto a qualsiasi intestazione di colonna supportata.

gcloud

Esegui il comando seguente per elencare i trigger:

gcloud eventarc triggers list --location=-

Questo comando elenca i tuoi trigger in tutte le località e include dettagli quali nomi, tipi, destinazioni e stati.

Passaggi successivi

• Attiva un flusso di lavoro utilizzando Eventarc e Terraform

• Scopri di più su Eventarc