Aguardar eventos usando callbacks e gatilhos do Eventarc

Seu fluxo de trabalho pode precisar aguardar um processo externo. É possível usar callbacks HTTP para aguardar que outro serviço faça uma solicitação a um endpoint de callback. Essa solicitação retoma a execução do fluxo de trabalho. Também é possível aguardar usando pesquisas.

Em vez de usar a pesquisa, este tutorial demonstra como esperar eventos ou mensagens do Pub/Sub usando callbacks HTTP e gatilhos do Eventarc. Embora seja possível acionar um fluxo de trabalho com eventos ou mensagens do Pub/Sub, talvez seja necessário interromper essa execução para aguardar outro evento antes de continuar. Por exemplo, um evento aciona um fluxo de trabalho para iniciar um processo, mas o fluxo de trabalho precisa aguardar outro evento que sinalize que o processo foi concluído. Para implementar isso, faça com que um fluxo de trabalho chame outro.

Objetivos

Neste tutorial, acontece o seguinte:

  1. Um fluxo de trabalho principal que precisa aguardar eventos é implantado e executado. Como ele precisa esperar que os eventos ocorram, armazena os detalhes do callback em um banco de dados do Firestore para que o fluxo de trabalho secundário possa recuperar os detalhes. O fluxo de trabalho principal aguarda as chamadas HTTP.

  2. Um fluxo de trabalho secundário é acionado pelos eventos e recupera os detalhes de callback do banco de dados do Firestore quando os eventos são gerados. Em seguida, o fluxo de trabalho secundário faz uma chamada de retorno ao fluxo de trabalho principal, que retoma a execução.

Confira uma visão geral de todo o processo:

Aguardar eventos usando callbacks e um fluxo de trabalho principal e secundário

Fluxo de trabalho principal:

  1. Um fluxo de trabalho callback-event-sample cria endpoints de callback para duas origens de eventos: um tópico do Pub/Sub e um bucket do Cloud Storage.
  2. Esse fluxo de trabalho armazena os dois endpoints de callback em um documento do Firestore.
  3. Esse fluxo de trabalho interrompe a execução e aguarda a chegada de solicitações HTTP aos endpoints de callback.

Eventos:

  1. Os eventos ocorrem quando uma mensagem é publicada em um tópico do Pub/Sub e um arquivo é enviado para um bucket do Cloud Storage.

Fluxo de trabalho secundário:

  1. O Eventarc encaminha os eventos para o fluxo de trabalho callback-event-listener e aciona a execução dele.
  2. Esse fluxo de trabalho recupera os URLs de endpoint de callback adequados do documento do Firestore.
  3. Esse fluxo de trabalho executa os callbacks nos endpoints adequados no fluxo de trabalho de exemplo.

Fluxo de trabalho principal:

  1. O fluxo de trabalho callback-event-sample recebe os eventos nos endpoints de callback e retoma a execução.
  2. Esse fluxo de trabalho exclui os URLs de callback do documento do Firestore e conclui a execução.

Custos

Neste documento, você vai usar os seguintes componentes faturáveis do Google Cloud:

Para gerar uma estimativa de custo baseada na projeção de uso deste tutorial, use a calculadora de preços.

Novos usuários do Google Cloud podem estar qualificados para uma avaliação gratuita.

Antes de começar

É possível executar os comandos a seguir no console Google Cloud ou usando a Google Cloud CLI no terminal ou no Cloud Shell.

As restrições de segurança definidas pela sua organização podem impedir que você conclua as etapas a seguir. Para informações sobre solução de problemas, consulte Desenvolver aplicativos em um ambiente restrito de Google Cloud .

