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

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

Questa guida illustra il processo di scrittura di una Cloud Function utilizzando il runtime Python. 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. 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 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 Google Compute Engine.
9. Aggiorna e installa i componenti di gcloud con il comando seguente.

   gcloud components update

10. Preparare l'ambiente di sviluppo.

    Vai alla guida alla configurazione di Python

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 main.py nella directory helloworld con i seguenti contenuti:

   
   import functions_framework
   
   from markupsafe import escape
   @functions_framework.http
   def hello_http(request):
       """HTTP Cloud Function.
       Args:
           request (flask.Request): The request object.
           <https://flask.palletsprojects.com/en/1.1.x/api/#incoming-request-data>
       Returns:
           The response text, or any set of values that can be turned into a
           Response object using `make_response`
           <https://flask.palletsprojects.com/en/1.1.x/api/#flask.make_response>.
       """
       request_json = request.get_json(silent=True)
       request_args = request.args
   
       if request_json and "name" in request_json:
           name = request_json["name"]
       elif request_args and "name" in request_args:
           name = request_args["name"]
       else:
           name = "World"
       return f"Hello {escape(name)}!"
   
   

   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 Python sono gestite con pip ed espresse in un file di metadati chiamato requirements.txt. Questo file deve trovarsi nella stessa directory del file main.py che contiene il codice della funzione.

1. Crea un file requirements.txt nella directory helloworld con il seguente contenuto:

     # An example requirements file. If your function has other dependencies,
     # add them below
     functions-framework==3.*
   

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

Creare e testare la funzione in locale

Per creare e testare la funzione localmente prima di eseguirne il deployment:

1. Esegui il programma di installazione dei pacchetti per Python, pip, per installare le dipendenze del tuo pacchetto:

   pip install -r requirements.txt
   PATH=$PATH:~/.local/bin
   

2. Esegui la funzione localmente con il framework di Functions:

   functions-framework-python --target hello_http
   

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.

esegui il deployment della funzione

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

  gcloud functions deploy python-http-function \
    --gen2 \
    --runtime=python312 \
    --region=REGION \
    --source=. \
    --entry-point=hello_http \
    --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 python-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

Visualizza i log con lo strumento a riga di comando

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

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 \
    python-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 19:33:42.991
LOG: Default STARTUP TCP probe succeeded after 1 attempt for container "hello__http-1" on port 8080.

LEVEL: I
NAME: hello-http
TIME_UTC: 2023-06-01 19:33:41.933
LOG:

LEVEL: I
NAME: hello-http
TIME_UTC: 2023-06-01 19:33:26.475
LOG: Default STARTUP TCP probe succeeded after 1 attempt for container "hello__http-1" on port 8080.

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.