Crea y, también, implementa una función de HTTP de Cloud Run con Python

En esta guía, se explica el proceso para escribir una función de Cloud Run Functions mediante el entorno de ejecución de Python. Existen dos tipos de funciones de Cloud Run:

  • Una función de HTTP que se invoca a partir de solicitudes HTTP estándar.
  • Y la otra es una función controlada por eventos que se usa para manejar los eventos de la infraestructura de nube, como mensajes en un tema de Cloud Pub/Sub o cambios en un bucket de Cloud Storage.

Para obtener más detalles, consulta Escribir funciones HTTP y Escribir funciones controladas por eventos.

Antes de comenzar

  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. Instala e inicializa gcloud CLI
  9. Instala y actualiza gcloud los componentes de con el siguiente comando. 
    gcloud components update
  10. Prepara tu entorno de desarrollo.

    Ir a la guía de configuración de Python

Crea tu función

  1. Crea un directorio en tu sistema local para el código de función:

    Linux o MacOS X

    mkdir ~/helloworld
cd ~/helloworld

    Windows

    mkdir %HOMEPATH%\helloworld
cd %HOMEPATH%\helloworld

  2. Crea un archivo main.py en el directorio helloworld con el siguiente contenido:

    
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)}!"

    Esta función de ejemplo toma un nombre proporcionado en la solicitud HTTP y muestra un saludo o “Hello World!” cuando no se proporciona ningún nombre.

Especificar dependencias

Las dependencias en Python se administran con pip y se expresan en un archivo de metadatos llamado requirements.txt. Este archivo debe estar en el mismo directorio que el archivo main.py que contiene el código de tu función.

  1. Crea un requirements.txt archivo en el helloworld directorio con el siguiente contenido:

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

Compila y prueba la función de forma local

Para compilar y probar la función de forma local antes de implementarla, haz lo siguiente:

  1. Ejecuta el instalador de paquetes para Python, pip, para instalar las dependencias de tu paquete:

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

  2. Ejecuta la función de forma local con Functions Framework:

    functions-framework-python --target hello_http

  3. Para probar tu función, visita http://localhost:8080 en un navegador o ejecuta curl localhost:8080 desde otra ventana.

    Consulta Envía solicitudes a funciones locales para obtener más detalles.

Implemente su función

Para implementar tu función, ejecuta el comando helloworld en el directorio:

  gcloud functions deploy python-http-function \
    --gen2 \
    --runtime=python312 \
    --region=REGION \
    --source=. \
    --entry-point=hello_http \
    --trigger-http \
    --allow-unauthenticated

Reemplaza REGION por el nombre de la regiónGoogle Cloud en la que deseas implementar tu función (por ejemplo, us-west1).

La marca opcional --allow-unauthenticated te permite acceder a tu función sin autenticación.

Prueba la función implementada

  1. Después de que se implementa la función, toma nota de la propiedad uri del resultado del comando gcloud functions deploy o recupérala con el siguiente comando:

    gcloud functions describe python-http-function \
  --region=REGION

    Reemplaza REGION por el nombre de la regiónGoogle Cloud en la que implementaste tu función (por ejemplo, us-west1).

  2. Visita esta URL en tu navegador. La función muestra un mensaje "Hello World!".

Visualiza los registros de tu función

Visualiza registros con la herramienta de línea de comandos

Puedes revisar los registros de tu función con la IU de Cloud Logging o a través de Google Cloud CLI.

Para ver los registros de tu función con gcloud CLI, usa el comando logs read:

  gcloud functions logs read \
    --gen2 \
    --limit=10 \
    --region=REGION \
    python-http-function

Reemplaza REGION por el nombre de la regiónGoogle Cloud en la que implementaste tu función (por ejemplo, us-west1).

El resultado se ve de la manera siguiente:

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.

Visualiza registros con el panel de registros

Para ver los registros de tu función con el panel de registro, abre el Página de descripción general de Cloud Run Functions, haz clic en el nombre de tu función en la lista y, luego, en la pestaña Registros.