Creare trigger dagli eventi Firestore

Questa guida illustra le istruzioni per creare trigger per i servizi e le funzioni Cloud Run dagli eventi Firestore.

Puoi configurare i tuoi servizi Cloud Run in modo che vengano attivati da eventi in un database Firestore. Quando viene attivato, il servizio legge e aggiorna un database Firestore in risposta a questi eventi tramite le API e le librerie client di Firestore.

In un ciclo di vita tipico, quando un servizio Cloud Run viene attivato da eventi Firestore, si verifica quanto segue:

  1. Il servizio attende le modifiche a un determinato documento.

  2. Quando si verifica una modifica, il servizio viene attivato ed esegue le attività.

  3. Il servizio riceve un oggetto dati con uno snapshot del documento interessato. Per gli eventi write o update, l'oggetto dati contiene snapshot che rappresentano lo stato del documento prima e dopo l'evento di attivazione.

Tipi di evento

Firestore supporta gli eventi create, update, delete e write. L'evento write comprende tutte le modifiche apportate a un documento.

Tipo di evento Trigger
google.cloud.firestore.document.v1.created (valore predefinito) Si attiva quando un documento viene scritto per la prima volta.
google.cloud.firestore.document.v1.updated Si attiva quando un documento esiste già e un valore è stato modificato.
google.cloud.firestore.document.v1.deleted Si attiva quando viene eliminato un documento con dati.
google.cloud.firestore.document.v1.written Si attiva quando un documento viene creato, aggiornato o eliminato.

I caratteri jolly vengono scritti nei trigger utilizzando le parentesi graffe, ad esempio: projects/YOUR_PROJECT_ID/databases/(default)/documents/collection/{document_wildcard}

Specifica il percorso del documento

Per attivare il servizio, specifica un percorso del documento da monitorare. Il percorso del documento deve trovarsi nello stesso Google Cloud progetto del servizio.

Ecco alcuni esempi di percorsi di documenti validi:

  • users/marie: trigger valido. Monitora un singolo documento, /users/marie.

  • users/{username}: trigger valido. Monitora tutti i documenti utente. I caratteri jolly vengono utilizzati per monitorare tutti i documenti della raccolta.

  • users/{username}/addresses: trigger non valido. Si riferisce alla raccolta secondaria addresses, non a un documento.

  • users/{username}/addresses/home: trigger valido. Monitora il documento dell'indirizzo home per tutti gli utenti.

  • users/{username}/addresses/{addressId}: trigger valido. Monitora tutti i documenti dell'indirizzo.

  • users/{user=**}: trigger valido. Monitora tutti i documenti utente e tutti i documenti nelle raccolte secondarie di ciascun documento utente, ad esempio /users/userID/address/home o /users/userID/phone/work.

Caratteri jolly e parametri

Se non conosci il documento specifico che vuoi monitorare, utilizza {wildcard} anziché l'ID documento:

  • users/{username} rileva le modifiche apportate a tutti i documenti utente.

In questo esempio, quando viene modificato un campo in un documento in users, corrisponde a un carattere jolly chiamato {username}.

Se un documento in users ha raccolte secondarie e un campo in uno dei documenti di queste raccolte secondarie viene modificato, il carattere jolly {username} non viene attivato. Se il tuo obiettivo è rispondere anche agli eventi nelle sottoraccolte, utilizza il carattere jolly multi-segmento {username=**}.

Le corrispondenze con caratteri jolly vengono estratte dai percorsi dei documenti. Puoi definire tutti i caratteri jolly che vuoi per sostituire gli ID raccolta o documento espliciti. Puoi utilizzare fino a un carattere jolly multi-segmento come {username=**}.

Strutture degli eventi

Questo trigger richiama il servizio con un evento simile a: 

{
    "oldValue": { // Update and Delete operations only
        A Document object containing a pre-operation document snapshot
    },
    "updateMask": { // Update operations only
        A DocumentMask object that lists changed fields.
    },
    "value": {
        // A Document object containing a post-operation document snapshot
    }
}

