Inoltra gli eventi di avviso Firebase a Workflows

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

Gli eventi vengono pubblicati nel formato CloudEvents tramite una richiesta HTTP. Il servizio Workflows converte l'evento in un oggetto JSON (secondo la 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 dei flussi di lavoro.

Queste istruzioni mostrano come configurare il routing degli eventi in modo che un'esecuzione del tuo workflow venga attivata in risposta a un eventoFirebase 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 avviso Firebase viene pubblicato da un servizio Firebase.

Prepararsi a creare un trigger

Prima di creare un attivatore 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 Google Cloud progetto.

    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 Firebase Alerts gli eventi, abilita l'Firebase Alerts API.

  4. Se non ne hai già uno, crea un account di servizio gestito dall'utente, quindi concedi 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 Account di servizio.

      Vai a Service account

    2. Seleziona il progetto.

    3. Inserisci un nome nel campo Nome account di servizio. La console Google Cloud compila il 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 IAM (Identity and Access Management) richiesti da concedere all'account di servizio. Per ulteriori informazioni, consulta Ruoli e autorizzazioni per i target di flusso di 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 Firebase Alerts eventi, attivafirestore.googleapis.com.

  4. Se non ne hai già uno, crea un account di servizio gestito dall'utente, quindi concedi 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 dell'account di servizio. Deve essere compreso tra 6 e 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ù, consulta Ruoli e autorizzazioni per i target di flusso di lavoro.

Crea un trigger

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

