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

Nota: Este contenido se aplica solo a las funciones de Cloud Run, antes Cloud Functions (2nd gen).

Para obtener la versión de 1ª gen. de este documento, consulta Crea e implementa una función de HTTP de Cloud Run Functions con PHP (1ª gen.).

En esta guía, se explica el proceso para escribir una función de Cloud Run con el entorno de ejecución de PHP y, luego, probar e implementar la función HTTP.

Puedes crear dos tipos de Cloud Run Functions:

• Una función de HTTP que se invoca a partir de solicitudes HTTP estándar.
• La otra es una función controlada por eventos que se usa para manejar los eventos de la infraestructura de tu 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.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the 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. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the 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. 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 los componentes de gcloud con el siguiente comando.

   gcloud components update

10. Prepara tu entorno de desarrollo.

    Ir a Usa PHP en Google Cloud

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_http
   cd ~/helloworld_http
   

   Windows

   mkdir %HOMEPATH%\helloworld_http
   cd %HOMEPATH%\helloworld_http
   

2. Crea un archivo index.php en el directorio helloworld_http con el siguiente contenido:

   <?php
   
   use Google\CloudFunctions\FunctionsFramework;
   use Psr\Http\Message\ServerRequestInterface;
   
   // Register the function with Functions Framework.
   // This enables omitting the `FUNCTIONS_SIGNATURE_TYPE=http` environment
   // variable when deploying. The `FUNCTION_TARGET` environment variable should
   // match the first parameter.
   FunctionsFramework::http('helloHttp', 'helloHttp');
   
   function helloHttp(ServerRequestInterface $request): string
   {
       $name = 'World';
       $body = $request->getBody()->getContents();
       if (!empty($body)) {
           $json = json_decode($body, true);
           if (json_last_error() != JSON_ERROR_NONE) {
               throw new RuntimeException(sprintf(
                   'Could not parse body: %s',
                   json_last_error_msg()
               ));
           }
           $name = $json['name'] ?? $name;
       }
       $queryString = $request->getQueryParams();
       $name = $queryString['name'] ?? $name;
   
       return sprintf('Hello, %s!', htmlspecialchars($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. Para obtener más información sobre la estructura y los elementos obligatorios en una función de HTTP de PHP, consulta Escribe funciones de HTTP.

Especificar dependencias

1. PHP usa Composer para administrar dependencias. Si usas Cloud Shell, Composer está preinstalado. De lo contrario, sigue las instrucciones de instalación de Composer.

2. Especifica las dependencias de tu función:

   1. Agrega un archivo composer.json con el siguiente contenido al directorio helloworld_http:

      {
          "require": {
              "php": ">= 8.1",
              "google/cloud-functions-framework": "^1.1"
          },
          "scripts": {
              "start": [
                 "Composer\\Config::disableProcessTimeout",
                 "FUNCTION_TARGET=helloHttp php -S localhost:${PORT:-8080} vendor/google/cloud-functions-framework/router.php"
              ]
          }
      }
      

   La línea FUNCTION_TARGET especifica el punto de entrada de tu función.

   1. Ejecuta el siguiente comando en el directorio helloworld_http:

   composer require google/cloud-functions-framework
   

   De esta forma se agrega Functions Framework a tu composer.json y se crea un directorio vendor dentro de helloworld_http que contiene las dependencias.

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, sigue estos pasos:

1. Crea un servidor web local que ejecute tu función helloHttp:

   export FUNCTION_TARGET=helloHttp
   composer start
   

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.

Esta función de muestra da el mensaje de saludo"Hello, World!" .

Implemente su función

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

  gcloud functions deploy php-http-function \
    --gen2 \
    --runtime=php83 \
    --region=REGION \
    --source=. \
    --entry-point=helloHttp \
    --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 Run 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 php-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 que dice "Hello World!".

   Nota: También puedes encontrar esta URL en la consola de Google Cloud. Ve a la página Descripción general de Cloud Run Functions y haz clic en el nombre de tu función para abrir la página 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 gcloud CLI, usa el comando logs read:

    gcloud functions logs read \
      --gen2 \
      --limit=10 \
      --region=REGION \
      php-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: hellohttp
TIME_UTC: 2023-06-02 19:01:36.067
LOG:

LEVEL: I
NAME: hellohttp
TIME_UTC: 2023-06-02 19:01:22.814
LOG: Default STARTUP TCP probe succeeded after 1 attempt for container "hello_http-1" on port 8080.

LEVEL: I
NAME: hellohttp
TIME_UTC: 2023-06-02 19:01:22.777
LOG: [pid1-nginx] Starting nginx (pid 17): /usr/sbin/nginx -c /tmp/nginxconf-953701689/nginx.conf [session:R8F8ZJ5]

LEVEL: I
NAME: hellohttp
TIME_UTC: 2023-06-02 19:01:22.766
LOG: [pid1-nginx] Successfully connected to /tmp/google-config/app.sock after 556.430499ms [session:R8F8ZJ5]

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 Run 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, lea acerca de cómo escribir, visualizar y responder a los registros.