Console

  1. No console do Google Cloud , na página do seletor de projetos, selecione ou crie um Google Cloud projeto.

    Acessar o seletor de projetos

  2. Verifique se o faturamento foi ativado para o projeto Google Cloud . Saiba como verificar se o faturamento está ativado em um projeto.

  3. Ative as APIs App Engine, Eventarc, Firestore, Pub/Sub e Workflows.

    Ative as APIs

  4. Crie uma conta de serviço para que seu fluxo de trabalho use na autenticação com outros serviços do Google Cloud e conceda as funções adequadas:

    1. No console Google Cloud , acesse a página Contas de serviço.

      Acessar a página "Contas de serviço"

    2. Para acessar a página Criar conta de serviço, selecione seu projeto.

    3. No campo Nome da conta de serviço, insira um nome. O Google Cloud console preenche o campo ID da conta de serviço com base nesse nome.

      No campo Descrição da conta de serviço, insira uma descrição. Por exemplo, Service account for tutorial.

    4. Clique em Criar e continuar.

    5. Na lista Selecionar um papel, filtre os seguintes papéis para conceder à conta de serviço gerenciado pelo usuário criada na etapa anterior:

      • Usuário do Cloud Datastore: para acessar dados do Firestore no modo Datastore.
      • Receptor de eventos do Eventarc: para receber eventos de provedores de eventos.
      • Gravador de registros: para gravar registros.
      • Chamador do Workflows: para executar fluxos de trabalho e gerenciar as execuções.

      Para papéis adicionais, clique em Adicionar outro papel e adicione cada papel adicional.

    6. Clique em Continuar.

    7. Para concluir a criação da conta, clique em Concluído.

  5. Para criar um gatilho do Eventarc que encaminha eventos do Cloud Storage, conceda o papel Publicador do Pub/Sub ao agente de serviço do Cloud Storage. Normalmente, é o agente service-PROJECT_NUMBER@gs-project-accounts.iam.gserviceaccount.com. É possível recuperar o endereço de e-mail do agente de serviço do Cloud Storage.

    1. No console Google Cloud , acesse a página IAM.

      Acessar IAM

    2. Na linha do agente de serviço do Cloud Storage, clique em Editar principal. Se o agente de serviço não estiver listado, prossiga para a próxima etapa. O painel Editar acesso será aberto.

      1. Clique em Adicionar outro papel e pesquise o papel publisher do Pub/Sub.
      2. Selecione o papel.
      3. Clique em Salvar.

    3. Se o agente de serviço não estiver listado, clique em Conceder acesso. O painel Conceder acesso será aberto.

      1. No campo Novos principais, insira o endereço de e-mail do agente de serviço.
      2. Na lista Selecionar um papel, procure o papel publisher do Pub/Sub.
      3. Selecione o papel.
      4. Clique em Salvar.

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. Verifique se o faturamento foi ativado para o projeto Google Cloud . Saiba como verificar se o faturamento está ativado em um projeto.

  3. Ative as APIs App Engine, Eventarc, Firestore, Pub/Sub e Workflows.

    gcloud services enable \
    appengine.googleapis.com \
    eventarc.googleapis.com \
    firestore.googleapis.com \
    pubsub.googleapis.com \
    workflows.googleapis.com

  4. Crie uma conta de serviço para que seu fluxo de trabalho use na autenticação com outros serviços do Google Cloud e conceda as funções adequadas.

    1. Crie a conta de serviço:

      gcloud iam service-accounts create SERVICE_ACCOUNT_NAME

      Substitua SERVICE_ACCOUNT_NAME por um nome para a conta de serviço.

    2. Conceda papéis à conta de serviço gerenciado pelo usuário criada na etapa anterior. Execute uma vez o seguinte comando para cada um dos seguintes papéis do IAM:

      • roles/datastore.user: para acessar dados do Firestore no modo Datastore (Datastore).
      • roles/eventarc.eventReceiver: para receber eventos de provedores de eventos.
      • roles/logging.logWriter: para gravar registros.
      • roles/workflows.invoker: para executar fluxos de trabalho e gerenciar as execuções.
      gcloud projects add-iam-policy-binding PROJECT_ID \
    --member=serviceAccount:SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com \
    --role=ROLE

      Substitua:

      • PROJECT_ID: o ID do projeto em que você criou a conta de serviço
      • ROLE: o papel a ser concedido

  5. Para criar um gatilho do Eventarc que encaminha eventos do Cloud Storage, conceda o papel de Publicador do Pub/Sub ao agente de serviço do Cloud Storage. Normalmente, isso é service-PROJECT_NUMBER@gs-project-accounts.iam.gserviceaccount.com. Use gcloud storage service-agent para recuperar primeiro o agente de serviço do Cloud Storage.

    SERVICE_ACCOUNT_STORAGE="$(gcloud storage service-agent --project=PROJECT_ID)"

