Crea e implementa una función de HTTP de Cloud Functions con Python

Crea e implementa una función de HTTP de Cloud Functions con Python

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

• Una es la 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. Accede a tu cuenta de Google Cloud. Si eres nuevo en Google Cloud, crea una cuenta para evaluar el rendimiento de nuestros productos en situaciones reales. Los clientes nuevos también obtienen $300 en créditos gratuitos para ejecutar, probar y, además, implementar cargas de trabajo.

2. En la página del selector de proyectos de la consola de Google Cloud, selecciona o crea un proyecto de Google Cloud.

   Nota: Si no planeas conservar los recursos que creaste durante este procedimiento, crea un proyecto en lugar de seleccionar uno existente. Cuando termines, puedes borrar el proyecto y quitar todos los recursos asociados con él.

   Ir al selector de proyectos

3. Asegúrate de que la facturación esté habilitada para tu proyecto de Google Cloud.

4. Habilita las API de Cloud Functions, Cloud Build, Artifact Registry, Cloud Run, y Cloud Logging.

   Habilita las API

5. En la página del selector de proyectos de la consola de Google Cloud, selecciona o crea un proyecto de Google Cloud.

   Nota: Si no planeas conservar los recursos que creaste durante este procedimiento, crea un proyecto en lugar de seleccionar uno existente. Cuando termines, puedes borrar el proyecto y quitar todos los recursos asociados con él.

   Ir al selector de proyectos

6. Asegúrate de que la facturación esté habilitada para tu proyecto de Google Cloud.

7. Habilita las API de Cloud Functions, Cloud Build, Artifact Registry, Cloud Run, y Cloud Logging.

   Habilita las API

8. Instala e inicializa gcloud CLI.
Nota: ¿Necesitas un símbolo del sistema? Puedes usar Cloud Shell. Google Cloud Shell es un entorno de línea de comandos que ya incluye Google Cloud CLI, por lo que no es necesario que lo instales. Google Cloud CLI también viene preinstalado en las máquinas virtuales de Google Compute Engine.
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 Mac OS 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.*
   

Más información: Para obtener más detalles, lee acerca de la especificación de dependencias.

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:

   pip 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ón de Google 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.

Más información: Para obtener más detalles, lee acerca de la implementación de funciones de Cloud Functions.

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ón de Google 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!".

   Nota: También puedes encontrar esta URL en la consola de Google Cloud. Ve a la página de descripción general de Cloud Functions y haz clic en el nombre de tu función para abrir la página de detalles de la función. Abre la pestaña ACTIVADOR para ver la URL de tu función.

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 la CLI de gcloud, 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ón de Google 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.

Nota: Puede haber una pequeña demora antes de que aparezcan las entradas de registro en Cloud Logging.

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 Functions, haz clic en el nombre de tu función en la lista y, luego, en la pestaña Registros.

Más información: Para obtener más detalles, lee Escribe, visualiza y responde registros.