Crea e implementa una Cloud Function de HTTP con Ruby

Crea e implementa una Cloud Function de HTTP con Ruby

En esta guía, se explica el proceso de escribir una función de Cloud Functions con el entorno de ejecución de Ruby. 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.

    Ir al selector de proyectos

  3. Comprueba que la facturación esté habilitada en tu proyecto.

    Descubre cómo puedes habilitar la facturación

  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.

    Ir al selector de proyectos

  6. Comprueba que la facturación esté habilitada en tu proyecto.

    Descubre cómo puedes habilitar la facturación

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

    Habilita las API

  8. Instala y luego inicializa el SDK de Google Cloud.
  9. Instala y actualiza los componentes de gcloud con el siguiente comando.
    gcloud components update
  10. Prepara tu entorno de desarrollo.

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

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 app.rb en el directorio helloworld con el siguiente contenido:

    require "functions_framework"
    require "cgi"
    require "json"
    
    FunctionsFramework.http "hello_http" do |request|
      # The request parameter is a Rack::Request object.
      # See https://www.rubydoc.info/gems/rack/Rack/Request
      name = request.params["name"] ||
             (request.body.rewind && JSON.parse(request.body.read)["name"] rescue nil) ||
             "World"
      # Return the response body as a string.
      # You can also return a Rack::Response object, a Rack response array, or
      # a hash which will be JSON-encoded into a response.
      "Hello #{CGI.escape_html name}!"
    end

    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 Ruby se administran con bundler y se expresan en un archivo llamado Gemfile.

Cuando implementas tu función, Cloud Functions descarga y luego instala las dependencias declaradas en Gemfile y Gemfile.lock con bundler.

El Gemfile enumera los paquetes que requiere tu función, junto con las restricciones de las versiones opcionales. Para una Cloud Function, uno de estos paquetes debe ser la gema functions_framework.

Para este ejercicio, crea un archivo llamado Gemfile en el mismo directorio que el archivo app.rb que contiene el código de tu función, con el siguiente contenido:

source "https://rubygems.org"
gem "functions_framework", "~> 0.7"

Ejecuta el siguiente comando para instalar la gema functions_framework y otras dependencias:

bundle install

Compila y prueba la función de forma local

Antes de implementar la función, puedes compilarla y probarla de forma local.

  1. Ejecuta el siguiente comando para usar el ejecutable functions-framework-ruby para iniciar un servidor web local que ejecute tu función hello_http:

    bundle exec functions-framework-ruby --target hello_http
    
  2. 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.

Consulta también Testing Functions en la documentación Functions Framework de Ruby.

Implementa tu función

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

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

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 ruby-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!".

Visualiza los registros de tu función

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

Visualiza registros con la herramienta de línea de comandos

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 \
      ruby-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 00:09:41.477
LOG: Default STARTUP TCP probe succeeded after 1 attempt for container "hello__http-1" on port 8080.

LEVEL:
NAME: hello-http
TIME_UTC: 2023-06-01 00:09:41.451
LOG: I, [2023-06-01T00:09:41.451784 #1]  INFO -- : FunctionsFramework: Serving function "hello_http" on port 8080...

LEVEL:
NAME: hello-http
TIME_UTC: 2023-06-01 00:09:41.364
LOG: I, [2023-06-01T00:09:41.363923 #1]  INFO -- : FunctionsFramework: Starting server...

LEVEL:
NAME: hello-http
TIME_UTC: 2023-06-01 00:09:41.363
LOG: I, [2023-06-01T00:09:41.363855 #1]  INFO -- : FunctionsFramework: Looking for function name "hello_http"...

LEVEL:
NAME: hello-http
TIME_UTC: 2023-06-01 00:09:41.354
LOG: I, [2023-06-01T00:09:41.354150 #1]  INFO -- : FunctionsFramework: Loading functions from "./app.rb"...

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.