gcloud projects add-iam-policy-binding PROJECT_ID \
    --member=serviceAccount:$SERVICE_ACCOUNT_STORAGE \
    --role=roles/pubsub.publisher

Crie um banco de dados Firestore

O Firestore armazena seus dados em documentos que contêm campos mapeados para valores. Esses documentos são armazenados em coleções, que são contêineres de documentos que você pode usar para organizar dados e criar consultas. Saiba mais sobre o Firestore.

Cada projeto do Google Cloud é limitado a um banco de dados do Firestore. Siga estas etapas se precisar criar um banco de dados.

Console

  1. No console Google Cloud , acesse a página Começar do Firestore.

    Acessar "Começar"

  2. Clique em Selecionar modo nativo.

    Para orientações sobre como selecionar um modo de banco de dados e uma comparação recurso por recurso, consulte Como escolher entre o modo nativo e o modo Datastore.

  3. Na lista Selecionar um local, escolha nam5 (Estados Unidos).

    O local se aplica ao banco de dados do Firestore e ao aplicativo do App Engine no projeto Google Cloud . Depois de criar o banco de dados, não é possível mudar o local.

  4. Clique em Criar banco de dados.

gcloud

Para criar um banco de dados do Firestore, primeiro crie um aplicativo do App Engine e execute o comando gcloud firestore databases create:

gcloud app create --region=us-central
gcloud firestore databases create --region=us-central

Você pode ignorar o aviso us-central is not a valid Firestore location. O App Engine e o Firestore são compatíveis com os mesmos locais, mas a região us-central (Iowa) do App Engine é mapeada para a multirregião nam5 (Estados Unidos) do Firestore.

Criar um tópico do Pub/Sub

Este tutorial usa o Pub/Sub como uma origem de eventos. Crie um tópico do Pub/Sub para publicar uma mensagem nele. Saiba mais sobre como criar e gerenciar tópicos.

Console

  1. No console Google Cloud , acesse a página Tópicos do Pub/Sub.

    Acesse Tópicos

  2. Clique em Criar tópico.

  3. No campo ID do tópico, insira topic-callback.

  4. Aceite os outros padrões.

  5. Selecione Criar tópico.

gcloud

Para criar um tópico, execute o comando gcloud pubsub topics create:

gcloud pubsub topics create topic-callback

Criar um bucket do Cloud Storage

Este tutorial usa o Cloud Storage como origem de eventos. Crie um bucket do Cloud Storage para fazer upload de um arquivo. Saiba mais sobre como criar buckets de armazenamento.

Console

  1. No console Google Cloud , acesse a página Buckets do Cloud Storage.

    Acesse o Cloud Storage

  2. Clique em Criar.

  3. Em Nome do bucket, insira PROJECT_ID-bucket-callback.

    O ID do projeto é usado no fluxo de trabalho callback-event-sample para identificar o bucket.

  4. Clique em Continuar.

  5. Em Tipo de local, selecione Região e, em seguida, us-central1 (Iowa).

  6. Aceite os outros padrões.

  7. Clique em Criar.

gcloud

Para criar um bucket, execute o comando gcloud storage buckets create:

gcloud storage buckets create gs://PROJECT_ID-bucket-callback \
    --location=us-central1

O ID do projeto é usado no fluxo de trabalho callback-event-sample para identificar o bucket.

Depois que as origens de eventos forem criadas, você poderá implantar o fluxo de trabalho do receptor de eventos.

Implantar um fluxo de trabalho que detecta eventos

O fluxo de trabalho callback-event-listener é acionado quando uma mensagem é publicada em um tópico do Pub/Sub ou quando um arquivo é enviado para um bucket do Cloud Storage. O fluxo de trabalho recebe o evento, recupera os detalhes de callback adequados do banco de dados do Firestore e envia uma solicitação HTTP ao endpoint de callback.

