Ampliar o Cloud Run com acionadores de eventos usando funções do Cloud Run
Com o Cloud Run functions, é possível implantar o código para processar eventos acionados por mudanças no banco de dados do Cloud Run. Isso permite adicionar funcionalidade do lado do servidor sem executar seus próprios servidores.
Este guia descreve como criar gatilhos para funções do Cloud Run com base em eventos do Firestore.
É possível acionar as funções do Cloud Run com eventos em um banco de dados do Firestore. Quando acionada, sua função lê e atualiza um banco de dados do Firestore em resposta a esses eventos usando as APIs do Firestore e as bibliotecas de cliente.
O processo de acionamento de uma função do Cloud Run por eventos do Firestore consiste nas seguintes etapas:
O serviço espera por mudanças em um documento específico.
Quando uma mudança ocorre, o serviço é acionado e realiza as tarefas dele.
O serviço recebe um objeto de dados com um snapshot do documento afetado. Para eventos
write
ouupdate
, o objeto de dados contém snapshots que representam o estado do documento antes e depois do evento de acionamento.
Antes de começar
- Verifique se você configurou um novo projeto para o Cloud Run conforme descrito na página de configuração.
Ative as APIs Artifact Registry, Cloud Build, Cloud Run Admin, Eventarc, Firestore Cloud Logging e Pub/Sub:
Funções exigidas
Você ou seu administrador precisa conceder a conta do implantador e a identidade do gatilho. Opcionalmente, conceda ao agente de serviço do Pub/Sub os seguintes papéis do IAM.
Papéis necessários para a conta do implantador
Para ter as permissões necessárias para acionar eventos do Firestore, peça ao administrador para conceder a você os seguintes papéis do IAM no projeto:
-
Editor do Cloud Build (
roles/cloudbuild.builds.editor
) -
Administrador do Cloud Run (
roles/run.admin
) -
Proprietário do Datastore (
roles/datastore.owner
) -
Administrador do Eventarc (
roles/eventarc.admin
) -
Acessador de exibição de registros (
roles/logging.viewAccessor
) -
Administrador de projetos do IAM (
roles/resourcemanager.projectIamAdmin
) -
Administrador da conta de serviço (
roles/iam.serviceAccountAdmin
) -
Usuário da conta de serviço (
roles/iam.serviceAccountUser
) -
Administrador do Service Usage (
roles/serviceusage.serviceUsageAdmin
)
Para mais informações sobre a concessão de papéis, consulte Gerenciar o acesso a projetos, pastas e organizações.
Também é possível conseguir as permissões necessárias por meio de papéis personalizados ou de outros papéis predefinidos.
Por padrão, as permissões do Cloud Build incluem permissões para upload e download de artefatos do Artifact Registry.
Papéis necessários para a identidade do gatilho
Anote as propriedades da conta de serviço padrão do Compute Engine, porque você vai anexá-la a um gatilho do Eventarc para representar a identidade do acionador para fins de teste. Essa conta de serviço é criada automaticamente depois de ativar ou usar um serviço do Google Cloud que usa o Compute Engine e com o seguinte formato de e-mail:
PROJECT_NUMBER-compute@developer.gserviceaccount.com
Substitua
PROJECT_NUMBER
pelo número do seu projeto Google Cloud. Encontre o número do projeto na página Boas-vindas do console do Google Cloud ou executando o seguinte comando:gcloud projects describe PROJECT_ID --format='value(projectNumber)'
Para ambientes de produção, é altamente recomendável criar uma nova conta de serviço, conceder a ela um ou mais papéis do IAM que contenham as permissões mínimas necessárias, bem como seguir o princípio de privilégio mínimo.
- Por padrão, os serviços do Cloud Run só podem ser chamados por proprietários do projeto, editores do projeto e administradores e invocadores do Cloud Run.
É possível controlar o acesso por serviço. No entanto, para fins de teste, conceda o
papel de chamador
do Cloud Run (
run.invoker
) no projeto Google Cloud à conta de serviço do Compute Engine. Isso concede o papel em todos os serviços e jobs do Cloud Run em um projeto.gcloud projects add-iam-policy-binding PROJECT_ID \ --member=serviceAccount:PROJECT_NUMBER-compute@developer.gserviceaccount.com \ --role=roles/run.invoker
Se você criar um gatilho para um serviço autenticado do Cloud Run sem conceder o papel de chamador do Cloud Run, o gatilho será criado com sucesso e estará ativo. No entanto, o acionador não funcionará conforme o esperado e uma mensagem semelhante à seguinte aparecerá nos registros:
The request was not authenticated. Either allow unauthenticated invocations or set the proper Authorization header.
- Conceda o
papel de receptor de eventos
do Eventarc (
roles/eventarc.eventReceiver
) no projeto à conta de serviço padrão do Compute Engine para que o gatilho do Eventarc possa receber eventos de provedores de eventos.gcloud projects add-iam-policy-binding PROJECT_ID \ --member=serviceAccount:PROJECT_NUMBER-compute@developer.gserviceaccount.com \ --role=roles/eventarc.eventReceiver
Papel opcional para o agente de serviço do Pub/Sub
- Se você ativou o agente de serviço do Cloud Pub/Sub até 8 de abril
de 2021, para oferecer compatibilidade com solicitações push autenticadas do Pub/Sub, conceda
o papel de Criador de token da conta de serviço (
roles/iam.serviceAccountTokenCreator
) ao agente de serviço. Caso contrário, esse papel é concedido por padrão:gcloud projects add-iam-policy-binding PROJECT_ID \ --member=serviceAccount:service-PROJECT_NUMBER@gcp-sa-pubsub.iam.gserviceaccount.com \ --role=roles/iam.serviceAccountTokenCreator
Configurar o banco de dados do Firestore
Antes de implantar o serviço, crie um banco de dados do Firestore:
Acesse a página do Firestore.
Selecione Criar um banco de dados do Firestore.
No campo Nomeie seu banco de dados, insira um ID do banco de dados, como
firestore-db
.Na seção Opções de configuração, a opção Nativa do Firestore é selecionada por padrão junto com as regras de segurança aplicáveis.
Em Tipo de local, selecione Região e escolha a região em que o banco de dados vai ficar. Essa opção é permanente.
Clique em Criar banco de dados.
O modelo de dados do Firestore consiste em coleções que contêm documentos. Cada documento contém um conjunto de pares de chave-valor.
Escrever uma função acionada pelo Firestore
Para gravar uma função que responda a eventos do Firestore, especifique o seguinte durante a implantação:
- um tipo de evento de acionamento
- um filtro de evento de acionamento para selecionar os documentos associados à função
- o código da função a ser executado
Tipos de evento
O Firestore oferece suporte aos eventos create
, update
, delete
e write
. O
evento write
engloba todas as modificações em um documento.
Tipo de evento | Gatilho |
---|---|
google.cloud.firestore.document.v1.created (padrão) |
Acionado quando um documento é gravado pela primeira vez. |
google.cloud.firestore.document.v1.updated |
Acionado quando um documento já existe e tem algum valor alterado. |
google.cloud.firestore.document.v1.deleted |
Acionado quando um documento com dados é excluído. |
google.cloud.firestore.document.v1.written |
Acionado quando um documento é criado, atualizado ou excluído. |
google.cloud.firestore.document.v1.created.withAuthContext |
Igual a created , mas adiciona informações de autenticação. |
google.cloud.firestore.document.v1.updated.withAuthContext |
Igual a updated , mas adiciona informações de autenticação. |
google.cloud.firestore.document.v1.deleted.withAuthContext |
Igual a deleted , mas adiciona informações de autenticação. |
google.cloud.firestore.document.v1.written.withAuthContext |
Igual a written , mas adiciona informações de autenticação. |
Os caracteres curingas são escritos em gatilhos usando chaves, por exemplo:
projects/YOUR_PROJECT_ID/databases/(default)/documents/collection/{document_wildcard}
Filtros de eventos de acionamento
Para acionar seu serviço, especifique um caminho de documento para detectar. O caminho do documento precisa estar no mesmo projeto Google Cloud que o serviço.
Confira a seguir alguns exemplos de caminhos de documentos válidos:
users/marie
: monitora um único documento,/users/marie
.users/{username}
: monitora todos os documentos do usuário. Caracteres curingas são usados para monitorar todos os documentos na coleção.users/{username}/addresses/home
: monitora o documento de endereço residencial de todos os usuários.users/{username}/addresses/{addressId}
: monitora todos os documentos de endereço.users/{user=**}
: monitora todos os documentos do usuário e quaisquer documentos em subcoleções em cada documento do usuário, como/users/userID/address/home
ou/users/userID/phone/work
.users/{username}/addresses
: caminho de endereço inválido. Refere-se à subcoleçãoaddresses
, não a um documento.
Caracteres curinga e parâmetros
Se você não souber o documento específico que quer monitorar, use um {wildcard}
em vez do ID do documento:
users/{username}
detecta alterações feitas em todos os documentos do usuário.
Neste exemplo, quando qualquer campo em qualquer documento em users
é alterado, ele corresponde a um caractere curinga chamado {username}
.
Se um documento em users
tiver subcoleções e um
campo em um dos documentos dessas subcoleções for alterado, o caractere curinga
{username}
não será acionado. Se o objetivo é responder a eventos em subcoleções também, use o caractere curinga de vários segmentos {username=**}
.
As correspondências de caractere curinga são extraídas dos caminhos do documento. Defina quantos caracteres curinga você quiser para substituir a coleção explícita ou os IDs dos documentos. É possível usar até um caractere curinga de vários segmentos, como {username=**}
.
Código da função
Consulte exemplos de como usar eventos do Firestore no modo nativo para acionar uma função do Cloud Run.
Inclua as dependências do proto na sua origem
Você precisa incluir o arquivo Cloud Run data.proto
no diretório de origem da função. Esse arquivo importa os seguintes
protos, que também precisam ser incluídos no diretório de origem:
Use a mesma estrutura de diretório para as dependências. Por exemplo, coloque
struct.proto
em google/protobuf
.
Esses arquivos são necessários para decodificar dados de eventos. Se a origem da função não incluir esses arquivos, ela vai retornar um erro quando for executada.
Atributos do evento
Cada evento inclui atributos de dados com informações sobre o evento, como o horário em que ele foi acionado. O Cloud Run adiciona outros dados sobre o banco de dados e o documento envolvidos no evento. Você pode acessar esses atributos da seguinte forma:
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']}")
Estruturas de eventos
Esse gatilho invoca seu serviço com um evento semelhante 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 } }
Cada objeto Document
contém um ou mais objetos Value
. Consulte a documentação Value
para referências de tipo.
Criar gatilhos para funções
Clique na guia para ver instruções usando a ferramenta de sua preferência.
Console
Ao usar o console do Google Cloud para criar uma função, você também pode adicionar um gatilho a ela. Siga estas etapas para criar um gatilho para sua função:
No Google Cloud console, acesse o Cloud Run:
Clique em Escrever uma função e insira os detalhes dela. Para mais informações sobre como configurar funções durante a implantação, consulte Implantar funções.
Na seção Gatilho, clique em Adicionar gatilho.
Selecione Gatilho do Firestore.
No painel Gatilho do Eventarc, modifique os detalhes do gatilho da seguinte maneira:
Insira um nome para o gatilho no campo Nome do gatilho ou use o nome padrão.
Selecione um Tipo de acionador na lista:
Fontes do Google para especificar acionadores para Pub/Sub, Cloud Storage, Firestore, e outros provedores de eventos do Google.
Terceiros para integração com provedores que não são do Google que oferecem uma origem do Eventarc. Para mais informações, consulte Eventos de terceiros no Eventarc.
Selecione Firestore na lista Provedor de eventos para escolher um produto que ofereça o tipo de evento para acionar sua função. Para ver a lista de provedores de eventos, consulte Provedores e destinos de eventos.
Selecione type=google.cloud.firestore.document.v1.created na lista Tipo de evento. A configuração do gatilho varia de acordo com o tipo de evento compatível: Para mais informações, consulte Tipos de eventos.
Na seção "Filtros", selecione um banco de dados, uma operação e valores de atributo ou use as seleções padrão.
Se o campo Região estiver ativado, selecione um local para o gatilho do Eventarc. Em geral, o local de um gatilho do Eventarc precisa corresponder ao local do recurso Google Cloud que você quer monitorar para eventos. Na maioria dos cenários, você também precisa implantar a função na mesma região. Consulte Noções básicas sobre locais do Eventarc para mais detalhes sobre locais de acionador do Eventarc.
No campo Conta de serviço, selecione uma conta de serviço. Os acionadores do Eventarc são vinculados a contas de serviço para usar como uma identidade ao invocar a função. A conta de serviço do acionador do Eventarc precisa ter permissão para invocar a função. Por padrão, o Cloud Run usa a conta de serviço padrão do Compute Engine.
Se quiser, especifique o caminho do URL do serviço para enviar a solicitação recebida. Esse é o caminho relativo no serviço de destino para o qual os eventos do gatilho precisam ser enviados. Por exemplo:
/
,/route
,route
eroute/subroute
.
Depois de preencher os campos obrigatórios, clique em Salvar gatilho.
gcloud
Ao criar uma função usando a CLI gcloud, primeiro é necessário implantar a função e, em seguida, criar um gatilho. Siga estas etapas para criar um gatilho para sua função:
Execute o seguinte comando no diretório que contém o código de amostra para implantar sua função:
gcloud run deploy FUNCTION \ --source . \ --function FUNCTION_ENTRYPOINT \ --base-image BASE_IMAGE_ID \ --region REGION
Substitua:
FUNCTION pelo nome da função que você está implantando. É possível omitir esse parâmetro inteiramente, mas será solicitado o nome, se você omiti-lo.
FUNCTION_ENTRYPOINT: o ponto de entrada da função no código-fonte. Esse é o código que o Cloud Run executa quando é executada. O valor dessa sinalização precisa ser um nome de função ou de classe totalmente qualificada no código-fonte.
BASE_IMAGE_ID com o ambiente de imagem base da sua função. Para mais detalhes sobre as imagens de base e os pacotes incluídos em cada imagem, consulte Imagens de base dos ambientes de execução.
REGION com a Google Cloud região em que você quer implantar a função. Por exemplo,
europe-west1
.
Execute o comando a seguir para criar um gatilho que filtra eventos:
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
Substitua:
TRIGGER_NAME pelo nome do gatilho.
EVENTARC_TRIGGER_LOCATION com o local do gatilho do Eventarc. Em geral, o local de um gatilho do Eventarc precisa corresponder ao local do recurso Google Cloud que você quer monitorar para eventos. Na maioria dos cenários, você também precisa implantar a função na mesma região. Para mais informações, consulte Locais do Eventarc.
FUNCTION pelo nome da função que você está implantando.
REGION pela região do Cloud Run da função.
PROJECT_NUMBER pelo número do projeto Google Cloud . Os acionadores do Eventarc são vinculados a contas de serviço para usar como uma identidade ao invocar a função. A conta de serviço do gatilho do Eventarc precisa ter permissão para invocar a função. Por padrão, o Cloud Run usa a conta de serviço de computação padrão.
Cada flag
event-filters
especifica um tipo de evento, e a função é acionada somente quando um evento atende a todos os critérios especificados nas flagsevent-filters
. Cada gatilho precisa ter uma flagevent-filters
especificando um tipo de evento compatível, como um novo documento gravado no Firestore ou um arquivo enviado para o Cloud Storage. Não é possível mudar o tipo de filtro de evento depois da criação. Para mudar o tipo de filtro de evento, crie um novo gatilho e exclua o antigo. Opcional: é possível repetir a flag--event-filters
com um filtro compatível no formatoATTRIBUTE=VALUE
para adicionar mais filtros.
Terraform
Para criar um gatilho do Eventarc para uma função do Cloud Run, consulte Criar um gatilho usando o Terraform.
Exemplos
Os exemplos a seguir descrevem como usar eventos do Firestore no modo nativo para acionar uma função do Cloud Run.
Exemplo 1: função Hello Firestore
A amostra a seguir imprime os campos de um evento de acionamento do Firestore:
Node.js
Python
Go
Java
C#
Implantar a função
Para implantar a função Hello Firestore
, execute o seguinte comando:
Se ainda não tiver feito isso, configure o banco de dados do Firestore.
Para implantar a função, consulte Criar gatilhos para funções.
Testar a função
Para testar a função Hello Firestore
, configure uma coleção chamada
users
no seu banco de dados do Firestore:
No console do Google Cloud , acesse a página de bancos de dados do Firestore:
Clique em Iniciar uma coleção.
Especifique
users
como o ID da coleção.Para começar a adicionar o primeiro documento da coleção, em Adicionar o primeiro documento, aceite o ID do documento gerado automaticamente.
Adicione pelo menos um campo para o documento, especificando um nome e um valor. Por exemplo, em Nome do campo, insira
username
e, em Valor do campo, insirarowan
.Quando terminar, clique em Save.
Esta ação cria um novo documento, acionando sua função.
Para confirmar que sua função foi acionada, clique no nome vinculado da função na página Visão geral do Cloud Run no console Google Cloud para abrir a página Detalhes do serviço.
Selecione a guia Registros e procure esta string:
Function triggered by change to: //firestore.googleapis.com/projects/your-project-id/databases/(default)'
Exemplo 2: converter para a função "Maiúsculas"
O exemplo abaixo recupera o valor adicionado pelo usuário, converte a string nesse local para letras maiúsculas e substitui o valor pela string de caracteres maiúsculos:
Node.js
Use protobufjs para decodificar os dados do evento. Inclua google.events.cloud.firestore.v1
data.proto
na sua origem.
Python
Go
Java
C#
Implantar a função
Para implantar a função Convert to Uppercase
, execute o seguinte comando:
Se ainda não tiver feito isso, configure o banco de dados do Firestore.
Para implantar a função, consulte Criar gatilhos para funções.
Testar a função
Para testar a função Convert to Uppercase
que você acabou de implantar, configure
uma coleção chamada messages
no seu
banco de dados do Firestore:
No console do Google Cloud , acesse a página de bancos de dados do Firestore:
Clique em Iniciar uma coleção.
Especifique
messages
como o ID da coleção.Para começar a adicionar o primeiro documento da coleção, em Adicionar o primeiro documento, aceite o ID do documento gerado automaticamente.
Para acionar a função implantada, adicione um documento em que o Nome do campo seja
original
e o Valor do campo sejaminka
.Ao salvar o documento, você verá a palavra em letras minúsculas no campo de valor ser convertida em maiúsculas.
Se você editar posteriormente o valor do campo para conter letras minúsculas, isso acionará a função novamente, convertendo todas as letras minúsculas para maiúsculas.
Limitações para funções
- Não garantimos acionamentos em ordem. Alterações rápidas podem acionar invocações de função em uma ordem inesperada.
- Os eventos são entregues pelo menos uma vez, mas um único evento pode resultar em invocações de várias funções. Evite depender de mecanismos do tipo "apenas uma vez" e escreva funções idempotentes.
- Um gatilho está associado a um único banco de dados. Não é possível criar um gatilho que corresponda a vários bancos de dados.
- A exclusão de um banco de dados não remove automaticamente nenhum gatilho dele. O acionador deixa de entregar eventos, mas continua existindo até que você o exclua.