Console

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

    Vai ai 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 attivatore, seleziona Origini Google.
  5. Nell'elenco Provider di eventi, seleziona Firebase Alerts.

    Tieni presente che il nome del provider di eventi utilizzato nella documentazioneGoogle Cloud associata potrebbe non avere un prefisso 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 dagli eventi Diretti.
  7. Per specificare la codifica del payload dell'evento, nell'elenco Tipo di contenuto dei dati dell'evento, seleziona application/json o application/protobuf.

    Tieni presente che un payload evento formattato in JSON è più grande di uno formato in Protobuf. Ciò potrebbe influire sull'affidabilità a seconda della destinazione degli eventi e dei relativi limiti di dimensione. Per ulteriori informazioni, consulta la sezione Problemi noti.

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

    Per ulteriori informazioni, consulta Località Eventarc.

  9. Nel campo Attributo 1, l'ID risorsa alerttype funge da filtro per gli 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 viene registrato un nuovo dispositivo di tester iOS per una determinata app
    • billing.planAutomatedUpdate: l'evento viene inviato quando il piano di fatturazione di 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 il piano di fatturazione di un progetto Firebase viene modificato da un utente, 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 eseguire la simbolizzazione di un report sugli arresti anomali in entrata
    • crashlytics.newAnrIssue: l'evento viene inviato quando un'app riscontra un nuovo errore ANR (L'applicazione non risponde) (non per eventuali eventi successivi e identici).
    • L'evento crashlytics.newFatalIssue viene inviato quando un'app riscontra un nuovo arresto anomalo fatale (non per eventi identici successivi).
    • crashlytics.newNonfatalIssue: l'evento viene inviato quando un'app riscontra un nuovo errore non irreversibile (non per eventi identici successivi)
    • L'evento crashlytics.regression viene inviato quando un'app si arresta in modo anomalo per un problema contrassegnato come chiuso per una versione precedente dell'app
    • L'evento crashlytics.stabilityDigest viene inviato quando viene inviata una notifica relativa ai problemi di tendenza più importanti in Crashlytics
    • L'evento crashlytics.velocity viene inviato quando un singolo problema provoca 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. Se vuoi, puoi filtrare gli eventi per un ID app Firebase specifico. Fai clic su Aggiungi filtro e specifica il appid.
  12. Seleziona l'account di servizio che chiamerà 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 all'attivatore e a cui hai precedentemente assegnato ruoli specifici richiesti da Eventarc.

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

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

    Per ulteriori informazioni, consulta Creare un attivatore per Workflows.

  15. Fai clic su Crea.

    16. Una volta creato un attivatore, i filtri delle origini evento non possono essere modificati. Crea invece un nuovo attivatore ed elimina quello precedente. Per saperne di più, consulta Gestire gli attivatori.

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 dell'attivatore o un identificatore completamente qualificato.
  • DESTINATION_WORKFLOW: l'ID del workflow di cui è stato eseguito il deployment che riceve gli eventi dall'attivatore. Il workflow può trovarsi in una delle località supportate per i workflow e non deve trovarsi nella stessa località dell'attivatore. Tuttavia, il flusso di lavoro 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 flusso di lavoro si trovi nella stessa posizione dell'attivatore.
  • 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 viene registrato un nuovo dispositivo di tester iOS per una determinata app
    • billing.planAutomatedUpdate: l'evento viene inviato quando il piano di fatturazione di 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 il piano di fatturazione di un progetto Firebase viene modificato da un utente, 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 eseguire la simbolizzazione di un report sugli arresti anomali in entrata
    • crashlytics.newAnrIssue: l'evento viene inviato quando un'app riscontra un nuovo errore ANR (L'applicazione non risponde) (non per eventuali eventi successivi e identici).
    • L'evento crashlytics.newFatalIssue viene inviato quando un'app riscontra un nuovo arresto anomalo fatale (non per eventi identici successivi).
    • crashlytics.newNonfatalIssue: l'evento viene inviato quando un'app riscontra un nuovo errore non irreversibile (non per eventi identici successivi)
    • L'evento crashlytics.regression viene inviato quando un'app si arresta in modo anomalo per un problema contrassegnato come chiuso per una versione precedente dell'app
    • L'evento crashlytics.stabilityDigest viene inviato quando viene inviata una notifica relativa ai problemi di tendenza più importanti in Crashlytics
    • L'evento crashlytics.velocity viene inviato quando un singolo problema provoca 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
    Per ALERT_TYPE, l'operatore deve essere uno dei seguenti:
    • Uguale; ad esempio, --event-filters="alerttype=appDistribution.inAppFeedback"
    • Motivo del percorso; ad esempio, --event-filters-path-pattern="alerttype=appDistribution." o --event-filters-path-pattern="alerttype=crashlytics.new".

      Per ulteriori informazioni, consulta 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 formato in Protobuf. Ciò potrebbe influire sull'affidabilità a seconda della destinazione dell'evento e dei relativi limiti di dimensione. Per ulteriori informazioni, consulta la sezione Problemi noti.

  • SERVICE_ACCOUNT_NAME: il nome dell'account di servizio IAM creato a cui hai concesso ruoli specifici richiesti da Workflows.
  • PROJECT_ID: il tuo Google Cloud ID progetto

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" o --event-filters-path-pattern="alerttype=ALERT_TYPE"
  • Una volta creato un attivatore, il tipo di filtro evento non può essere modificato. Per un tipo di evento diverso, devi creare un nuovo attivatore.
  • Se vuoi, 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 verrà utilizzato dall'trigger Eventarc per invocare 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ù sugli account di servizio, consulta Creare e gestire gli account di servizio.
  • Per impostazione predefinita, le sottoscrizioni Pub/Sub create per Eventarc rimangono invariate 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 attivatore 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, consulta Attivare un flusso di lavoro utilizzando Eventarc e Terraform.

Elenca un trigger

Puoi confermare la creazione di un attivatore elencando gli attivatori Eventarc utilizzando Google Cloud CLI o la console Google Cloud.

Console

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

    Vai ai trigger

    Questa pagina elenca gli attivatori in tutte le località e include dettagli come nomi, regioni, fornitori di eventi, destinazioni e altro ancora.

  2. Per filtrare gli attivatori:

    1. Fai clic su Filtro o sul campo Attivatori filtro.
    2. Nell'elenco Proprietà, seleziona un'opzione in base alla quale filtrare gli attivatori.

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

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

gcloud

Esegui il comando seguente per elencare gli attivatori:

gcloud eventarc triggers list --location=-

Questo comando elenca gli attivatori in tutte le località e include dettagli come nomi, tipi, destinazioni e stati.

Passaggi successivi