Console

  1. No console Google Cloud , acesse a página Fluxos de trabalho:

    Acessar fluxos de trabalho

  2. Clique em Criar.

  3. Insira um nome para o novo fluxo de trabalho: callback-event-listener.

  4. Na lista Região, selecione us-central1.

  5. Selecione a conta de serviço que você criou.

  6. Clique em Próxima.

  7. No editor de fluxo de trabalho, insira a seguinte definição:

    main:
  params: [event]
  steps:
    - log_event:
        call: sys.log
        args:
          text: ${event}
          severity: INFO
    - init:
        assign:
          - database_root: ${"projects/" + sys.get_env("GOOGLE_CLOUD_PROJECT_ID") + "/databases/(default)/documents/callbacks/"}
          - event_source_tokens: ${text.split(event.source, "/")}
          - event_source_len: ${len(event_source_tokens)}
          - event_source: ${event_source_tokens[event_source_len - 1]}
          - doc_name: ${database_root + event_source}
    - get_document_for_event_source:
        try:
          call: googleapis.firestore.v1.projects.databases.documents.get
          args:
            name: ${doc_name}
          result: document
        except:
            as: e
            steps:
                - known_errors:
                    switch:
                    - condition: ${e.code == 404}
                      return: ${"No callbacks for event source " + event_source}
                - unhandled_exception:
                    raise: ${e}
    - process_callback_urls:
        steps:
          - check_fields_exist:
              switch:
              - condition: ${not("fields" in document)}
                return: ${"No callbacks for event source " + event_source}
              - condition: true
                next: processFields
          - processFields:
              for:
                  value: key
                  in: ${keys(document.fields)}
                  steps:
                      - extract_callback_url:
                          assign:
                              - callback_url: ${document.fields[key]["stringValue"]}
                      - log_callback_url:
                          call: sys.log
                          args:
                            text: ${"Calling back url " + callback_url}
                            severity: INFO
                      - http_post:
                          call: http.post
                          args:
                              url: ${callback_url}
                              auth:
                                  type: OAuth2
                              body:
                                  event: ${event}

  8. Clique em Implantar.

gcloud

  1. Crie um arquivo de código-fonte para o fluxo de trabalho:

    touch callback-event-listener.yaml

  2. Em um editor de texto, copie o seguinte fluxo de trabalho para o arquivo de código-fonte:

    main:
  params: [event]
  steps:
    - log_event:
        call: sys.log
        args:
          text: ${event}
          severity: INFO
    - init:
        assign:
          - database_root: ${"projects/" + sys.get_env("GOOGLE_CLOUD_PROJECT_ID") + "/databases/(default)/documents/callbacks/"}
          - event_source_tokens: ${text.split(event.source, "/")}
          - event_source_len: ${len(event_source_tokens)}
          - event_source: ${event_source_tokens[event_source_len - 1]}
          - doc_name: ${database_root + event_source}
    - get_document_for_event_source:
        try:
          call: googleapis.firestore.v1.projects.databases.documents.get
          args:
            name: ${doc_name}
          result: document
        except:
            as: e
            steps:
                - known_errors:
                    switch:
                    - condition: ${e.code == 404}
                      return: ${"No callbacks for event source " + event_source}
                - unhandled_exception:
                    raise: ${e}
    - process_callback_urls:
        steps:
          - check_fields_exist:
              switch:
              - condition: ${not("fields" in document)}
                return: ${"No callbacks for event source " + event_source}
              - condition: true
                next: processFields
          - processFields:
              for:
                  value: key
                  in: ${keys(document.fields)}
                  steps:
                      - extract_callback_url:
                          assign:
                              - callback_url: ${document.fields[key]["stringValue"]}
                      - log_callback_url:
                          call: sys.log
                          args:
                            text: ${"Calling back url " + callback_url}
                            severity: INFO
                      - http_post:
                          call: http.post
                          args:
                              url: ${callback_url}
                              auth:
                                  type: OAuth2
                              body:
                                  event: ${event}

  3. Implante o fluxo de trabalho digitando o seguinte comando:

    gcloud workflows deploy callback-event-listener \
    --source=callback-event-listener.yaml \
    --location=us-central1 \
    --service-account=SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com

    Substitua SERVICE_ACCOUNT_NAME pelo nome da conta de serviço que você criou anteriormente.

