Instrada gli eventi di Cloud Firestore a Cloud Run

Anteprima - Cloud Firestore direct events

Questa funzionalità è soggetta ai "Termini delle Offerte pre-GA" nella sezione Termini generali del servizio dei Termini specifici dei servizi. Le funzionalità pre-GA sono disponibili "così come sono" e potrebbero avere un supporto limitato. Per saperne di più, consulta le descrizioni della fase di lancio.

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, tra cui l'origine dell'evento e il servizio Cloud Run di destinazione.

Eventarc consegna gli eventi al ricevitore di eventi in un formato CloudEvents tramite una richiesta HTTP.

Queste istruzioni mostrano come configurare il routing degli eventi al servizio Cloud Run attivato da un evento Cloud Firestore diretto. Per ulteriori dettagli, consulta l'elenco degli eventi diretti supportati.

Nota: se un provider Google supporta sia gli eventi diretti che quelli del log di controllo, ti consigliamo di creare un trigger che filtri l'evento diretto. Gli eventi diretti offrono una serie di vantaggi rispetto agli eventi degli audit log. Per ulteriori informazioni, consulta la sezione Route di eventi.

Prepararsi a creare un trigger

Prima di creare un trigger, completa questi prerequisiti:

Console

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

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

   Vai al selettore di progetti

2. Abilitare le API Cloud Logging, Eventarc ed Eventarc Publishing.

   Abilita le API

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

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

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

      Vai a Crea account di servizio

   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 Identity and Access Management (IAM) richiesti da concedere al tuo account di servizio per le chiamate autenticate o non autenticate. Per ulteriori informazioni, consulta Ruoli e autorizzazioni per le destinazioni di Cloud Run.

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

      Importante: per accettare chiamate autenticate al servizio Cloud Run, devi associare il trigger a un account di servizio con il ruolo roles/run.invoker. Quando crei o aggiorni il trigger, seleziona l'account di servizio.

   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. Abilitare le API Cloud Logging, Eventarc ed Eventarc Publishing.

   gcloud services enable logging.googleapis.com \
     eventarc.googleapis.com \
     eventarcpublishing.googleapis.com

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

4. Se non ne hai già uno, crea un account di servizio gestito dall'utente, quindi concedigli i ruoli e le autorizzazioni necessari in modo che Eventarc possa gestire gli eventi per il tuo servizio 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. Dopo aver creato un account di servizio, non puoi modificarne il nome.

   2. Concedi le autorizzazioni o i ruoli Identity and Access Management (IAM) richiesti per le chiamate autenticate o non autenticate. Per ulteriori informazioni, consulta Ruoli e autorizzazioni per le destinazioni di Cloud Run.

   Importante: per accettare chiamate autenticate al servizio Cloud Run, devi associare il trigger a un account di servizio con il ruolo roles/run.invoker. Quando crei o modifichi il trigger, utilizza il flag --service-account per associare l'account di servizio al trigger.

Crea un trigger

Puoi creare un trigger Eventarc utilizzando Google Cloud CLI o la console Google Cloud.

Nota: il filtro viene applicato tramite una corrispondenza esatta e non supporta caratteri jolly o espressioni regolari. Tuttavia, puoi utilizzare il flag --event-filters-path-pattern nel seguente comando gcloud CLI oppure definire un pattern del percorso tramite la console. Per ulteriori informazioni, consulta Comprendere i pattern dei percorsi.

Console

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

   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 il Tipo di attivatore, seleziona Origini Google.
5. Nell'elenco Provider di eventi, seleziona Cloud Firestore.

   Tieni presente che il nome del provider di eventi utilizzato nella documentazione di Google Cloud associata potrebbe non avere un prefisso di Cloud o Google Cloud. Ad esempio, nella console, Memorystore per Redis viene chiamato Google Cloud Memorystore for Redis.

6. Nell'elenco Evento, seleziona un evento per il tipo di evento Diretto.
7. Nell'elenco Tipo di contenuto dei dati sugli eventi, seleziona la codifica del payload dell'evento.

   Per gli eventi diretti da Cloud Firestore, deve essere application/protobuf e i dati dell'evento sono un array di byte. Per ulteriori informazioni sui messaggi protobuf per gli eventi di Cloud Firestore, consulta Eventi comuni.

8. Nell'elenco Regione, seleziona la stessa regione del servizio Google Cloud che genera eventi.

   Per ulteriori informazioni, consulta le località Eventarc.

9. Se applicabile al provider di eventi, fai clic su Aggiungi filtro e specifica quanto segue:
   1. Nel campo Attributo 1, a seconda dell'evento diretto che hai scelto, seleziona un ID risorsa che possa fungere da filtro di eventi.
   2. Seleziona un operatore:
      • Uguale
      • Pattern del percorso

        Per maggiori informazioni, consulta la pagina Comprendere i pattern dei percorsi.

   3. Nel campo Valore attributo 1, a seconda dell'operatore che hai scelto, digita il valore esatto o applica un pattern del percorso.
   4. Se è applicabile un campo Attributo 2, specifica i valori appropriati.
