Criar e implantar uma função do Cloud em HTTP com Go

Criar e implantar uma função do Cloud em HTTP com Go

Introdução

Este guia explica o processo de criação de uma Função do Cloud usando o ambiente de execução do Go. Há dois tipos de Funções do Cloud:

• Uma função HTTP, que você invoca a partir de solicitações HTTP padrão.
• Uma função orientada a eventos, que é acionada por eventos em sua infraestrutura do Cloud, como mensagens em um tópico do Pub/Sub ou alterações em um bucket do Cloud Storage.

Para mais detalhes, leia Como escrever funções HTTP e Como escrever funções orientadas a eventos.

Antes de começar

1. Faça login na sua conta do Google Cloud. Se você começou a usar o Google Cloud agora, crie uma conta para avaliar o desempenho de nossos produtos em situações reais. Clientes novos também recebem US$ 300 em créditos para executar, testar e implantar cargas de trabalho.

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

   Observação: se você não pretende manter os recursos criados neste procedimento, crie um projeto novo em vez de selecionar um que já existe. Depois de concluir essas etapas, é possível excluir o projeto. Para fazer isso, basta remover todos os recursos associados a ele.

   Acessar o seletor de projetos

3. Verifique se a cobrança está ativada para o seu projeto do Google Cloud.

4. Ative as APIs Cloud Functions, Cloud Build, Artifact Registry, Cloud Run e Cloud Logging.

   Ative as APIs

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

   Observação: se você não pretende manter os recursos criados neste procedimento, crie um projeto novo em vez de selecionar um que já existe. Depois de concluir essas etapas, é possível excluir o projeto. Para fazer isso, basta remover todos os recursos associados a ele.

   Acessar o seletor de projetos

6. Verifique se a cobrança está ativada para o seu projeto do Google Cloud.

7. Ative as APIs Cloud Functions, Cloud Build, Artifact Registry, Cloud Run e Cloud Logging.

   Ative as APIs

8. Instale e inicialize a CLI gcloud.
Observação: precisa de um prompt de comando? Use o Google Cloud Shell. O Google Cloud Shell é um ambiente de linha de comando que já inclui a Google Cloud CLI. Portanto, não é necessário instalá-lo. A Google Cloud CLI também vem pré-instalado em máquinas virtuais do Google Compute Engine.
9. Atualize e instale os componentes gcloud com o comando a seguir.

   gcloud components update

10. Prepare seu ambiente de desenvolvimento.

    Acesse o guia de configuração do Go

Criar a função

1. Crie um diretório no seu sistema local para o código de função:

   Linux ou macOS

   mkdir ~/helloworld
   cd ~/helloworld
   

   Windows

   mkdir %HOMEPATH%\helloworld
   cd %HOMEPATH%\helloworld
   

2. Crie um arquivo chamado hello_http.go no diretório helloworld com o seguinte conteúdo.

   
   // Package helloworld provides a set of Cloud Functions samples.
   package helloworld
   
   import (
   	"encoding/json"
   	"fmt"
   	"html"
   	"net/http"
   
   	"github.com/GoogleCloudPlatform/functions-framework-go/functions"
   )
   
   func init() {
   	functions.HTTP("HelloHTTP", HelloHTTP)
   }
   
   // HelloHTTP is an HTTP Cloud Function with a request parameter.
   func HelloHTTP(w http.ResponseWriter, r *http.Request) {
   	var d struct {
   		Name string `json:"name"`
   	}
   	if err := json.NewDecoder(r.Body).Decode(&d); err != nil {
   		fmt.Fprint(w, "Hello, World!")
   		return
   	}
   	if d.Name == "" {
   		fmt.Fprint(w, "Hello, World!")
   		return
   	}
   	fmt.Fprintf(w, "Hello, %s!", html.EscapeString(d.Name))
   }
   

   Esse exemplo de função recebe um nome fornecido na solicitação HTTP e retorna uma saudação, ou "Hello, World!", quando nenhum nome é fornecido.

Especificar as dependências

Crie um arquivo go.mod para rastrear suas dependências:

cd ~/helloworld
go mod init example.com/hello
go mod tidy

