Cómo configurar Stackdriver Trace para Ruby

Se puede habilitar Stackdriver Trace para aplicaciones Ruby mediante la biblioteca de Stackdriver Trace para Ruby.

Cómo instalar la biblioteca

  1. Instala Ruby 2.2+ o superior.

  2. Agrega la gema de Stackdriver a tu Gemfile:

    gem "stackdriver"
  3. Usa bundler para instalar la gema:

    bundle install
    

Cómo habilitar la biblioteca

Rails

Si usas Ruby on Rails, bundler carga automáticamente la biblioteca a tu aplicación cuando se inicia.

Sin Rails

Otras aplicaciones basadas en Rack pueden usar el middleware de Rack que proporciona la biblioteca:

require "google/cloud/trace"

use Google::Cloud::Trace::Middleware

Con el fin de obtener más información o para informar problemas con la biblioteca, consulta el repositorio del código fuente de la biblioteca.

Cómo configurar el cliente

Puedes personalizar el comportamiento de la biblioteca de Stackdriver Trace para Ruby. Consulta la configuración de la biblioteca para obtener una lista de las posibles opciones de configuración.

Cómo agregar un intervalo de seguimiento personalizado

La biblioteca de Stackdriver Trace para Ruby crea automáticamente un registro de seguimiento para cada una de las solicitudes que recibe la aplicación de Rack. También puedes agregar intervalos de seguimiento personalizado en cada solicitud:

Google::Cloud::Trace.in_span "my_task" do |span|
  # Insert task

  Google::Cloud::Trace.in_span "my_subtask" do |subspan|
    # Insert subtask
  end
end

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 manera predeterminada, y la biblioteca de Stackdriver Trace para Ruby se puede usar sin proporcionar credenciales o un ID del proyecto.

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 manera predeterminada, y la biblioteca de Stackdriver Trace para Ruby 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 usar la interfaz de configuración de Ruby on Rails

Si estás usando el marco de trabajo de Ruby on Rails, proporciona los parámetros mediante la interfaz de configuración de Ruby on Rails:

# Add this to config/environments/*.rb
Rails.application.configure do |config|
  # Stackdriver Trace specific parameters
  config.google_cloud.trace.project_id = "YOUR-PROJECT-ID"
  config.google_cloud.trace.keyfile    = "/path/to/service-account.json"
end

También puedes establecer la configuración compartida para todas las gemas de Stackdriver mediante el siguiente código:

# Add this to config/environments/*.rb
Rails.application.configure do |config|
  # Stackdriver Shared parameters
  config.google_cloud.project_id = "YOUR-PROJECT-ID"
  config.google_cloud.keyfile    = "/path/to/service-account.json"
end

Trace está habilitado de manera predeterminada cuando Rails se ejecuta en modo de producción. Para habilitar Trace en el modo de desarrollo, agrega lo siguiente:

# Add this to config/environments/development.rb
Rails.application.configure do |config|
  config.google_cloud.use_trace = true
end

Cómo usar la interfaz de configuración de instrumentación

Cuando se use en otras aplicaciones basadas en Rack, proporciona los parámetros a través de la interfaz de configuración:

require "google/cloud/trace"

Google::Cloud.configure do |config|
  # Stackdriver Trace specific parameters
  config.trace.project_id = "YOUR-PROJECT-ID"
  config.trace.keyfile    = "/path/to/service-account.json"
end

También puedes establecer la configuración compartida para todas las gemas de Stackdriver mediante el siguiente código:

require "stackdriver"

Google::Cloud.configure do |config|
  # Stackdriver Shared parameters
  config.project_id = "YOUR-PROJECT-ID"
  config.keyfile    = "/path/to/service-account.json"
end

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 sirvió esta página? Envíanos tu opinión:

Enviar comentarios sobre…

¿Necesitas ayuda? Visita nuestra página de asistencia.