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

Questo documento ti guida nella procedura di creazione di una Funzione HTTP di Cloud Run. Si tratta di uno dei due tipi di funzioni Cloud Run:

  • Una funzione HTTP che viene richiamata da richieste HTTP standard.
  • Una funzione basata su eventi, che viene attivata da eventi nell'infrastruttura Cloud, ad esempio messaggi in un argomento Pub/Sub o modifiche in un bucket Cloud Storage.

Per maggiori dettagli, leggi l'articolo Scrivere funzioni HTTP e la 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.

    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.

    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 l'interfaccia a riga di comando gcloud.
  9. Aggiorna e installa i componenti 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 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 vengono gestite con npm e 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 sue domande.

      npm init
      
    2. Modifica il file package.json per aggiungere una dipendenza dal framework Functions:

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

{
  "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": "^10.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.

Crea e testa la 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 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 recuperata.

    La funzione restituisce il 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 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 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.