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

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

Questa guida illustra il processo di scrittura di una Cloud Function utilizzando il runtime Ruby. Esistono due tipi di funzioni Cloud Functions:

• Una funzione HTTP, che puoi richiamare dalle richieste HTTP standard.
• Una funzione basata su eventi, utilizzata per gestire gli eventi della tua infrastruttura Cloud, come i messaggi su un argomento Pub/Sub o le modifiche in un bucket Cloud Storage.

Per ulteriori dettagli, consulta l'articolo sulla scrittura di funzioni HTTP e sulla scrittura di funzioni basate su eventi.

Prima di iniziare

1. Accedi al tuo account Google Cloud. Se non conosci Google Cloud, crea un account per valutare le prestazioni dei nostri prodotti in scenari reali. I nuovi clienti ricevono anche 300 $di crediti gratuiti per l'esecuzione, il test e il deployment dei carichi di lavoro.

2. Nella pagina del selettore di progetti della console Google Cloud, seleziona o crea un progetto Google Cloud.

   Nota: se non prevedi di conservare le risorse create in questa procedura, crea un progetto anziché selezionarne uno esistente. Dopo aver completato questi passaggi, puoi eliminare il progetto, rimuovendo tutte le risorse associate.

   Vai al selettore progetti

3. Assicurati che la fatturazione sia attivata per il tuo progetto Google Cloud.

4. Abilita le API Cloud Functions, Cloud Build, Artifact Registry, Cloud Run e Cloud Logging.

   Abilita le API

5. Nella pagina del selettore di progetti della console Google Cloud, seleziona o crea un progetto Google Cloud.

   Nota: se non prevedi di conservare le risorse create in questa procedura, crea un progetto anziché selezionarne uno esistente. Dopo aver completato questi passaggi, puoi eliminare il progetto, rimuovendo tutte le risorse associate.

   Vai al selettore progetti

6. Assicurati che la fatturazione sia attivata per il tuo progetto Google Cloud.

7. Abilita le API Cloud Functions, Cloud Build, Artifact Registry, Cloud Run e Cloud Logging.

   Abilita le API

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

   gcloud components update

Nota: 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, quindi non è necessario installarlo. Google Cloud CLI è anche preinstallato sulle macchine virtuali di Compute Engine.
10. Preparare l'ambiente di sviluppo.

    Vai alla guida alla configurazione di Ruby

Crea la funzione

1. Crea una directory sul tuo 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 specificato nella richiesta HTTP e restituisce un saluto o "Hello World!" se non viene fornito alcun nome.

Specifica delle dipendenze

Le dipendenze in Ruby sono gestite con bundler ed espresse in un file chiamato Gemfile.

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

L'elemento Gemfile elenca i pacchetti richiesti dalla funzione, insieme agli eventuali vincoli di versione facoltativi. Per una Cloud Function, uno di questi pacchetti deve essere la gemma functions_framework.

Per questo esercizio, crea un file denominato Gemfile nella stessa directory del file app.rb che contiene il codice della funzione, con il seguente contenuto:

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

Esegui questo comando per installare la gem functions_framework e altre dipendenze:

bundle install

Scopri di più: per maggiori dettagli, leggi come specificare le dipendenze.

Creare e testare la funzione in locale

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

1. Esegui questo comando per usare 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 tua funzione visitando http://localhost:8080 in un browser o eseguendo curl localhost:8080 da un'altra finestra.

   Per ulteriori dettagli, consulta Inviare richieste a 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 questo comando nella directory helloworld:

  gcloud functions deploy ruby-http-function \
    --gen2 \
    --runtime=ruby32 \
    --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 l'articolo sul deployment di Cloud Functions.

Testa la funzione di cui hai eseguito il deployment

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

       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 un messaggio "Hello World!".

   Nota: puoi trovare questo URL anche nella console Google Cloud. Vai alla pagina Panoramica di Cloud Functions e fai clic sul nome della funzione per aprire la relativa pagina Dettagli funzione. Apri la scheda TRIGGER 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 di log vengano visualizzate in Cloud Logging.

Visualizzare i log con la dashboard di logging

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

Scopri di più: per maggiori dettagli, leggi l'articolo sulla scrittura, la visualizzazione e la risposta ai log.