Ogni oggetto Document contiene uno o più oggetti Value. Per i riferimenti ai tipi, consulta la documentazione di Value.

Prima di iniziare

  1. Assicurati di aver configurato un nuovo progetto per Cloud Run come descritto nella pagina di configurazione.

  2. Abilita le API Artifact Registry, Cloud Build, API Cloud Run Admin, Eventarc, Firestore Cloud Logging e API Pub/Sub:

    Abilita le API

  3. Concedi i ruoli e le autorizzazioni IAM richiesti.

Ruoli richiesti per l'account di deployment

Per ottenere le autorizzazioni necessarie per attivare eventi Firestore, chiedi all'amministratore di concederti i seguenti ruoli IAM nel progetto:

Per saperne di più sulla concessione dei ruoli, consulta Gestisci l'accesso a progetti, cartelle e organizzazioni.

Potresti anche riuscire a ottenere le autorizzazioni richieste tramite i ruoli personalizzati o altri ruoli predefiniti.

Tieni presente che per impostazione predefinita, le autorizzazioni di Cloud Build includono le autorizzazioni per caricare e scaricare gli artefatti di Artifact Registry.

Configura il database Firestore

Prima di eseguire il deployment del servizio, devi creare un database Firestore:

  1. Vai alla pagina Dati Firestore.

  2. Seleziona Crea database.

  3. Fai clic su Modalità nativa, quindi seleziona Continua.

  4. Nel campo Dai un nome al database, inserisci un ID database, ad esempio firestore-db.

  5. In Tipo di località, seleziona Regione e scegli la regione in cui deve risiedere il database. Questa scelta è definitiva.

  6. Lascia invariata la sezione Regole di protezione.

  7. Fai clic su Crea database.

Il modello dati di Firestore è costituito da raccolte che contengono documenti. Un documento contiene una serie di coppie chiave-valore.

Creazione di trigger

A seconda del tipo di servizio che stai implementando, puoi:

Crea un trigger per i servizi

Dopo aver eseguito il deployment di un servizio, puoi configurare un trigger utilizzando la console Google Cloud , Google Cloud CLI o Terraform.

Console

  1. Esegui il deployment del servizio Cloud Run utilizzando container o da origine.

  2. Nella console Google Cloud , vai a Cloud Run:

    Vai a Cloud Run

  3. Nell'elenco dei servizi, fai clic su un servizio esistente.

  4. Nella pagina dei dettagli del servizio, vai alla scheda Trigger.

  5. Fai clic su Aggiungi attivatore e seleziona Attivatore Firestore.

  6. Nel riquadro Trigger Eventarc, modifica i dettagli del trigger come segue:

    1. Nel campo Nome trigger, inserisci un nome per il trigger o utilizza il nome predefinito.

    2. Seleziona un tipo di trigger dall'elenco per specificare uno dei seguenti tipi di trigger:

      • Origini Google per specificare i trigger per Pub/Sub, Cloud Storage, Firestore e altri provider di eventi Google.

      • Terze parti per l'integrazione con provider non Google che offrono un'origine Eventarc. Per saperne di più, vedi Eventi di terze parti in Eventarc.

    3. Seleziona Firestore dall'elenco Provider di eventi per selezionare un prodotto che fornisca il tipo di evento per attivare il servizio. Per l'elenco dei fornitori di eventi, vedi Fornitori e destinazioni di eventi.

    4. Seleziona type=google.cloud.firestore.document.v1.created dall'elenco Tipo di evento. La configurazione del trigger varia a seconda del tipo di evento supportato. Per saperne di più, consulta Tipi di eventi.

    5. Nella sezione Filtri, seleziona un database, un'operazione e valori degli attributi oppure utilizza le selezioni predefinite.

    6. Se il campo Regione è attivato, seleziona una posizione per il trigger Eventarc. In generale, la località di un trigger Eventarc deve corrispondere a quella della Google Cloud risorsa che vuoi monitorare per gli eventi. Nella maggior parte degli scenari, devi anche deployare il servizio nella stessa regione. Per maggiori dettagli sulle località dei trigger Eventarc, consulta Informazioni sulle località Eventarc.

    7. Nel campo Service account, seleziona un account di servizio. I trigger Eventarc sono collegati ai service account da utilizzare come identità quando viene richiamato il servizio. Il account di servizio del trigger Eventarc deve disporre dell'autorizzazione per richiamare il servizio. Per impostazione predefinita, Cloud Run utilizza l'account di servizio predefinito di Compute Engine.

    8. (Facoltativo) Specifica il percorso dell'URL del servizio a cui inviare la richiesta in entrata. Questo è il percorso relativo nel servizio di destinazione a cui devono essere inviati gli eventi per il trigger. Ad esempio: /, /route, route e route/subroute.

    9. (Facoltativo) Per abilitare i nuovi tentativi se il tentativo di consegna non va a buon fine, seleziona la casella di controllo Abilita ripetizione dei tentativi in caso di errore; in caso contrario, il comportamento predefinito è un singolo tentativo di consegna senza ripetizioni. Per saperne di più, consulta Nuovi tentativi per gli eventi.

    10. Una volta compilati i campi obbligatori, fai clic su Salva attivatore.

  7. Dopo aver creato il trigger, verifica il suo stato assicurandoti che sia presente un segno di spunta nella scheda Trigger.