Implantar um fluxo de trabalho que aguarda eventos

O fluxo de trabalho callback-event-sample armazena os detalhes de callback em um banco de dados do Firestore, interrompe a execução e aguarda eventos específicos.

Console

  1. No console Google Cloud , acesse a página Fluxos de trabalho:

    Acessar fluxos de trabalho

  2. Clique em Criar.

  3. Insira um nome para o novo fluxo de trabalho: callback-event-sample.

  4. Na lista Região, selecione us-central1.

  5. Selecione a conta de serviço que você criou.

  6. Clique em Próxima.

  7. No editor de fluxo de trabalho, insira a seguinte definição:

    main:
  steps:
    - init:
        assign:
          - pubsub_topic: topic-callback
          - storage_bucket: ${sys.get_env("GOOGLE_CLOUD_PROJECT_ID") + "-bucket-callback"}
    - await_pubsub_message:
        call: await_callback_event
        args:
          event_source: ${pubsub_topic}
        result: pubsub_event
    - await_storage_bucket:
        call: await_callback_event
        args:
          event_source: ${storage_bucket}
        result: storage_event
    - return_events:
        return:
            pubsub_event: ${pubsub_event}
            storage_event: ${storage_event}

await_callback_event:
    params: [event_source]
    steps:
        - init:
            assign:
              - database_root: ${"projects/" + sys.get_env("GOOGLE_CLOUD_PROJECT_ID") + "/databases/(default)/documents/callbacks/"}
              - doc_name: ${database_root + event_source}
              - execution_id: ${sys.get_env("GOOGLE_CLOUD_WORKFLOW_EXECUTION_ID")}
              - firestore_key: ${"exec_" + text.split(execution_id, "-")[0]}
        - create_callback:
            call: events.create_callback_endpoint
            args:
              http_callback_method: POST
            result: callback_details
        - save_callback_url:
            call: googleapis.firestore.v1.projects.databases.documents.patch
            args:
              name: ${doc_name}
              updateMask:
                fieldPaths: ["${firestore_key}"]
              body:
                fields:
                  ${firestore_key}:
                    stringValue: ${callback_details.url}
        - log_and_await_callback:
            try:
              steps:
                - log_await_start:
                    call: sys.log
                    args:
                      severity: INFO
                      data: ${"Started waiting 1hr for an event from source " + event_source}
                - await_callback:
                    call: events.await_callback
                    args:
                      callback: ${callback_details}
                      timeout: 3600
                    result: callback_request
                - log_await_stop:
                    call: sys.log
                    args:
                      severity: INFO
                      data: ${"Stopped waiting for an event from source " + event_source}
            except:
                as: e
                steps:
                    - log_error:
                        call: sys.log
                        args:
                            severity: "ERROR"
                            text: ${"Received error " + e.message}
        - delete_callback_url:
            call: googleapis.firestore.v1.projects.databases.documents.patch
            args:
              name: ${doc_name}
              updateMask:
                fieldPaths: ["${firestore_key}"]
        - check_null_event:
            switch:
              - condition: ${callback_request == null}
                return: null
        - log_await_result:
            call: sys.log
            args:
              severity: INFO
              data: ${callback_request.http_request.body.event}
        - return_event:
            return: ${callback_request.http_request.body.event}

  8. Clique em Implantar.

