Crea ed esegui il deployment di una funzione Cloud Run HTTP con Ruby

Nota: questi contenuti si applicano solo alle funzioni Cloud Run, precedentemente Cloud Functions (2nd gen).

Per la versione 1ª generazione. di questo documento, consulta Crea ed esegui il deployment di una funzione HTTP Cloud Run con Ruby (1ª generazione.).

Questa guida illustra la procedura di scrittura di una funzione Cloud Run utilizzando il runtime Ruby. Esistono due tipi di funzioni Cloud Run:

• Una funzione HTTP che viene richiamata da richieste HTTP standard.
• Una funzione basata su eventi che utilizzi per gestire gli eventi della tua infrastruttura Cloud, ad esempio i messaggi in un argomento Pub/Sub o le modifiche in un bucket Cloud Storage.

Per maggiori dettagli, consulta la sezione sulla scrittura di funzioni HTTP e sulla scrittura di funzioni basate sugli eventi.

Prima di iniziare

1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

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. Make sure that billing is enabled for your Google Cloud project.

4. Enable the Cloud Functions, Cloud Build, Artifact Registry, Cloud Run, and 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. Make sure that billing is enabled for your Google Cloud project.

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

   Enable the APIs

8. Installa e inizializza Google Cloud SDK.
9. Aggiorna e installa i componenti gcloud con il seguente comando.

   gcloud components update

Nota: se hai bisogno di un prompt dei comandi, Puoi utilizzare Cloud Shell. Cloud Shell è un ambiente a riga di comando che include già Google Cloud CLI, pertanto non è necessario installarlo. Google Cloud CLI è preinstallato anche nelle macchine virtuali di Compute Engine.
10. Prepara l'ambiente di sviluppo.

    Vai alla guida alla configurazione di Ruby

Crea la funzione

1. Crea una directory sul sistema locale per il codice della funzione:

   Linux o Mac OS X

   mkdir ~/helloworld
   cd ~/helloworld
   

   Windows

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

2. Crea un file app.rb nella directory helloworld con il seguente contenuto:

   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

   Questa funzione di esempio prende un nome fornito nella richiesta HTTP e restituisce un saluto oppure "Hello World!" se non viene fornito alcun nome.

Specifica delle dipendenze

Le dipendenze in Ruby vengono gestite con bundler e expressed in un file denominato Gemfile.

Quando esegui il deployment della funzione, Cloud Run scarica e installa le dipendenze dichiarate in Gemfile e Gemfile.lock utilizzando bundler.

Gemfile elenca i pacchetti richiesti dalla funzione, insieme a eventuali vincoli di versione facoltativi. Per una funzione Cloud Run, uno di questi pacchetti deve essere la gem functions_framework.

Per questo esercizio, crea un file denominato Gemfile nella stessa directory del file app.rb contenente il codice della funzione, con i seguenti contenuti:

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

Esegui il seguente comando per installare il gem functions_framework e altre dipendenze:

bundle install

Scopri di più: per maggiori dettagli, consulta la sezione sulla specifica delle dipendenze.

Crea e testa la funzione in locale

Prima di eseguire il deployment della funzione, puoi crearla e testarla localmente.

1. Esegui il seguente comando per utilizzare l'eseguibile functions-framework-ruby per avviare un server web locale che esegue la funzione hello_http:

   bundle exec functions-framework-ruby --target hello_http
   

2. Testa la funzione visitando http://localhost:8080 in un browser o eseguendo curl localhost:8080 da un'altra finestra.

   Per maggiori dettagli, consulta Inviare richieste alle funzioni locali.

Consulta la sezione Test delle funzioni nella documentazione del framework Ruby Functions.

esegui il deployment della funzione

Per eseguire il deployment della funzione, esegui il seguente comando nella directory helloworld:

  gcloud functions deploy ruby-http-function \
    --gen2 \
    --runtime=ruby33 \
    --region=REGION \
    --entry-point=hello_http \
    --source=. \
    --trigger-http \
    --allow-unauthenticated

Sostituisci REGION con il nome della regione Google Cloud in cui vuoi eseguire il deployment della funzione (ad esempio us-west1).

Il flag facoltativo --allow-unauthenticated consente di raggiungere la funzione senza autenticazione.

Scopri di più: per maggiori dettagli, consulta la sezione relativa al deployment delle funzioni Cloud Run.

Testa la funzione di cui hai eseguito il deployment

1. Dopo il deployment della funzione, prendi nota della proprietà uri dall'output del comando gcloud functions deploy o recuperala con il seguente comando:

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

   Sostituisci REGION con il nome della regione Google Cloud in cui hai eseguito il deployment della funzione (ad esempio us-west1).

2. Accedi all'URL dal browser. La funzione restituisce il messaggio "Hello World!".

   Nota: puoi trovare questo URL anche nella console Google Cloud. Vai alla pagina Panoramica delle funzioni Cloud Run e fai clic sul nome della funzione per aprire la pagina Dettagli funzione. Apri la scheda ATTIVAZIONE per visualizzare l'URL della funzione.

Visualizza i log della funzione

Puoi esaminare i log della funzione con l'interfaccia utente di Cloud Logging o tramite Google Cloud CLI.

Visualizza i log con lo strumento a riga di comando

Per visualizzare i log per la tua funzione con gcloud CLI, utilizza il comando logs read:

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

Sostituisci REGION con il nome della regione Google Cloud in cui hai eseguito il deployment della funzione (ad esempio us-west1).

L'output è simile al seguente:

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"...

Nota: potrebbe verificarsi un leggero ritardo prima che le voci dei log vengano visualizzate in Cloud Logging.

Visualizzare i log con la dashboard di logging

Per visualizzare i log della tua funzione con la dashboard di logging, apri la pagina Panoramica delle funzioni Cloud Run e fai clic sul nome della funzione nell'elenco, quindi sulla scheda Log.

Scopri di più: per maggiori dettagli, consulta la sezione su come scrivere, visualizzare e rispondere ai log.