gcloud

  1. Esegui il deployment del servizio Cloud Run utilizzando container o da origine.

  2. Esegui questo comando per creare un trigger che filtri ed esegua il routing degli eventi:

    gcloud eventarc triggers create TRIGGER_NAME  \
    --location=LOCATION \
    --destination-run-service=DESTINATION_RUN_SERVICE  \
    --destination-run-region=DESTINATION_RUN_REGION \
    --event-filters="type=EVENT_FILTER_TYPE" \
    --service-account=SERVICE_ACCOUNT_NAME@PROJECT_ID.

    Sostituisci quanto segue:

    • TRIGGER_NAME: l'ID del trigger 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.

      Per evitare problemi di prestazioni e residenza dei dati, la località deve corrispondere a quella del Google Cloud servizio che genera eventi. Per saperne di più, consulta Località Eventarc.

    • 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à gli eventi come richieste HTTP POST inviate al percorso dell'URL principale (/), ogni volta che l'evento viene generato.
    • DESTINATION_RUN_REGION: (facoltativo) la posizione di Cloud Run in cui si trova il servizio Cloud Run di destinazione. Se non specificato, si presume che il servizio si trovi nella stessa regione del trigger.
    • EVENT_FILTER_TYPE: l'identificatore dell'evento. Viene generato un evento quando una chiamata API per il metodo ha esito positivo. 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, consulta Tipi di eventi Google supportati da Eventarc.
    • SERVICE_ACCOUNT_NAME: il nome del account di servizio gestito dall'utente.
    • PROJECT_ID: il tuo ID progetto Google Cloud .

    Note:

    • Una volta creato un trigger, non è possibile modificare il tipo di filtro eventi. Per un tipo di evento diverso, devi creare un nuovo trigger.
    • --event-filters=type=google.cloud.firestore.document.v1.written specifica che la funzione viene attivata quando un documento viene creato, aggiornato o eliminato, in base al tipo di evento.
    • --event-filters=database='(default)' specifica il database Firebase. Per il nome del database predefinito, utilizza (default).
    • --event-filters-path-pattern=document='users/{username}' fornisce il pattern del percorso dei documenti da monitorare per le modifiche pertinenti. Questo pattern di percorso indica che devono essere monitorati tutti i documenti della raccolta users. Per saperne di più, vedi Informazioni sui pattern di percorso.
    • (Facoltativo) Per specificare un singolo tentativo di invio di eventi senza ripetizioni, utilizza il flag --max-retry-attempts. L'unico valore valido è 1. Se ometti il flag, viene applicato il comportamento di ripetizione standard. Per saperne di più, vedi Nuovi tentativi per gli eventi.
    • Sono disponibili altri flag. Per saperne di più, vedi gcloud eventarc triggers create.