gcloud

  1. Crie um arquivo de código-fonte para o fluxo de trabalho:

    touch callback-event-sample.yaml

  2. Em um editor de texto, copie o seguinte fluxo de trabalho para o arquivo de código-fonte:

    main:
  steps:
    - init:
        assign:
          - pubsub_topic: topic-callback
          - storage_bucket: ${sys.get_env("GOOGLE_CLOUD_PROJECT_ID") + "-bucket-callback"}
    - await_pubsub_message:
        call: await_callback_event
        args:
          event_source: ${pubsub_topic}
        result: pubsub_event
    - await_storage_bucket:
        call: await_callback_event
        args:
          event_source: ${storage_bucket}
        result: storage_event
    - return_events:
        return:
            pubsub_event: ${pubsub_event}
            storage_event: ${storage_event}

await_callback_event:
    params: [event_source]
    steps:
        - init:
            assign:
              - database_root: ${"projects/" + sys.get_env("GOOGLE_CLOUD_PROJECT_ID") + "/databases/(default)/documents/callbacks/"}
              - doc_name: ${database_root + event_source}
              - execution_id: ${sys.get_env("GOOGLE_CLOUD_WORKFLOW_EXECUTION_ID")}
              - firestore_key: ${"exec_" + text.split(execution_id, "-")[0]}
        - create_callback:
            call: events.create_callback_endpoint
            args:
              http_callback_method: POST
            result: callback_details
        - save_callback_url:
            call: googleapis.firestore.v1.projects.databases.documents.patch
            args:
              name: ${doc_name}
              updateMask:
                fieldPaths: ["${firestore_key}"]
              body:
                fields:
                  ${firestore_key}:
                    stringValue: ${callback_details.url}
        - log_and_await_callback:
            try:
              steps:
                - log_await_start:
                    call: sys.log
                    args:
                      severity: INFO
                      data: ${"Started waiting 1hr for an event from source " + event_source}
                - await_callback:
                    call: events.await_callback
                    args:
                      callback: ${callback_details}
                      timeout: 3600
                    result: callback_request
                - log_await_stop:
                    call: sys.log
                    args:
                      severity: INFO
                      data: ${"Stopped waiting for an event from source " + event_source}
            except:
                as: e
                steps:
                    - log_error:
                        call: sys.log
                        args:
                            severity: "ERROR"
                            text: ${"Received error " + e.message}
        - delete_callback_url:
            call: googleapis.firestore.v1.projects.databases.documents.patch
            args:
              name: ${doc_name}
              updateMask:
                fieldPaths: ["${firestore_key}"]
        - check_null_event:
            switch:
              - condition: ${callback_request == null}
                return: null
        - log_await_result:
            call: sys.log
            args:
              severity: INFO
              data: ${callback_request.http_request.body.event}
        - return_event:
            return: ${callback_request.http_request.body.event}

  3. Implante o fluxo de trabalho digitando o seguinte comando:

    gcloud workflows deploy callback-event-sample \
    --source=callback-event-sample.yaml \
    --location=us-central1 \
    --service-account=SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com

    Substitua SERVICE_ACCOUNT_NAME pelo nome da conta de serviço que você criou anteriormente.

Criar um gatilho do Eventarc para rotear eventos do Pub/Sub

Um gatilho do Eventarc permite rotear eventos especificando filtros para o gatilho, incluindo a origem do evento e o fluxo de trabalho de destino. Crie um gatilho do Eventarc para executar o fluxo de trabalho callback-event-listener como resultado da publicação de uma mensagem em um tópico do Pub/Sub. Saiba mais sobre como acionar um fluxo de trabalho.

Console

  1. No console Google Cloud , acesse a página Eventarc.

    Acessar o Eventarc

  2. Clique em Criar gatilho.

  3. Digite um Nome de gatilho.

    Por exemplo, trigger-pubsub-events-listener

  4. Na lista Provedor de eventos, selecione Cloud Pub/Sub.

  5. Na lista Evento, em Personalizado, selecione google.cloud.pubsub.topic.v1.messagePublished.

  6. Na lista Selecionar um tópico do Cloud Pub/Sub, escolha o tópico que você criou anteriormente.

  7. Na lista Região, selecione us-central1 (Iowa).

  8. Se solicitado, conceda o papel iam.serviceAccountTokenCreator à conta de serviço do Pub/Sub.

  9. Selecione a conta de serviço que você criou.

  10. Na lista Destino do evento, selecione Workflows.

  11. Na lista Selecionar um fluxo de trabalho, escolha o fluxo de trabalho callback-event-listener.

  12. Clique em Criar.

