Estendere Cloud Run con trigger di eventi utilizzando Cloud Run Functions
Con le funzioni Cloud Run, puoi eseguire il deployment del codice per gestire gli eventi attivati dalle modifiche al database Cloud Run. In questo modo puoi aggiungere funzionalità lato server senza eseguire i tuoi server.
Questa guida descrive come creare trigger per le funzioni Cloud Run a partire dagli eventi Firestore.
Puoi attivare le funzioni Cloud Run da eventi in un database Firestore. Quando viene attivata, la funzione legge e aggiorna un database Firestore in risposta a questi eventi tramite le API e le librerie client di Firestore.
Il processo di attivazione di una funzione Cloud Run da parte degli eventi Firestore prevede i seguenti passaggi:
Il servizio attende le modifiche a un determinato documento.
Quando si verifica una modifica, il servizio viene attivato ed esegue le sue attività.
Il servizio riceve un oggetto dati con uno snapshot del documento interessato. Per gli eventi
write
oupdate
, l'oggetto dati contiene istantanee che rappresentano lo stato del documento prima e dopo l'evento di attivazione.
Prima di iniziare
- Assicurati di aver configurato un nuovo progetto per Cloud Run come descritto nella pagina di configurazione.
Abilita le API Artifact Registry, Cloud Build, Cloud Run Admin, Eventarc, Firestore Cloud Logging e Pub/Sub:
Ruoli obbligatori
Tu o il tuo amministratore dovete concedere l'account di deployment e l'identità del trigger. Se vuoi, concedi all'agente di servizio Pub/Sub i seguenti ruoli IAM.
Ruoli richiesti per l'account del deployer
Per ottenere le autorizzazioni necessarie per attivare eventi Firestore, chiedi all'amministratore di concederti i seguenti ruoli IAM nel progetto:
-
Editor Cloud Build (
roles/cloudbuild.builds.editor
) -
Cloud Run Admin (
roles/run.admin
) -
Proprietario datastore (
roles/datastore.owner
) -
Amministratore Eventarc (
roles/eventarc.admin
) -
Logs View Accessor (
roles/logging.viewAccessor
) -
Amministratore IAM progetto (
roles/resourcemanager.projectIamAdmin
) -
Amministratore account di servizio (
roles/iam.serviceAccountAdmin
) -
Utente service account (
roles/iam.serviceAccountUser
) -
Amministratore utilizzo servizi (
roles/serviceusage.serviceUsageAdmin
)
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.
Ruoli obbligatori per l'identità del trigger
Prendi nota dell'Account di servizio predefinito di Compute Engine, in quanto lo collegherai a un trigger Eventarc per rappresentare l'identità del trigger a scopo di test. Questo account di servizio viene creato automaticamente dopo l'attivazione o l'utilizzo di un servizio Google Cloud che utilizza Compute Engine e con il seguente formato email:
PROJECT_NUMBER-compute@developer.gserviceaccount.com
Sostituisci
PROJECT_NUMBER
con il numero del tuo progetto Google Cloud. Puoi trovare il numero di progetto nella pagina Benvenuto della console Google Cloud o eseguendo questo comando:gcloud projects describe PROJECT_ID --format='value(projectNumber)'
Per gli ambienti di produzione, ti consigliamo vivamente di creare un nuovo service account e di concedergli uno o più ruoli IAM che contengano le autorizzazioni minime richieste e di seguire il principio del privilegio minimo.
- Per impostazione predefinita, i servizi Cloud Run possono essere chiamati solo da proprietari del progetto, editor del progetto e amministratori e chiamanti di Cloud Run.
Puoi
controllare
l'accesso in base al servizio; tuttavia, a scopo di test, concedi il
ruolo Invoker di Cloud Run (
run.invoker
) nel progetto Google Cloud all'account di servizio Compute Engine. Questo ruolo viene concesso per tutti i servizi e i job Cloud Run in un progetto.gcloud projects add-iam-policy-binding PROJECT_ID \ --member=serviceAccount:PROJECT_NUMBER-compute@developer.gserviceaccount.com \ --role=roles/run.invoker
Tieni presente che se crei un trigger per un servizio Cloud Run autenticato senza concedere il ruolo Invoker di Cloud Run, il trigger viene creato correttamente ed è attivo. Tuttavia, il trigger non funzionerà come previsto e nei log verrà visualizzato un messaggio simile al seguente:
The request was not authenticated. Either allow unauthenticated invocations or set the proper Authorization header.
- Concedi il
ruolo Destinatario di eventi
Eventarc (
roles/eventarc.eventReceiver
) nel progetto al account di servizio predefinito di Compute Engine in modo che il trigger Eventarc possa ricevere eventi dai provider di eventi.gcloud projects add-iam-policy-binding PROJECT_ID \ --member=serviceAccount:PROJECT_NUMBER-compute@developer.gserviceaccount.com \ --role=roles/eventarc.eventReceiver
Ruolo facoltativo per l'agente di servizio Pub/Sub
- Se hai attivato l'agente di servizio Cloud Pub/Sub l'8 aprile 2021 o in una data precedente, per supportare le richieste push Pub/Sub autenticate, concedi
il ruolo Creatore token account di servizio (
roles/iam.serviceAccountTokenCreator
) all'agente di servizio. In caso contrario, questo ruolo viene concesso per impostazione predefinita:gcloud projects add-iam-policy-binding PROJECT_ID \ --member=serviceAccount:service-PROJECT_NUMBER@gcp-sa-pubsub.iam.gserviceaccount.com \ --role=roles/iam.serviceAccountTokenCreator
Configura il database Firestore
Prima di eseguire il deployment del servizio, devi creare un database Firestore:
Vai alla pagina Firestore.
Seleziona Crea un database Firestore.
Nel campo Assegna un nome al database, inserisci un ID database, ad esempio
firestore-db
.Nella sezione Opzioni di configurazione, Firestore nativo è selezionato per impostazione predefinita insieme alle regole di sicurezza applicabili.
In Tipo di località, seleziona Regione e scegli la regione in cui deve risiedere il tuo database. Questa scelta è definitiva.
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.
Scrivere una funzione attivata da Firestore
Per scrivere una funzione che risponde agli eventi Firestore, preparati a specificare quanto segue durante il deployment:
- un tipo di evento di trigger
- un filtro per l'evento trigger per selezionare i documenti associati alla funzione
- il codice della funzione da eseguire
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 |
Attivato quando un documento esiste già e un valore è stato modificato. |
google.cloud.firestore.document.v1.deleted |
Attivato quando viene eliminato un documento con dati. |
google.cloud.firestore.document.v1.written |
Attivato quando un documento viene creato, aggiornato o eliminato. |
google.cloud.firestore.document.v1.created.withAuthContext |
Come created , ma aggiunge le informazioni di autenticazione. |
google.cloud.firestore.document.v1.updated.withAuthContext |
Come updated , ma aggiunge le informazioni di autenticazione. |
google.cloud.firestore.document.v1.deleted.withAuthContext |
Come deleted , ma aggiunge le informazioni di autenticazione. |
google.cloud.firestore.document.v1.written.withAuthContext |
Come written , ma aggiunge le informazioni di autenticazione. |
I caratteri jolly vengono scritti nei trigger utilizzando le parentesi graffe, ad esempio:
projects/YOUR_PROJECT_ID/databases/(default)/documents/collection/{document_wildcard}
Filtri degli eventi di trigger
Per attivare il servizio, specifica un percorso del documento da monitorare. Il percorso del documento deve trovarsi nello stesso progetto Google Cloud del servizio.
Ecco alcuni esempi di percorsi di documenti validi:
users/marie
: Monitora un singolo documento,/users/marie
.users/{username}
: Monitora tutti i documenti dell'utente. I caratteri jolly vengono utilizzati per monitorare tutti i documenti della raccolta.users/{username}/addresses/home
: monitora il documento dell'indirizzo di casa per tutti gli utenti.users/{username}/addresses/{addressId}
: monitora tutti i documenti di indirizzo.users/{user=**}
: monitora tutti i documenti utente e tutti i documenti nelle sottoraccolte di ogni documento utente, ad esempio/users/userID/address/home
o/users/userID/phone/work
.users/{username}/addresses
: percorso dell'indirizzo non valido. Si riferisce alla raccolta secondariaaddresses
, non a un documento.
Caratteri jolly e parametri
Se non conosci il documento specifico che vuoi monitorare, utilizza un {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 di 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=**}
.
Codice funzione
Consulta gli esempi su come utilizzare gli eventi della modalità nativa di Firestore per attivare una funzione Cloud Run.
Includi le dipendenze proto nella sorgente
Devi includere il file Cloud Run data.proto
nella directory di origine della funzione. Questo file importa i seguenti
proto che devi includere anche nella directory di origine:
Utilizza la stessa struttura di directory per le dipendenze. Ad esempio, inserisci
struct.proto
all'interno di google/protobuf
.
Questi file sono necessari per decodificare i dati degli eventi. Se l'origine della funzione non include questi file, restituisce un errore durante l'esecuzione.
Attributi evento
Ogni evento include attributi dei dati che includono informazioni sull'evento, ad esempio l'ora in cui è stato attivato. Cloud Run aggiunge altri dati sul database e sul documento coinvolti nell'evento. Puoi accedere a questi attributi nel seguente modo:
Java
logger.info("Function triggered by event on: " + event.getSource()); logger.info("Event type: " + event.getType()); logger.info("Event time " + event.getTime()); logger.info("Event project: " + event.getExtension("project")); logger.info("Event location: " + event.getExtension("location")); logger.info("Database name: " + event.getExtension("database")); logger.info("Database document: " + event.getExtension("document")); // For withAuthContext events logger.info("Auth information: " + event.getExtension("authid")); logger.info("Auth information: " + event.getExtension("authtype"));
Node.js
console.log(`Function triggered by event on: ${cloudEvent.source}`); console.log(`Event type: ${cloudEvent.type}`); console.log(`Event time: ${cloudEvent.time}`); console.log(`Event project: ${cloudEvent.project}`); console.log(`Event location: ${cloudEvent.location}`); console.log(`Database name: ${cloudEvent.database}`); console.log(`Document name: ${cloudEvent.document}`); // For withAuthContext events console.log(`Auth information: ${cloudEvent.authid}`); console.log(`Auth information: ${cloudEvent.authtype}`);
Python
print(f"Function triggered by change to: {cloud_event['source']}") print(f"Event type: {cloud_event['type']}") print(f"Event time: {cloud_event['time']}") print(f"Event project: {cloud_event['project']}") print(f"Location: {cloud_event['location']}") print(f"Database name: {cloud_event['database']}") print(f"Document: {cloud_event['document']}") // For withAuthContext events print(f"Auth information: {cloud_event['authid']}") print(f"Auth information: {cloud_event['authtype']}")
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
.
Creare trigger per le funzioni
Fai clic sulla scheda relativa alle istruzioni per l'utilizzo dello strumento che preferisci.
Console
Quando utilizzi la console Google Cloud per creare una funzione, puoi anche aggiungere un trigger alla funzione. Per creare un trigger per la tua funzione:
Nella console Google Cloud , vai a Cloud Run:
Fai clic su Scrivi una funzione e inserisci i dettagli della funzione. Per saperne di più sulla configurazione delle funzioni durante il deployment, consulta Eseguire il deployment delle funzioni.
Nella sezione Attivatore, fai clic su Aggiungi attivatore.
Seleziona Trigger di Firestore.
Nel riquadro Trigger Eventarc, modifica i dettagli del trigger come segue:
Inserisci un nome per il trigger nel campo Nome trigger o utilizza il nome predefinito.
Seleziona un tipo di trigger dall'elenco:
Origini Google per specificare i trigger per Pub/Sub, Cloud Storage, Firestore e altri fornitori 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.
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, consulta Provider e destinazioni di eventi.
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ù, vedi Tipi di eventi.
Nella sezione Filtri, seleziona un database, un'operazione e i valori degli attributi oppure utilizza le selezioni predefinite.
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 risorsa che vuoi monitorare per gli eventi. Google Cloud Nella maggior parte degli scenari, devi anche eseguire il deployment della funzione nella stessa regione. Consulta la sezione Informazioni sulle località Eventarc per ulteriori dettagli sulle località dei trigger Eventarc.
Nel campo Service account, seleziona un account di servizio. I trigger Eventarc sono collegati agli account di servizio 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.
(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
eroute/subroute
.
Una volta compilati i campi obbligatori, fai clic su Salva attivatore.
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:
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:
FUNCTION con il nome della funzione che stai eseguendo il deployment. Puoi omettere completamente questo parametro, ma ti verrà chiesto il nome se lo ometti.
FUNCTION_ENTRYPOINT con l'entry point della tua funzione nel codice sorgente. Questo è il codice eseguito da Cloud Run quando viene eseguita la funzione. Il valore di questo flag deve essere un nome di funzione o un nome di classe completo che esiste nel codice sorgente.
BASE_IMAGE_ID con l'ambiente dell'immagine di base per la tua funzione. Per maggiori dettagli sulle immagini di base e sui pacchetti inclusi in ciascuna immagine, consulta Immagini di base dei runtime.
REGION con la Google Cloud regione in cui vuoi eseguire il deployment della funzione. Ad esempio:
europe-west1
.
Esegui questo comando per creare un trigger che filtri gli eventi:
gcloud eventarc triggers create TRIGGER_NAME \ --location=EVENTARC_TRIGGER_LOCATION \ --destination-run-service=FUNCTION \ --destination-run-region=REGION \ --event-filters="type=google.cloud.firestore.document.v1.created" \ --service-account=PROJECT_NUMBER-compute@developer.gserviceaccount.com
Sostituisci:
TRIGGER_NAME con il nome dell'attivatore.
EVENTARC_TRIGGER_LOCATION con la località del trigger Eventarc. In generale, la località di un trigger Eventarc deve corrispondere a quella della risorsa Google Cloud che vuoi monitorare per gli eventi. Nella maggior parte degli scenari, devi anche eseguire il deployment della funzione nella stessa regione. Per saperne di più, consulta Località Eventarc.
FUNCTION con il nome della funzione che stai eseguendo il deployment.
REGION con la regione di Cloud Run della funzione.
PROJECT_NUMBER con il numero del tuo progetto Google Cloud . I trigger Eventarc sono collegati agli account di servizio 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 Compute predefinito.
Ogni flag
event-filters
specifica un tipo di evento, con la funzione che si attiva solo quando un evento soddisfa tutti i criteri specificati nei relativi flagevent-filters
. Ogni trigger deve avere un flagevent-filters
che specifica un tipo di evento supportato, ad esempio un nuovo documento scritto in Firestore o un file caricato in Cloud Storage. Non puoi modificare il tipo di filtro eventi dopo la creazione. Per modificare il tipo di filtro degli eventi, devi creare un nuovo attivatore ed eliminare quello precedente. Se vuoi, puoi ripetere il flag--event-filters
con un filtro supportato nel formatoATTRIBUTE=VALUE
per aggiungere altri filtri.
Terraform
Per creare un trigger Eventarc per una funzione Cloud Run, consulta Creare un trigger utilizzando Terraform.
Esempi
I seguenti esempi descrivono come utilizzare gli eventi di Firestore in modalità Native per attivare una funzione Cloud Run.
Esempio 1: funzione Hello Firestore
Il seguente esempio stampa i campi di un evento Firestore di attivazione:
Node.js
Python
Go
Java
C#
esegui il deployment della funzione
Per eseguire il deployment della funzione Hello Firestore
, esegui questo comando:
Se non l'hai ancora fatto, configura il tuo database Firestore.
Per eseguire il deployment della funzione, vedi Creare trigger per le funzioni.
Testa la funzione
Per testare la funzione Hello Firestore
, configura una raccolta denominata
users
nel tuo database Firestore:
Nella console Google Cloud , vai alla pagina dei database Firestore:
Fai clic su Avvia una raccolta.
Specifica
users
come ID raccolta.Per iniziare ad aggiungere il primo documento della raccolta, accetta l'ID documento generato automaticamente in Aggiungi il primo documento.
Aggiungi almeno un campo per il documento, specificando un nome e un valore. Ad esempio, in Nome campo, inserisci
username
e in Valore campo, inseriscirowan
.Quando hai terminato, fai clic su Salva.
Questa azione crea un nuovo documento, attivando così la funzione.
Per verificare che la funzione sia stata attivata, fai clic sul nome collegato della funzione nella console Google Cloud pagina Panoramica di Cloud Run per aprire la pagina Dettagli servizio.
Seleziona la scheda Log e cerca questa stringa:
Function triggered by change to: //firestore.googleapis.com/projects/your-project-id/databases/(default)'
Esempio 2: funzione Converti in maiuscolo
L'esempio seguente recupera il valore aggiunto dall'utente, converte la stringa in quella posizione in maiuscolo e sostituisce il valore con la stringa in maiuscolo:
Node.js
Utilizza protobufjs per decodificare i dati
dell'evento. Includi google.events.cloud.firestore.v1
data.proto
nella fonte.
Python
Go
Java
C#
esegui il deployment della funzione
Per eseguire il deployment della funzione Convert to Uppercase
, esegui questo comando:
Se non l'hai ancora fatto, configura il tuo database Firestore.
Per eseguire il deployment della funzione, vedi Creare trigger per le funzioni.
Testa la funzione
Per testare la funzione Convert to Uppercase
di cui hai appena eseguito il deployment, configura
una raccolta denominata messages
nel tuo
database Firestore:
Nella console Google Cloud , vai alla pagina dei database Firestore:
Fai clic su Avvia una raccolta.
Specifica
messages
come ID raccolta.Per iniziare ad aggiungere il primo documento della raccolta, accetta l'ID documento generato automaticamente in Aggiungi il primo documento.
Per attivare la funzione di cui è stato eseguito il deployment, aggiungi un documento in cui il Nome campo è
original
e il Valore campo èminka
.Quando salvi il documento, puoi vedere la parola in minuscolo nel campo valore convertita in maiuscolo.
Se in seguito modifichi il valore del campo in modo che contenga lettere minuscole, la funzione viene attivata di nuovo e converte tutte le lettere minuscole in maiuscole.
Limitazioni per le funzioni
- L'ordinamento non è garantito. Le modifiche rapide possono attivare le chiamate di funzione in un ordine imprevisto.
- Gli eventi vengono inviati almeno una volta, ma un singolo evento potrebbe comportare più chiamate di funzioni. Evita di fare affidamento sulla meccanica di esecuzione esattamente una volta e scrivi funzioni idempotenti.
- Un trigger è associato a un singolo database. Non puoi creare un trigger che corrisponda a più database.
- L'eliminazione di un database non comporta l'eliminazione automatica di eventuali trigger per quel database. Il trigger smette di generare eventi, ma continua a esistere finché non lo elimini.