10. Seleziona l'account di servizio che richiama 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 hai precedentemente concesso i ruoli specifici richiesti da Eventarc.

11. Nell'elenco Destinazione evento, seleziona Cloud Run.
12. Seleziona un servizio.
    

    Si tratta del nome del servizio che riceve gli eventi per il trigger. Il servizio deve trovarsi nello stesso progetto del trigger e riceverà eventi come richieste HTTP POST inviate al percorso dell'URL principale (/), ogni volta che viene generato l'evento.

13. Facoltativamente, puoi specificare il percorso dell'URL del servizio a cui inviare la richiesta in entrata.

    Questo è il percorso relativo del servizio di destinazione a cui devono essere inviati gli eventi per il trigger. Ad esempio: /, /route, route, route/subroute.

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 ulteriori informazioni, consulta Gestire i trigger.

gcloud

Puoi creare un trigger eseguendo un comando gcloud eventarc triggers create insieme a flag obbligatori e facoltativi.

I flag variano a seconda che tu stia eseguendo Firestore in modalità nativa o in modalità Datastore. Per ulteriori informazioni, consulta la sezione Scegliere tra la modalità nativa e la modalità Datastore.

Modalità nativa

gcloud eventarc triggers create TRIGGER \
    --location=LOCATION \
    --destination-run-service=DESTINATION_RUN_SERVICE \
    --destination-run-region=DESTINATION_RUN_REGION \
    --event-filters="type=EVENT_FILTER_TYPE" \
    --event-filters="database=DATABASE" \
    --event-filters="namespace=NAMESPACE" \
    --event-filters-path-pattern="document=DOCUMENT" \
    --event-data-content-type="EVENT_DATA_CONTENT_TYPE" \
    --service-account=SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com"

Modalità Datastore

gcloud eventarc triggers create TRIGGER \
    --location=LOCATION \
    --destination-run-service=DESTINATION_RUN_SERVICE \
    --destination-run-region=DESTINATION_RUN_REGION \
    --event-filters="type=EVENT_FILTER_TYPE" \
    --event-filters="database=DATABASE" \
    --event-filters="namespace=NAMESPACE" \
    --event-filters-path-pattern="entity=ENTITY" \
    --event-data-content-type="EVENT_DATA_CONTENT_TYPE" \
    --service-account=SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com"

Sostituisci quanto segue:

• TRIGGER: l'ID dell'attivatore o un identificatore completo.

• LOCATION: la posizione del trigger Eventarc. In alternativa, puoi impostare la proprietà eventarc/location, ad esempio gcloud config set eventarc/location us-central1.

  I trigger di Cloud Firestore per Eventarc sono disponibili solo in determinate località e il trigger deve trovarsi nella stessa località del database Cloud Firestore. Per ulteriori informazioni, consulta le località Eventarc e le località di Cloud Firestore.

• DESTINATION_RUN_SERVICE: il nome del servizio Cloud Run che riceve gli eventi per il trigger. Il servizio può trovarsi in una qualsiasi delle località supportate da Cloud Run e non deve trovarsi nella stessa località del trigger. Tuttavia, il servizio deve trovarsi nello stesso progetto del trigger e riceverà eventi come richieste HTTP POST inviate al percorso dell'URL principale (/), ogni volta che l'evento viene generato.
• DESTINATION_RUN_REGION: (facoltativo) la regione in cui si trova il servizio Cloud Run di destinazione. Se non specificata, si presume che il servizio si trovi nella stessa regione del trigger.
• EVENT_FILTER_TYPE: l'identificatore dell'evento. Quando una chiamata API per il metodo ha esito positivo, viene generato un evento. Per le operazioni a lunga esecuzione, l'evento viene generato solo al termine dell'operazione e solo se l'azione viene eseguita correttamente. Per un elenco dei tipi di eventi supportati, vedi Tipi di eventi supportati da Eventarc.
Cloud Firestore supporta i seguenti tipi di eventi solo in modalità nativa. Il tipo di evento google.cloud.firestore.document.v1.written comprende tutte le modifiche a un documento.
• google.cloud.firestore.document.v1.created: l'evento viene inviato quando un documento viene scritto per la prima volta
• google.cloud.firestore.document.v1.updated: l'evento viene inviato quando un documento esiste già e ha un valore modificato
• google.cloud.firestore.document.v1.deleted: l'evento viene inviato quando viene eliminato un documento
• google.cloud.firestore.document.v1.written: l'evento viene inviato quando un documento viene creato, aggiornato o eliminato

Cloud Firestore supporta i seguenti tipi di eventi in solo modalità Datastore. Gli oggetti di dati in Firestore in modalità Datastore sono noti come entità. Il tipo di evento google.cloud.datastore.entity.v1.written include tutte le modifiche a un'entità.

