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

Questa guida illustra la procedura per scrivere una funzione Cloud Run utilizzando il runtime Python. Esistono due tipi di funzioni Cloud Run:

  • Una funzione HTTP che viene richiamata da richieste HTTP standard.
  • Una funzione basata su eventi che utilizzi per gestire gli eventi della tua infrastruttura Cloud, ad esempio i messaggi in un argomento Pub/Sub o le modifiche in un bucket Cloud Storage.

Per maggiori dettagli, consulta la sezione sulla scrittura di funzioni HTTP e sulla scrittura di funzioni basate sugli 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.

  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.
  8. Installa e inizializza la gcloud CLI.
  9. Aggiorna e installa i componenti gcloud con il seguente comando. 
    gcloud components update
  10. Prepara l'ambiente di sviluppo.

    Vai alla guida alla configurazione di Python

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

    
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 fornito nella richiesta HTTP e restituisce un saluto oppure "Hello World!" se non viene fornito alcun nome.

Specifica delle dipendenze

Le dipendenze in Python sono gestite con pip e 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.*

Crea e testa la funzione in locale

Per creare ed eseguire il test della funzione localmente prima di eseguirne il deployment:

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

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

  2. Esegui la funzione localmente con il framework Functions:

    functions-framework-python --target hello_http

  3. Testa la funzione visitando http://localhost:8080 in un browser o eseguendo curl localhost:8080 da un'altra finestra.

    Per maggiori dettagli, consulta Inviare richieste alle funzioni locali.

esegui il deployment della funzione

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

Testa la funzione di cui hai eseguito il deployment

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

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

Visualizzare i log con la dashboard di logging

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.