Terraform

Per creare un trigger Eventarc per un servizio Cloud Run, consulta Crea un trigger utilizzando Terraform.

Crea un trigger per le funzioni

Dopo aver eseguito il deployment di una funzione, puoi configurare un trigger utilizzando la console Google Cloud , Google Cloud CLI o Terraform.

Console

Quando utilizzi la console Google Cloud per creare una funzione, puoi anche aggiungere un trigger alla funzione. Per creare un attivatore per la tua funzione:

  1. Nella console Google Cloud , vai a Cloud Run:

    Vai a Cloud Run

  2. Fai clic su Scrivi una funzione e inserisci i dettagli della funzione. Per ulteriori informazioni sulla configurazione delle funzioni durante il deployment, consulta Esegui il deployment delle funzioni.

  3. Nella sezione Attivatore, fai clic su Aggiungi attivatore.

  4. Seleziona Trigger di Firestore.

  5. Nel riquadro Trigger Eventarc, modifica i dettagli del trigger come segue:

    1. Inserisci un nome per l'attivatore nel campo Nome attivatore o utilizza il nome predefinito.

    2. Seleziona un tipo di trigger dall'elenco:

      • Origini Google per specificare i trigger per Pub/Sub, Cloud Storage, Firestore e altri provider di eventi Google.

      • Terze parti per l'integrazione con provider non Google che offrono un'origine Eventarc. Per saperne di più, vedi Eventi di terze parti in Eventarc.

    3. Seleziona Firestore dall'elenco Provider di eventi per selezionare un prodotto che fornisca il tipo di evento per attivare la funzione. Per l'elenco dei fornitori di eventi, vedi Fornitori e destinazioni di eventi.

    4. Seleziona type=google.cloud.firestore.document.v1.created dall'elenco Tipo di evento. La configurazione del trigger varia a seconda del tipo di evento supportato. Per saperne di più, consulta Tipi di eventi.

    5. Nella sezione Filtri, seleziona un database, un'operazione e valori degli attributi oppure utilizza le selezioni predefinite.

    6. Se il campo Regione è attivo, seleziona una posizione per il trigger Eventarc. In generale, la località di un trigger Eventarc deve corrispondere a quella della risorsaGoogle Cloud che vuoi monitorare per gli eventi. Nella maggior parte degli scenari, devi anche eseguire il deployment della funzione nella stessa regione. Per ulteriori dettagli sulle località dei trigger Eventarc, consulta la sezione Informazioni sulle località Eventarc.

    7. Nel campo Service account, seleziona un account di servizio. I trigger Eventarc sono collegati a service account da utilizzare come identità quando viene richiamata la funzione. Il account di servizio del trigger Eventarc deve disporre dell'autorizzazione per richiamare la funzione. Per impostazione predefinita, Cloud Run utilizza l'account di servizio predefinito di Compute Engine.

    8. (Facoltativo) Specifica il percorso dell'URL del servizio a cui inviare la richiesta in entrata. Questo è il percorso relativo nel servizio di destinazione a cui devono essere inviati gli eventi per il trigger. Ad esempio: /, /route, route e route/subroute.

    9. (Facoltativo) Per abilitare i nuovi tentativi se il tentativo di consegna non va a buon fine, seleziona la casella di controllo Abilita ripetizione dei tentativi in caso di errore; in caso contrario, il comportamento predefinito è un singolo tentativo di consegna senza ripetizioni. Per saperne di più, consulta Nuovi tentativi per gli eventi.

  6. Una volta compilati i campi obbligatori, fai clic su Salva attivatore.

  7. Fai clic su Crea.

  8. Nella scheda Origine, modifica il codice sorgente se necessario, poi seleziona Salva e ridistribuisci.

gcloud

