Crea e implementa una función de HTTP de Cloud Functions con Go

Crea e implementa una función de HTTP de Cloud Functions con Go

Introducción

En esta guía, se explica el proceso de escribir una función de Cloud Functions mediante el entorno de ejecución de Go. Existen dos tipos de funciones de Cloud Functions:

• Una es la función de HTTP que se invoca a partir de solicitudes HTTP estándar.
• La otra es una función controlada por eventos que se activa mediante eventos en la infraestructura de tu nube, como mensajes en un tema de Cloud Pub/Sub o cambios en un bucket de Cloud Storage.

Para obtener más detalles, consulta Escribir funciones HTTP y Escribir funciones controladas por eventos.

Antes de comenzar

1. Accede a tu cuenta de Google Cloud. Si eres nuevo en Google Cloud, crea una cuenta para evaluar el rendimiento de nuestros productos en situaciones reales. Los clientes nuevos también obtienen $300 en créditos gratuitos para ejecutar, probar y, además, implementar cargas de trabajo.

2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

3. Asegúrate de que la facturación esté habilitada para tu proyecto de Google Cloud.

4. Enable the Cloud Functions, Cloud Build, Artifact Registry, Cloud Run, y Cloud Logging APIs.

   Enable the APIs

5. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

6. Asegúrate de que la facturación esté habilitada para tu proyecto de Google Cloud.

7. Enable the Cloud Functions, Cloud Build, Artifact Registry, Cloud Run, y Cloud Logging APIs.

   Enable the APIs

8. Instala e inicializa gcloud CLI.
Nota: ¿Necesitas un símbolo del sistema? Puedes usar Google Cloud Shell. Google Cloud Shell es un entorno de línea de comandos que ya incluye Google Cloud CLI, por lo que no es necesario que lo instales. Google Cloud CLI también viene preinstalado en las máquinas virtuales de Google Compute Engine.
9. Instala y actualiza los componentes de gcloud con el siguiente comando.

   gcloud components update

10. Prepara tu entorno de desarrollo.

    Ir a la guía de configuración de Go

Crea tu función

1. Crea un directorio en tu sistema local para el código de función:

   Linux o Mac OS X

   mkdir ~/helloworld
   cd ~/helloworld
   

   Windows

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

2. Crea un archivo llamado hello_http.go en el directorio helloworld con el siguiente contenido:

   
   // 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))
   }
   

   Esta función de ejemplo toma un nombre proporcionado en la solicitud HTTP y muestra un saludo o “Hello, World!” cuando no se proporciona ningún nombre.

Especificar dependencias

Crea un archivo go.mod para realizar un seguimiento de tus dependencias:

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

Si tu función tiene dependencias más allá de la biblioteca de Functions Framework, edita el archivo go.mod para agregarlas. También puedes especificar dependencias con un directorio vendor de Go. Para obtener más información, lee Especifica dependencias en Go.

Compila y prueba la función de forma local

Puedes optar por compilar y probar tu función de forma local sin implementarla. Para ello, debes crear un módulo main.go local a fin de invocar tu función.

1. Crea un subdirectorio cmd:

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

2. Para crear un módulo de Go principal a fin de invocar tu función, copia el siguiente fragmento de código en un archivo llamado main.go en el directorio ~/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. Resuelve las dependencias restantes con el comando go mod tidy:

   go mod tidy
   

4. Ejecuta la función de forma local con el siguiente comando:

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

5. Para probar tu función, visita http://localhost:8080 en un navegador o ejecuta curl localhost:8080 desde otra ventana.

   Consulta Envía solicitudes a funciones locales para obtener más detalles.

Implementa tu función

Para implementar tu función, ejecuta el comando helloworld en el directorio:

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

Reemplaza REGION por el nombre de la región de Google Cloud en la que deseas implementar tu función (por ejemplo, us-west1).

La marca opcional --allow-unauthenticated te permite acceder a tu función sin autenticación.

Más información: Para obtener más detalles, lee acerca de la implementación de funciones de Cloud Functions.

Prueba la función implementada

1. Después de que se implementa la función, toma nota de la propiedad uri del resultado del comando gcloud functions deploy o recupérala con el siguiente comando:

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

   Reemplaza REGION por el nombre de la región de Google Cloud en la que implementaste tu función (por ejemplo, us-west1).

2. Visita esta URL en tu navegador. La función muestra un mensaje que dice "Hello World!".

   Nota: También puedes encontrar esta URL en la consola de Google Cloud. Ve a la página de descripción general de Cloud Functions y haz clic en el nombre de tu función para abrir la página de detalles de la función. Abre la pestaña ACTIVADOR para ver la URL de tu función.

Visualiza los registros de tu función

Visualiza registros con la herramienta de línea de comandos

Puedes revisar los registros de tu función con la IU de Cloud Logging o a través de Google Cloud CLI.

Para ver los registros de tu función con gcloud CLI, usa el comando logs read:

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

Reemplaza REGION por el nombre de la región de Google Cloud en la que implementaste tu función (por ejemplo, us-west1).

El resultado se ve de la manera siguiente:

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:

Nota: Puede haber una pequeña demora antes de que aparezcan las entradas de registro en Cloud Logging.

Visualiza registros con el panel de registros

Para ver los registros de tu función con el panel de registro, abre el Página de descripción general de Cloud Functions, haz clic en el nombre de tu función en la lista y, luego, en la pestaña Registros.

Más información: Para obtener más detalles, lee Escribe, visualiza y responde registros.