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

Questo documento ti guida nella procedura di creazione di una Funzione HTTP di Cloud Functions. Questo è uno dei due tipi di Cloud Functions:

  • Una funzione HTTP, che richiami dalle richieste HTTP standard.
  • Una funzione basata su eventi, che viene attivata da eventi in Cloud ad esempio i messaggi su un argomento Pub/Sub o le modifiche nel bucket Cloud Storage.

Per maggiori dettagli, leggi l'articolo Scrivere funzioni HTTP e la 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. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  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, and Cloud Logging.

    Abilita le API

  5. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  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, and Cloud Logging.

    Abilita le API

  8. Installa e inizializza gcloud CLI.
  9. Aggiorna e installa i componenti di gcloud.
    gcloud components update
  10. Prepara 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 seguenti contenuti:

    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 espressi in un file di metadati denominato package.json. Puoi creare questo 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 sue domande.

      npm init
      
    2. Modifica il file package.json per aggiungere una dipendenza al framework delle funzioni:

      "dependencies": {
        "@google-cloud/functions-framework": "^3.1.0"
      }
      
  • Se preferisci creare il file package.json manualmente, copia al suo interno:

{
  "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 di Node.js disponibili per l'utilizzo con i prodotti Google Cloud e possono essere installati delle dipendenze.

Crea e testa la tua funzione in locale

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

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

    npm install @google-cloud/functions-framework
    
  2. Per farlo, esegui questo comando dalla directory helloworld la funzione localmente:

    npx @google-cloud/functions-framework --target=helloGET
    
  3. Testa la funzione visitando http://localhost:8080 in un browser oppure eseguendo curl localhost:8080 da un'altra finestra.

    Consulta Invio di richieste a funzioni locali per in modo più dettagliato.

La funzione restituisce il messaggio "Hello World!"

esegui il deployment della funzione

Per eseguire il deployment della funzione, esegui 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 es. us-west1).

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

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

Testa la funzione di cui hai eseguito il deployment

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

      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 es. us-west1).

  2. Visita questo URL nel tuo browser o utilizzando 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 rivedere 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 metodo 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 es. 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.

Visualizza i log con la dashboard dei log

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