Se a função tiver dependências além da biblioteca do framework, edite o arquivo go.mod para adicioná-las. Também é possível especificar dependências com um diretório vendor do Go. Para ver mais detalhes, leia Como especificar dependências no Go.

Criar e testar a função localmente

É possível criar e testar a função localmente sem implantá-la. Para isso, crie um módulo local main.go local para invocar a função.

1. Crie um subdiretório cmd:

   mkdir ~/helloworld/cmd
   cd ~/helloworld/cmd
   

2. Crie um módulo Go principal para invocar a função copiando o seguinte snippet de código em um arquivo chamado main.go no diretório ~/helloworld/cmd:

   package main
   
   import (
     "log"
     "os"
   
     // Blank-import the function package so the init() runs
     _ "example.com/hello"
     "github.com/GoogleCloudPlatform/functions-framework-go/funcframework"
   )
   
   func main() {
     // Use PORT environment variable, or default to 8080.
     port := "8080"
     if envPort := os.Getenv("PORT"); envPort != "" {
       port = envPort
     }
     if err := funcframework.Start(port); err != nil {
       log.Fatalf("funcframework.Start: %v\n", err)
     }
   }
   

3. Resolva as dependências restantes com o comando go mod tidy:

   go mod tidy
   

4. Execute a função localmente com o seguinte comando:

   export FUNCTION_TARGET=HelloHTTP
   go run ~/helloworld/cmd/main.go
   

5. Acesse http://localhost:8080 em um navegador ou execute curl localhost:8080 em outra janela para testar sua função.

   Saiba mais em Como enviar solicitações para funções locais.

implante a função

Para implantar a função, execute o comando a seguir no diretório helloworld:

  gcloud functions deploy go-http-function \
    --gen2 \
    --runtime=go121 \
    --region=REGION \
    --source=. \
    --entry-point=HelloHTTP \
    --trigger-http \
    --allow-unauthenticated

Substitua REGION pelo nome da região do Google Cloud em que você quer implantar a função (por exemplo, us-west1).

A flag --allow-unauthenticated opcional permite que você acesse a função sem autenticação.

Saiba mais: para ver mais detalhes, leia sobre Como implantar Cloud Functions.

Testar a função implantada

1. Depois que a função for implantada, observe a propriedade uri na saída do comando gcloud functions deploy ou recupere-a com o seguinte comando:

     gcloud functions describe go-http-function \
       --region=REGION
   

   Substitua REGION pelo nome da região do Google Cloud em que você implantou a função (por exemplo, us-west1).

2. Acesse este URL no navegador. A função retorna uma mensagem "Hello World!".

   Encontre também esse URL no Console do Google Cloud. Acesse a página Visão geral do Cloud Functions e clique no nome da função para abrir a página Detalhes da função. Abra a guia Gatilho para ver o URL da sua função.

Conferir os registros da função

Conferir os registros com a ferramenta de linha de comando

É possível analisar os registros da função com a IU do Cloud Logging ou por meio da Google Cloud CLI.

Para ver os registros da função com a CLI gcloud, use o comando logs read:

    gcloud functions logs read \
      --gen2 \
      --limit=10 \
      --region=REGION \
      go-http-function

Substitua REGION pelo nome da região do Google Cloud em que você implantou a função (por exemplo, us-west1).

A saída será assim:

LEVEL: I
NAME: hellohttp
TIME_UTC: 2023-05-31 21:52:20.473
LOG:

LEVEL: I
NAME: hellohttp
TIME_UTC: 2023-05-31 21:52:20.370
LOG:

LEVEL: I
NAME: hellohttp
TIME_UTC: 2023-05-31 21:52:20.280
LOG: Default STARTUP TCP probe succeeded after 1 attempt for container "h-hello_h_t_t_p-1" on port 8080.

LEVEL: I
NAME: hellohttp
TIME_UTC: 2023-05-31 21:52:20.108
LOG:

Observação: pode haver um pequeno atraso antes de as entradas de registro aparecerem no Cloud Logging.

Conferir os registros com o painel do Logging

Para ver os registros da função com o painel do Logging, abra a página de visão geral do Cloud Functions e clique no nome da função na lista. Em seguida, clique na guia Registros.

Saiba mais: para ver mais detalhes, leia sobre como gravar, ver e responder a registros.