• google.cloud.datastore.entity.v1.created: l'evento viene inviato quando un'entità viene scritta per la prima volta
• google.cloud.datastore.entity.v1.updated: l'evento viene inviato quando esiste già un'entità con un valore modificato
• google.cloud.datastore.entity.v1.deleted: l'evento viene inviato quando viene eliminata un'entità
• google.cloud.datastore.entity.v1.written: l'evento viene inviato quando un'entità viene creata, aggiornata o eliminata

• DATABASE: il database Firestore. Come nome del database predefinito, utilizza (default).

• NAMESPACE (facoltativo): lo spazio dei nomi del database Firestore. Per lo spazio dei nomi predefinito in modalità Datastore, utilizza (default). Se non specificato, viene creata una corrispondenza con carattere jolly (*) a qualsiasi occorrenza.

• DOCUMENT (facoltativo): applicabile alle istanze di database in esecuzione solo in modalità nativa. Il percorso del database da cui vuoi ricevere gli eventi dal momento in cui i dati vengono creati, aggiornati o eliminati in quel percorso. L'operatore può essere uno dei seguenti:

  • Uguale; ad esempio, --event-filters="document=DOCUMENT"
  • Pattern del percorso; ad esempio, --event-filters-path-pattern="document=DOCUMENT". Per ulteriori informazioni, consulta Comprendere i pattern dei percorsi.

• ENTITY (facoltativo): applicabile alle istanze di database in esecuzione solo in modalità Datastore. Il percorso del database da cui vuoi ricevere gli eventi dal momento in cui i dati vengono creati, aggiornati o eliminati in quel percorso. L'operatore può essere uno dei seguenti:

  • Uguale; ad esempio, --event-filters="document=ENTITY"

  • Pattern del percorso; ad esempio, --event-filters-path-pattern="ENTITY=ENTITY". Per ulteriori informazioni, consulta Comprendere i pattern dei percorsi.

    Tieni presente che potrebbe essere necessario eseguire l'escape dei caratteri negli ID tipo e negli ID entità. L'uso di caratteri di escape per un carattere consente al filtro di eventi di interpretare correttamente l'ID. Per ulteriori informazioni, consulta la sezione Carattere di escape.

• EVENT_DATA_CONTENT_TYPE: la codifica del payload dell'evento. Per gli eventi diretti da Firestore, deve essere application/protobuf e i dati degli eventi sono un array di byte. Per ulteriori informazioni sui messaggi protobuf per gli eventi di Cloud Firestore, consulta Eventi comuni.

• SERVICE_ACCOUNT_NAME: il nome del tuo account di servizio gestito dall'utente.
• PROJECT_ID: il tuo ID progetto Google Cloud.

Note:

• Per gli eventi diretti da Cloud Firestore, la codifica del payload dell'evento è application/protobuf.
• Il flag --event-filters="type=EVENT_FILTER_TYPE" è obbligatorio. Se non è impostato nessun altro filtro di eventi, vengono abbinati gli eventi per tutte le risorse.
• Impossibile modificare EVENT_FILTER_TYPE dopo la creazione. Per modificare EVENT_FILTER_TYPE, crea un nuovo trigger ed elimina quello precedente.
• Ogni attivatore può avere più filtri evento, delimitati da virgole in un flag --event-filters=[ATTRIBUTE=VALUE,...] oppure ripetere il flag per aggiungere altri filtri. Solo gli eventi che corrispondono a tutti i filtri vengono inviati alla destinazione. I caratteri jolly e le espressioni regolari non sono supportati; tuttavia, quando utilizzi il flag --event-filters-path-pattern, puoi definire un pattern del percorso della risorsa.
• Il flag --service-account viene utilizzato per specificare l'indirizzo email dell'account di servizio Identity and Access Management (IAM) associato all'attivatore.
• Facoltativamente, specifica un percorso relativo nel servizio Cloud Run di destinazione a cui devono essere inviati gli eventi per il trigger utilizzando il flag --destination-run-path.

Esempio:

gcloud eventarc triggers create helloworld-trigger \
    --location=us-east1 \
    --destination-run-service=helloworld-events \
    --destination-run-region=us-east1 \
    --event-filters="type=google.cloud.firestore.document.v1.updated" \
    --event-filters="database=my-database" \
    --event-filters-path-pattern="document=users/my-document-*" \
    --event-data-content-type="application/protobuf" \
    --service-account=${SERVICE_ACCOUNT_NAME}@${PROJECT_ID}.iam.gserviceaccount.com

Questo comando crea un trigger denominato helloworld-trigger per l'evento identificato come google.cloud.firestore.document.v1.updated nell'istanza di database my-database in esecuzione in modalità nativa e filtra gli eventi per document percorsi che corrispondono a users/my-document-.

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

Elenca un trigger

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

Console

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

   Vai ai trigger

   Questa pagina elenca i tuoi trigger 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 per filtrare gli attivatori.

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

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

gcloud

Esegui questo comando per elencare i trigger:

gcloud eventarc triggers list --location=-

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

Passaggi successivi

• Scopri di più su Eventarc.
• Scopri come gestire gli attivatori.