Créer et déployer une fonction Cloud HTTP avec Go

Pour simplifier les recherches et améliorer votre expérience avec la documentation, nous divisons les documentations consacrées à la 1re génération et à la 2e génération en ensembles distincts.

Introduction

Ce guide vous accompagne tout au long du processus d'écriture d'une fonction Cloud à l'aide de l'environnement d'exécution Go. Il existe deux types de fonctions Cloud :

Les fonctions HTTP, que vous appelez à partir des requêtes HTTP standards.
Les fonctions pilotées et déclenchées par des événements dans votre infrastructure cloud tels que les messages sur un sujet Pub/Sub ou les modifications apportées à un bucket Cloud Storage.

Pour en savoir plus, consultez les sections Écrire des fonctions HTTP et Écrire des fonctions pilotées par des événements.

Avant de commencer

Connectez-vous à votre compte Google Cloud. Si vous débutez sur Google Cloud, créez un compte pour évaluer les performances de nos produits en conditions réelles. Les nouveaux clients bénéficient également de 300 $ de crédits gratuits pour exécuter, tester et déployer des charges de travail.

Dans Google Cloud Console, sur la page de sélection du projet, sélectionnez ou créez un projet Google Cloud.

Accéder au sélecteur de projet

Vérifiez que la facturation est activée pour votre projet Google Cloud.

Activer les API Cloud Functions, Cloud Build, Artifact Registry, Cloud Run et Cloud Logging.

Activer les API

Dans Google Cloud Console, sur la page de sélection du projet, sélectionnez ou créez un projet Google Cloud.

Accéder au sélecteur de projet

Vérifiez que la facturation est activée pour votre projet Google Cloud.

Activer les API Cloud Functions, Cloud Build, Artifact Registry, Cloud Run et Cloud Logging.

Activer les API

Installez et initialisez la gcloud CLI.

Mettez à jour et installez les composants gcloud à l'aide de la commande suivante.
```
gcloud components update
```
Préparez votre environnement de développement.

Accéder au guide de configuration Go

Créer une fonction

Créez un répertoire sur votre système local pour le code de fonction :
Linux ou Mac OS X
```
mkdir ~/helloworld
cd ~/helloworld
```
Windows
```
mkdir %HOMEPATH%\helloworld
cd %HOMEPATH%\helloworld
```

Créez un fichier hello_http.go dans le répertoire helloworld avec le contenu suivant :


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

Cet exemple de fonction utilise un nom fourni dans la requête HTTP et renvoie un message d'accueil. Lorsqu'aucun nom n'est fourni, il renvoie le message "Hello World!".

Spécifier des dépendances

Créez un fichier go.mod pour effectuer le suivi de vos dépendances:

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

Si votre fonction possède des dépendances externes à la bibliothèque du framework des fonctions, modifiez le fichier go.mod pour les ajouter. Vous pouvez également spécifier des dépendances avec un répertoire Go vendor. Pour en savoir plus, consultez la page Spécifier des dépendances en Go.

Créer et tester votre fonction localement

Vous pouvez choisir de créer et de tester votre fonction localement sans la déployer. Pour ce faire, vous devez créer un module main.go local pour appeler votre fonction.

Créez un sous-répertoire cmd:

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

Créez un module go principal pour appeler votre fonction en copiant l'extrait de code suivant dans un fichier nommé main.go dans le répertoire ~/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)
  }
}

Corrigez les dépendances restantes à l'aide de la commande go mod tidy:
```
go mod tidy
```
Exécutez votre fonction localement à l'aide de la commande suivante:
```
export FUNCTION_TARGET=HelloHTTP
go run ~/helloworld/cmd/main.go
```
Testez votre fonction en accédant à http://localhost:8080 dans un navigateur ou en exécutant curl localhost:8080 à partir d'une autre fenêtre.

Pour en savoir plus, consultez la section Envoyer des requêtes aux fonctions locales.

Déployer la fonction

Pour déployer votre fonction, exécutez la commande suivante dans le répertoire helloworld:

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

Remplacez REGION par le nom de la région Google Cloud dans laquelle vous souhaitez déployer votre fonction (par exemple, us-west1).

L'option facultative --allow-unauthenticated vous permet d'accéder à votre fonction sans authentification.

Tester la fonction déployée

Une fois la fonction déployée, notez la propriété uri à partir du résultat de la commande gcloud functions deploy ou récupérez-la à l'aide de la commande suivante :
```
  gcloud functions describe go-http-function \
    --region=REGION
```
Remplacez REGION par le nom de la région Google Cloud dans laquelle vous avez déployé votre fonction (par exemple, us-west1).
Accédez à cette URL dans votre navigateur. La fonction renvoie un message "Hello World!".

Vous pouvez également trouver cette URL dans la console Google Cloud. Accédez à la page Présentation de Cloud Functions et cliquez sur le nom de votre fonction pour ouvrir la page Informations sur la fonction. Ouvrez l'onglet DÉCLENCHEUR pour afficher l'URL de votre fonction.

Afficher les journaux de votre fonction

Afficher les journaux à l'aide de l'outil de ligne de commande

Vous pouvez consulter les journaux de votre fonction à l'aide de l'interface utilisateur Cloud Logging ou de Google Cloud CLI.

Pour afficher les journaux de votre fonction à l'aide de gcloud CLI, exécutez la commande logs read :

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

Remplacez REGION par le nom de la région Google Cloud dans laquelle vous avez déployé votre fonction (par exemple, us-west1).

Le résultat se présente comme suit :

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:

Afficher les journaux à l'aide du tableau de bord de journalisation

Pour afficher les journaux de votre fonction à l'aide du tableau de bord de journalisation, ouvrez la page Page de présentation de Cloud Functions et cliquez sur le nom de votre fonction dans la liste, puis sur l'onglet Journaux.

Introduction

Avant de commencer

Créer une fonction

Linux ou Mac OS X

Windows

Spécifier des dépendances

Créer et tester votre fonction localement

Déployer la fonction

Tester la fonction déployée

Afficher les journaux de votre fonction

Afficher les journaux à l'aide de l'outil de ligne de commande

Afficher les journaux à l'aide du tableau de bord de journalisation