Quando crei una funzione utilizzando gcloud CLI, devi prima eseguirne il deployment e poi creare un trigger. Per creare un trigger per la tua funzione:

  1. Esegui questo comando nella directory che contiene il codice campione per eseguire il deployment della funzione:

    gcloud run deploy FUNCTION \
    --source . \
    --function FUNCTION_ENTRYPOINT \
    --base-image BASE_IMAGE_ID \
    --region REGION

    Sostituisci quanto segue:

    • FUNCTION: il nome della funzione di cui stai eseguendo il deployment. Puoi omettere completamente questo parametro, ma ti verrà chiesto il nome se lo ometti.

    • FUNCTION_ENTRYPOINT: l'entry point della funzione nel codice sorgente. Questo è il codice che Cloud Run esegue quando viene eseguita la funzione. Il valore di questo flag deve essere un nome di funzione o un nome di classe completo esistente nel codice sorgente.

    • BASE_IMAGE_ID: l'ambiente dell'immagine di base per la funzione. Per maggiori dettagli sulle immagini di base e sui pacchetti inclusi in ogni immagine, consulta Immagini di base dei runtime.

    • REGION: la regione Google Cloudin cui vuoi eseguire il deployment della funzione. Ad esempio: europe-west1.

  2. Esegui questo comando per creare un trigger che filtri ed esegua il routing degli eventi:

    gcloud eventarc triggers create TRIGGER_NAME  \
    --location=LOCATION \
    --destination-run-service=FUNCTION  \
    --destination-run-region=DESTINATION_RUN_REGION \
    --event-filters="type=EVENT_FILTER_TYPE" \
    --service-account=SERVICE_ACCOUNT_NAME@PROJECT_ID.

    Sostituisci quanto segue:

    • TRIGGER_NAME: l'ID del trigger 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.

      Per evitare problemi di prestazioni e residenza dei dati, la località deve corrispondere a quella del Google Cloud servizio che genera eventi. Per saperne di più, consulta Località Eventarc.

    • FUNCTION: il nome della funzione Cloud Run di cui è stato eseguito il deployment che riceve gli eventi per il trigger.
    • DESTINATION_RUN_REGION: (facoltativo) la posizione di Cloud Run in cui si trova la funzione Cloud Run di destinazione. Se non specificato, si presume che la funzione si trovi nella stessa regione del trigger.
    • EVENT_FILTER_TYPE: l'identificatore dell'evento. Viene generato un evento quando una chiamata API per il metodo ha esito positivo. 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, consulta Tipi di eventi Google supportati da Eventarc.
    • SERVICE_ACCOUNT_NAME: il nome del account di servizio gestito dall'utente.
    • PROJECT_ID: il tuo ID progetto Google Cloud .

    Note:

    • Una volta creato un trigger, non è possibile modificare il tipo di filtro eventi. Per un tipo di evento diverso, devi creare un nuovo trigger.
    • --event-filters=type=google.cloud.firestore.document.v1.written specifica che la funzione viene attivata quando un documento viene creato, aggiornato o eliminato, in base al tipo di evento.
    • --event-filters=database='(default)' specifica il database Firebase. Per il nome del database predefinito, utilizza (default).
    • --event-filters-path-pattern=document='users/{username}' fornisce il pattern del percorso dei documenti da monitorare per le modifiche pertinenti. Questo pattern di percorso indica che devono essere monitorati tutti i documenti della raccolta users. Per saperne di più, vedi Informazioni sui pattern di percorso.
    • (Facoltativo) Per specificare un singolo tentativo di invio di eventi senza ripetizioni, utilizza il flag --max-retry-attempts. L'unico valore valido è 1. Se ometti il flag, viene applicato il comportamento di ripetizione standard. Per saperne di più, vedi Nuovi tentativi per gli eventi.
    • Sono disponibili altri flag. Per saperne di più, vedi gcloud eventarc triggers create.

Terraform

Per creare un trigger Eventarc per una funzione Cloud Run, consulta Creare un trigger utilizzando Terraform.

Per saperne di più, consulta Estendere Firestore con trigger di eventi utilizzando Cloud Run Functions.

Passaggi successivi

  • Visualizza esempi di funzioni che vengono attivate quando apporti modifiche a un documento all'interno di una raccolta specifica.