gcloud

Para criar um gatilho, execute o comando gcloud eventarc triggers create:

gcloud eventarc triggers create trigger-pubsub-events-listener \
    --location=us-central1 \
    --destination-workflow=callback-event-listener \
    --destination-workflow-location=us-central1 \
    --event-filters="type=google.cloud.pubsub.topic.v1.messagePublished" \
    --transport-topic=topic-callback \
    --service-account=SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com

Os eventos são transformados e transmitidos para a execução do fluxo de trabalho como argumentos de ambiente de execução. Pode levar até dois minutos para o novo gatilho ficar ativo.

Criar um gatilho do Eventarc para rotear eventos do Cloud Storage

Um gatilho do Eventarc permite rotear eventos especificando filtros para o gatilho, incluindo a origem do evento e o fluxo de trabalho de destino. Crie um gatilho do Eventarc para executar o fluxo de trabalho callback-event-listener como resultado do upload de um arquivo para um bucket do Cloud Storage. Saiba mais sobre como acionar um fluxo de trabalho.

Console

  1. No console Google Cloud , acesse a página Eventarc.

    Acessar o Eventarc

  2. Clique em Criar gatilho.

  3. Digite um Nome de gatilho.

    Por exemplo, trigger-storage-events-listener

  4. Na lista Provedor de eventos, selecione Cloud Storage.

  5. Na lista Evento, em Direto, selecione google.cloud.storage.object.v1.finalized.

  6. Na lista Bucket, procure e selecione o bucket que você criou anteriormente.

  7. Na lista Região, com base no seu bucket do Cloud Storage, aceite o padrão us-central1 (Iowa).

  8. Se solicitado, conceda o papel iam.serviceAccountTokenCreator à conta de serviço do Pub/Sub.

  9. Selecione a conta de serviço que você criou.

  10. Na lista Destino do evento, selecione Workflows.

  11. Na lista Selecionar um fluxo de trabalho, escolha o fluxo de trabalho callback-event-listener.

  12. Clique em Criar.

gcloud

Para criar um gatilho, execute o comando gcloud eventarc triggers create:

gcloud eventarc triggers create trigger-storage-events-listener \
    --location=us-central1 \
    --destination-workflow=callback-event-listener \
    --destination-workflow-location=us-central1 \
    --event-filters="type=google.cloud.storage.object.v1.finalized" \
    --event-filters="bucket=PROJECT_ID-bucket-callback" \
    --service-account=SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com

Os eventos são transformados e transmitidos para a execução do fluxo de trabalho como argumentos de ambiente de execução. Pode levar até dois minutos para o novo gatilho ficar ativo.

Executar o fluxo de trabalho principal

Quando um fluxo de trabalho é executado, a definição atual associada a ele também é. Execute o fluxo de trabalho callback-event-sample. Esse é o fluxo de trabalho principal, que aguarda eventos específicos para retomar a execução quando o fluxo de trabalho secundário faz as solicitações de callback adequadas.

Console

  1. No console Google Cloud , acesse a página Fluxos de trabalho.

    Acessar fluxos de trabalho

  2. Na página Fluxos de trabalho, clique no fluxo callback-event-sample para acessar a página de detalhes dele.

  3. Na página Detalhes do fluxo de trabalho, clique em Executar.

  4. Clique em Executar novamente.

    A execução do fluxo de trabalho é iniciada. Enquanto a execução é realizada, você verá um Estado da execução de Running e uma entrada de registro semelhante a esta: Started waiting 1hr for an event from source topic-callback.

gcloud

Para executar um fluxo de trabalho, execute o comando gcloud workflows run:

gcloud workflows run callback-event-sample \
    --location=us-central1

A execução do fluxo de trabalho é iniciada. Enquanto a execução é realizada, você verá um estado de execução semelhante a este:

Waiting for execution [a848a164-268a-449c-b2fe-396f32f2ed66] to complete...working...

Gerar eventos e verificar o status da execução

