Crea ed esegui il deployment di una Cloud Function HTTP con Node.js

Creare una funzione Cloud Functions HTTP ed eseguirne il deployment con Node.js

Questo documento illustra la procedura per creare una semplice funzione HTTP di Cloud Functions. Questo è uno dei due tipi di Cloud Functions:

• Una funzione HTTP, che puoi richiamare dalle richieste HTTP standard.
• Una funzione basata su eventi, che viene attivata da eventi nella 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. 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 e 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 e Cloud Logging APIs.

   Enable the APIs

8. Installa e inizializza gcloud CLI.
Nota: hai bisogno di un prompt dei comandi? Puoi utilizzare Google Cloud Shell. Google 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 Google Compute Engine.
9. Aggiorna e installa i componenti di gcloud.

   gcloud components update

10. Preparare l'ambiente di sviluppo.

    Vai alla guida alla configurazione di Node.js

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 index.js nella directory helloworld con il seguente contenuto:

   const functions = require('@google-cloud/functions-framework');
   
   // Register an HTTP function with the Functions Framework that will be executed
   // when you make an HTTP request to the deployed function's endpoint.
   functions.http('helloGET', (req, res) => {
     res.send('Hello World!');
   });

   Questa funzione di esempio restituisce un allegro "Hello World!" a tutte le richieste.

Specifica delle dipendenze

Le dipendenze in Node.js sono gestite con npm ed espresse in un file di metadati chiamato package.json. Puoi creare questo file manualmente o con il comando npm.

• Per creare il file package.json con il comando npm:

  1. Esegui il comando npm init dalla directory helloworld. Premi Enter per accettare la risposta predefinita alle relative domande.

     npm init
     

  2. Modifica il file package.json per aggiungere una dipendenza per il framework di funzioni:

     "dependencies": {
       "@google-cloud/functions-framework": "^3.1.0"
     }
     

• Se preferisci creare il file package.json manualmente, copia al suo interno il seguente contenuto:

{
  "name": "nodejs-docs-samples-functions-hello-world-get",
  "version": "0.0.1",
  "private": true,
  "license": "Apache-2.0",
  "author": "Google Inc.",
  "repository": {
    "type": "git",
    "url": "https://github.com/GoogleCloudPlatform/nodejs-docs-samples.git"
  },
  "engines": {
    "node": ">=16.0.0"
  },
  "scripts": {
    "test": "c8 mocha -p -j 2 test/*.test.js --timeout=6000 --exit"
  },
  "dependencies": {
    "@google-cloud/functions-framework": "^3.1.0"
  },
  "devDependencies": {
    "c8": "^8.0.0",
    "gaxios": "^6.0.0",
    "mocha": "^10.0.0",
    "wait-port": "^1.0.4"
  }
}

Molte librerie client Node.js sono disponibili per l'utilizzo con i prodotti Google Cloud e possono essere installate come dipendenze.

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

Creare e testare la funzione in locale

Per testare la funzione localmente prima di eseguirne il deployment, devi installare il framework delle funzioni in locale ed eseguire la funzione.

1. Esegui questo comando dalla directory helloworld per installare il framework di Functions sulla tua macchina locale:

   npm install @google-cloud/functions-framework
   

2. Esegui questo comando dalla directory helloworld per eseguire la funzione localmente:

   npx @google-cloud/functions-framework --target=helloGET
   

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

La funzione restituisce il messaggio "Hello World!".

esegui il deployment della funzione

Per eseguire il deployment della funzione, esegui il comando gcloud functions deploy nella directory helloworld:

gcloud functions deploy hello-node-function \
  --gen2 \
  --runtime=nodejs20 \
  --region=REGION \
  --source=. \
  --entry-point=helloGET \
  --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).

Questa operazione esegue il deployment della funzione di esempio con il runtime nodejs20 nella regione scelta.

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 hello-node-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. Visita questo URL nel tuo browser o con il seguente comando curl:

   curl FUNCTION_URL
   

   Sostituisci FUNCTION_URL con la proprietà uri che hai appena recuperato.

   La funzione restituisce un messaggio "Hello World!".

Visualizza i log della funzione

Visualizza i log con lo strumento a riga di comando

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

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

    gcloud functions logs read \
      --gen2 \
      --region=REGION \
      --limit=10 \
      hello-node-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-node-function
TIME_UTC: 2023-06-16 18:42:24.956
LOG:

LEVEL: I
NAME: hello-node-function
TIME_UTC: 2023-06-16 18:42:01.692
LOG:

LEVEL: I
NAME: hello-node-function
TIME_UTC: 2023-06-16 18:31:47.711
LOG: Default STARTUP TCP probe succeeded after 1 attempt for container "hello--node--function-1" on port 8080.

LEVEL: I
NAME: hello-node-function
TIME_UTC: 2023-06-16 18:31:46.542
LOG:

LEVEL: I
NAME: hello-node-function
TIME_UTC: 2023-06-16 18:31:27.390
LOG: Default STARTUP TCP probe succeeded after 1 attempt for container "hello--node--function-1" on port 8080.

Nota: potrebbe verificarsi un leggero ritardo tra la visualizzazione delle voci di log 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 su come scrivere, visualizzare e rispondere ai log.