Configuración de Stackdriver Trace para PHP

Stackdriver Trace se puede habilitar en las aplicaciones de PHP mediante las bibliotecas de Stackdriver Trace y OpenCensus para PHP.

Cómo instalar la biblioteca

Instala el paquete del compositor del exportador de Stackdriver para OpenCensus con el siguiente comando (también se instalarán los paquetes del compositor de OpenCensus y Trace):

composer require opencensus/opencensus-exporter-stackdriver

Recomendamos que instales la extensión de OpenCensus con el siguiente comando:

pecl install opencensus-alpha

Además, debes agregar la siguiente línea a php.ini:

extension=opencensus.so

Si utilizas Windows, descarga el archivo DLL desde la página de descarga de pecl al directorio de extensión de tu instalación de PHP y agrega la siguiente línea a php.ini:

extension=opencensus.dll

Debes instalar la extensión de OpenCensus si quieres usar las integraciones de marco de trabajo que se describen a continuación.

Cómo habilitar la biblioteca

A fin de habilitar la biblioteca de Stackdriver Trace para PHP, completa los siguientes pasos:

  1. Importa las clases .

    use OpenCensus\Trace\Exporter\StackdriverExporter;
    use OpenCensus\Trace\Tracer;
    

  2. Inicializa el exportador .

    $exporter = new StackdriverExporter([
        'clientConfig' => [
            'projectId' => $projectId
        ]
    ]);

  3. Inicia el rastreador .

    Tracer::start($exporter);

Coloca el código en la parte superior de la secuencia de comandos para obtener el mejor resultado.

Cómo configurar el cliente

Puedes personalizar el comportamiento de la biblioteca de Stackdriver Trace para PHP. Consulta la configuración del exportador y la configuración del rastreador para obtener una lista de las opciones posibles.

Cómo agregar un intervalo de seguimiento personalizado

La biblioteca de Stackdriver Trace en PHP crea automáticamente un registro de seguimiento para cada solicitud HTTP. También puedes agregar intervalos de seguimiento personalizados dentro de la solicitud:

Tracer::inSpan(
    ['name' => 'slow_function'],
    function () {
        sleep(1);
    }
);

Integraciones de marco de trabajo

La biblioteca de OpenCensus proporciona integraciones útiles para marcos de trabajo web y funciones. Consulta las integraciones disponibles y los ejemplos de algunos marcos de trabajo para obtener más detalles.

Ejecución en Google Cloud Platform

No es necesario que proporciones credenciales de autenticación para las instancias que se ejecutan en Google Cloud Platform, siempre y cuando el nivel de acceso a la API de Stackdriver Trace esté habilitado en esa instancia. Sin embargo, recomendamos establecer el nivel de acceso más amplio posible para la instancia y, luego, usar Cloud Identity and Access Management a fin de restringir el acceso.

Entorno flexible de App Engine

En el entorno flexible de App Engine, el nivel de acceso a la API de Stackdriver Trace está habilitado de forma predeterminada, y la biblioteca cliente de OpenCensus se puede usar sin proporcionar credenciales o un ID del proyecto.

El entorno flexible de App Engine proporciona una optimización de rendimiento para informar los datos de seguimiento en un proceso en segundo plano. Utiliza la opción async cuando inicialices el exportador de Stackdriver y usa enable_stackdriver_integration en la sección runtime_config en tu archivo app.yaml como se muestra a continuación:

enable_stackdriver_integration: true

Consulta la configuración del exportador.

Entorno estándar de App Engine

En el entorno estándar de App Engine, el nivel de acceso a la API de Stackdriver Trace está habilitado de forma predeterminada, y la biblioteca cliente de OpenCensus se puede usar sin proporcionar credenciales o un ID del proyecto.

GKE

En GKE, agrega el nivel de acceso de OAuth trace.append cuando crees el clúster:

gcloud container clusters create example-cluster-name --scopes https://www.googleapis.com/auth/trace.append

No puedes cambiar los niveles de acceso del clúster una vez creado.

Compute Engine

Para las instancias de VM de Compute Engine, debes habilitar explícitamente el nivel de acceso a la API de Stackdriver Trace trace.append para cada instancia de VM. Cuando crees una instancia nueva con Google Cloud Platform Console, selecciona los siguientes valores en la sección Identidad y acceso a la API en el panel Crear una instancia:

  1. Selecciona Cuenta de servicio predeterminada de Compute Engine para Cuenta de servicio.
  2. Selecciona Permitir el acceso total a todas las API de Cloud para Niveles de servicio.

Para usar una cuenta que no sea la cuenta de servicio predeterminada de Compute Engine, consulta las secciones Cómo crear y habilitar cuentas de servicio para instancias y Cómo ejecutar de manera local y en otro lugar. Lo importante es que la cuenta de servicio que uses tenga la función de Agente de Cloud Trace.

Cómo ejecutar de manera local y en otro lugar

Para ejecutar Trace fuera de GCP, debes proporcionar tu ID del proyecto de GCP y las credenciales de la cuenta de servicio correspondiente directamente en Trace. Esto se aplica a la ejecución de la biblioteca en tu propia estación de trabajo, en las computadoras de tu centro de datos o en las instancias de VM de otro proveedor de servicios en la nube. A continuación, se detallan los pasos:

  1. Crea una cuenta de servicio nueva en tu proyecto de GCP. Debe tener al menos la función de Agente de Cloud Trace. Para obtener más instrucciones, consulta Cómo crear una cuenta de servicio.

  2. Descarga el archivo de credenciales de la clave de la cuenta de servicio a tu computadora. Para obtener más instrucciones, consulta Cómo crear y administrar claves de cuentas de servicio.

  3. Proporciona tu ID del proyecto de GCP y la ubicación del archivo de credenciales a Trace con los parámetros (project_id y keyfile) o variables de entorno (GOOGLE_CLOUD_PROJECT y GOOGLE_APPLICATION_CREDENTIALS).

Cómo usar las variables de entorno

Define las variables de entorno de forma que estén visibles para Trace. Si están visibles de forma más amplia, podrían interferir en las autorizaciones existentes para otras aplicaciones.

Linux/macOS

export GOOGLE_CLOUD_PROJECT=your-project-id
export GOOGLE_APPLICATION_CREDENTIALS=/path/to/key.json

Windows

Ventana de comando:

set GOOGLE_CLOUD_PROJECT=your-project-id
set GOOGLE_APPLICATION_CREDENTIALS=/path/to/key.json

PowerShell:

$env:GOOGLE_CLOUD_PROJECT="your-project-id"
$env:GOOGLE_APPLICATION_CREDENTIALS="/path/to/key.json"

Cómo ver los seguimientos

Después de la implementación, puedes ver los seguimientos en el lector de seguimiento de GCP Console.

Ir a la página del Lector de seguimiento

¿Te ha resultado útil esta página? Enviar comentarios:

Enviar comentarios sobre...

Si necesitas ayuda, visita nuestra página de asistencia.