Tu primera función: 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 función de HTTP que se invoca a partir de solicitudes HTTP estándar.
  • 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.

En el ejemplo, se muestra cómo crear una función de HTTP simple.

Estructura de la guía

  1. Crea un proyecto de GCP mediante el SDK de Cloud
  2. Crea una función
  3. Especifica dependencias
  4. Compila y prueba a nivel local
  5. Implementa la función
  6. Prueba la función implementada

Crea un proyecto de GCP con el SDK de Cloud

  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 Google Cloud Console, selecciona o crea un proyecto de Google Cloud.

    Ir al selector de proyectos

  3. Asegúrate de que la facturación esté habilitada para tu proyecto de Cloud. Descubre cómo confirmar que tienes habilitada la facturación en un proyecto.

  4. Habilita las API de Cloud Functions and Cloud Build.

    Habilita las API

  5. Instala e inicializa el SDK de Cloud.
  6. Instala y actualiza componentes de gcloud:
    gcloud components update
  7. Prepara tu entorno de desarrollo.

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

Crea una 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 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"] ||
             (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.

Especifica 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 a nivel local

Antes de implementar la función, puedes compilarla y probarla de forma local. Ejecuta el siguiente comando para usar el ejecutable functions-framework-ruby a fin de iniciar un servidor web local que ejecute tu función hello_http:

bundle exec functions-framework-ruby --target hello_http
# ...starts the web server in the foreground

Si la función se compila correctamente, mostrará la URL que puedes visitar en tu navegador web para ver la función en acción: http://localhost:8080/. Deberías ver un mensaje Hello World!.

Como alternativa, puedes enviar solicitudes a esta función mediante curl desde otra ventana de la terminal:

curl localhost:8080
# Output: Hello World!

Implementa la función

Ejecuta el siguiente comando en el directorio helloworld para implementar la función con un activador HTTP:

gcloud functions deploy hello_http --runtime ruby27 --trigger-http --allow-unauthenticated

La marca --allow-unauthenticated te permite acceder a la función sin autenticación. Omítela para exigir autenticación.

Prueba la función implementada

  1. Cuando la función termine de implementarse, toma nota de la propiedad httpsTrigger.url o búscala con el siguiente comando:

    gcloud functions describe hello_http
    

    Se verá de la siguiente manera:

    https://GCP_REGION-PROJECT_ID.cloudfunctions.net/hello_http
  2. Visita esta URL en tu navegador. Deberías ver el mensaje “Hello, World!”.

    Intenta pasar un nombre en la solicitud HTTP, por ejemplo, mediante la siguiente URL:

    https://GCP_REGION-PROJECT_ID.cloudfunctions.net/hello_http?name=NAME

    Deberías ver el mensaje “Hello, NAME!”

Ver registros

Usa la herramienta de línea de comandos

Los registros de Cloud Functions se pueden ver en la IU de Cloud Logging y mediante la herramienta de línea de comandos de gcloud.

Para visualizar los registros de tu función con la herramienta de gcloud, usa el comando logs read seguido del nombre de la función:

gcloud functions logs read hello_http

El resultado debe parecerse al siguiente:

LEVEL  NAME       EXECUTION_ID  TIME_UTC                 LOG
D      helloHttp  rvb9j0axfclb  2019-09-18 22:06:25.983  Function execution started
D      helloHttp  rvb9j0axfclb  2019-09-18 22:06:26.001  Function execution took 19 ms, finished with status code: 200

Usa el panel de Logging

También puedes ver los registros de Cloud Functions desde Cloud Console.