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

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.

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

Les fonctions HTTP, que vous appelez à partir des requêtes HTTP standards.
Les fonctions déclenchées par des événements, qui vous permettent de gérer les événements depuis 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

Téléchargez, installez et initialisez le SDK Google Cloud.
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 Ruby

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 app.rb dans le répertoire helloworld avec le contenu suivant :

require "functions_framework"
require "cgi"
require "json"

FunctionsFramework.http "hello_http" do |request|
  # The request parameter is a Rack::Request object.
  # See https://www.rubydoc.info/gems/rack/Rack/Request
  name = request.params["name"] ||
         (request.body.rewind && JSON.parse(request.body.read)["name"] rescue nil) ||
         "World"
  # Return the response body as a string.
  # You can also return a Rack::Response object, a Rack response array, or
  # a hash which will be JSON-encoded into a response.
  "Hello #{CGI.escape_html name}!"
end

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

Dans Ruby, les dépendances sont gérées avec bundler et exprimées dans un fichier appelé Gemfile.

Lorsque vous déployez votre fonction, Cloud Functions télécharge et installe les dépendances déclarées dans Gemfile et Gemfile.lock à l'aide de bundler.

Le fichier Gemfile répertorie les packages requis par votre fonction, ainsi que les contraintes de version facultatives. Pour une fonction Cloud Functions, l'un de ces packages doit être le gem functions_framework.

Pour cet exercice, créez un fichier nommé Gemfile dans le même répertoire que le fichier app.rb contenant le code de votre fonction, avec le contenu suivant :

source "https://rubygems.org"
gem "functions_framework", "~> 0.7"

Exécutez la commande suivante pour installer le gem functions_framework et d'autres dépendances :

bundle install

Créer et tester votre fonction localement

Avant de déployer la fonction, vous pouvez la créer et la tester localement.

Exécutez la commande suivante pour utiliser le fichier exécutable functions-framework-ruby afin de démarrer un serveur Web local exécutant votre fonction hello_http :
```
bundle exec functions-framework-ruby --target hello_http
```
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.

Consultez également la section Tester les fonctions dans la documentation sur le framework des fonctions Ruby.

Déployer la fonction

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

  gcloud functions deploy ruby-http-function \
    --gen2 \
    --runtime=ruby32 \
    --region=REGION \
    --entry-point=hello_http \
    --source=. \
    --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 ruby-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!".

Remarque : 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

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

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

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 \
      ruby-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: hello-http
TIME_UTC: 2023-06-01 00:09:41.477
LOG: Default STARTUP TCP probe succeeded after 1 attempt for container "hello__http-1" on port 8080.

LEVEL:
NAME: hello-http
TIME_UTC: 2023-06-01 00:09:41.451
LOG: I, [2023-06-01T00:09:41.451784 #1]  INFO -- : FunctionsFramework: Serving function "hello_http" on port 8080...

LEVEL:
NAME: hello-http
TIME_UTC: 2023-06-01 00:09:41.364
LOG: I, [2023-06-01T00:09:41.363923 #1]  INFO -- : FunctionsFramework: Starting server...

LEVEL:
NAME: hello-http
TIME_UTC: 2023-06-01 00:09:41.363
LOG: I, [2023-06-01T00:09:41.363855 #1]  INFO -- : FunctionsFramework: Looking for function name "hello_http"...

LEVEL:
NAME: hello-http
TIME_UTC: 2023-06-01 00:09:41.354
LOG: I, [2023-06-01T00:09:41.354150 #1]  INFO -- : FunctionsFramework: Loading functions from "./app.rb"...

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.

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