Para confirmar se os resultados estão corretos, gere eventos, confira as entradas de registro e verifique o status de execução do fluxo de trabalho.

Publicar uma mensagem

Publique uma mensagem no tópico do Pub/Sub que você criou anteriormente.

Console

  1. No console Google Cloud , acesse a página Tópicos do Pub/Sub.

    Acesse Tópicos

  2. Clique em topic-callback.

  3. Clique na guia Mensagens.

  4. Clique em Publicar mensagem.

  5. No campo Corpo da mensagem, digite Hello World.

  6. Clique em Publicar.

gcloud

Para publicar uma mensagem, use o comando gcloud pubsub topics publish:

gcloud pubsub topics publish topic-callback \
    --message="Hello World"

Fazer upload de um objeto

Faça upload de um arquivo para o bucket do Cloud Storage que você criou anteriormente.

Console

  1. No console Google Cloud , acesse a página Buckets do Cloud Storage.

    Acessar buckets

  2. Clique no nome do bucket que você criou anteriormente.

  3. Na guia Objetos, faça o seguinte:

    • Arraste e solte o arquivo que você quer enviar da área de trabalho ou do gerenciador de arquivos para o painel principal no console do Google Cloud .

    • Clique em Fazer upload de arquivos, selecione o arquivo que você quer enviar e clique em Abrir.

gcloud

Para fazer upload de um arquivo, execute o comando gcloud storage cp:

gcloud storage cp OBJECT_LOCATION gs://PROJECT_ID-bucket-callback/

Substitua OBJECT_LOCATION pelo caminho local do objeto. Por exemplo, random.txt.

Ver entradas de registro e status de execução

Confirme se o fluxo de trabalho callback-event-sample foi concluído com sucesso.

Console

  1. No console Google Cloud , acesse a página Fluxos de trabalho.

    Acessar fluxos de trabalho

  2. Na página Fluxos de trabalho, clique no fluxo callback-event-sample para acessar a página de detalhes dele.

  3. Na página Detalhes do fluxo de trabalho, para recuperar os detalhes de uma execução específica, clique no ID de execução adequado.

    O Estado da execução deve ser Concluído e, no painel "Saída", você verá os eventos recebidos do Pub/Sub e do Cloud Storage.

gcloud

  1. Filtre as entradas de registro e retorne a saída no formato JSON:

    gcloud logging read "resource.type=workflows.googleapis.com/Workflow AND textPayload:calling OR textPayload:waiting" \
    --format=json

  2. Procure entradas de registro semelhantes a esta:

    "textPayload": "Stopped waiting for an event from source..."
"textPayload": "Calling back url https://workflowexecutions.googleapis.com/v1/projects/..."
"textPayload": "Started waiting 1hr for an event from source..."

  3. Verifique o status da última tentativa de execução:

    gcloud workflows executions wait-last

    O resultado será semelhante a este:

    Using cached execution name: projects/1085953646031/locations/us-central1/workflows/callback-event-sample/executions/79929e4e-82c1-4da1-b068-f828034c01b7
Waiting for execution [79929e4e-82c1-4da1-b068-f828034c01b7] to complete...done.
[...]
state: SUCCEEDED

Limpar

Se você criou um novo projeto para este tutorial, exclua o projeto. Se você usou um projeto atual e quer mantê-lo sem as alterações incluídas neste tutorial, exclua os recursos criados para o tutorial.

Exclua o projeto

O jeito mais fácil de evitar cobranças é excluindo o projeto que você criou para o tutorial.

Para excluir o projeto:

  1. In the Google Cloud console, go to the Manage resources page.

    Go to Manage resources

  2. In the project list, select the project that you want to delete, and then click Delete.
  3. In the dialog, type the project ID, and then click Shut down to delete the project.

Excluir recursos criados neste tutorial

  1. Exclua dados do Firestore.

  2. Exclua um tópico do Pub/Sub.

  3. Exclua um bucket do Cloud Storage.

  4. Excluir um gatilho do Eventarc.

  5. Exclua um fluxo de trabalho.

A seguir