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 richiami dalle richieste HTTP standard.
  • Una funzione basata su eventi, che utilizzi per gestire gli eventi dal tuo 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 con quanto segue .
    gcloud components update
  10. Prepara 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 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 fornito nella richiesta HTTP e restituisce un saluto o "Hello World!" se non viene specificato alcun nome.

Specifica delle dipendenze

Le dipendenze in Python sono gestite con pip ed espressi in un file di metadati denominato 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 i seguenti contenuti:

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

Crea e testa la tua funzione in locale

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

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

    pip install -r requirements.txt
    PATH=$PATH:~/.local/bin
    
  2. Esegui la funzione in locale con il framework di Functions:

    functions-framework-python --target hello_http
    
  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.

esegui il deployment della funzione

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

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 python-http-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. Accedi all'URL dal browser. 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 tramite Google Cloud CLI.

Per visualizzare i log per la tua funzione con gcloud CLI, utilizza il metodo 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 es. 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.

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.