Configura Cloud Trace para Ruby

Puedes habilitar Cloud Trace para aplicaciones de Ruby con la biblioteca de Cloud Trace para Ruby.

Instala 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 Cloud Trace para Ruby. Consulta la configuración de la biblioteca para obtener una lista de las posibles opciones de configuración.

Agrega un intervalo de seguimiento personalizado

La biblioteca de Cloud Trace para Ruby crea automáticamente un registro de seguimiento para cada solicitud que recibe tu 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

Configura tu plataforma

Puedes usar Cloud Trace en Google Cloud y otras plataformas.

Ejecuta en Google Cloud

Cuando tu aplicación se ejecuta en Google Cloud, no necesitas proporcionar credenciales de autenticación en forma de una cuenta de servicio a la biblioteca cliente. Sin embargo, debes asegurarte de que tu Google Cloud Platform tenga habilitado el nivel de acceso a la API de Cloud Trace.

Para las siguientes opciones de configuración, la configuración predeterminada del permiso de acceso habilita la API de Cloud Trace:

  • Entorno flexible de App Engine
  • Entorno estándar de App Engine

  • Google Kubernetes Engine (GKE)

  • Compute Engine

Si usas niveles de acceso personalizados, debes asegurarte de que el nivel de acceso a la API de Cloud Trace esté habilitado. Para los usuarios gcloud, especifica los niveles de acceso con la marca --scopes y, además, incluye el nivel de acceso trace.append de la API de Cloud Trace. Por ejemplo, para crear un clúster de GKE con solo la API de Cloud Trace habilitada, haz lo siguiente:

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

Ejecuta de forma local y en otros lugares

Si tu aplicación se ejecuta fuera de Google Cloud, debes proporcionar credenciales de autenticación con el formato de una cuenta de servicio a la biblioteca cliente. La cuenta de servicio debe contener la función de agente de Cloud Trace. Para obtener más instrucciones, consulta Cómo crear una cuenta de servicio.

Las bibliotecas cliente de Google Cloud para Ruby usan las credenciales predeterminadas de la aplicación (ADC) para encontrar las credenciales de tu aplicación. En la siguiente sección, se describe cómo configurar estas credenciales y el ID del proyecto de Google Cloud.

Configura el ID y las credenciales del proyecto de Google Cloud

En esta sección, se describen tres enfoques diferentes que puedes usar para establecer el ID del proyecto de Google Cloud, las credenciales de autenticación o ambas en tu aplicación de Ruby.

Variable de entorno

Cuando no estableces el ID del proyecto de Google Cloud de forma explícita, la biblioteca de Ruby google-cloud determina automáticamente si se configuró la variable de entorno GOOGLE_CLOUD_PROJECT. Si es así, la biblioteca usa la de GOOGLE_CLOUD_PROJECT como tu ID del proyecto de Google Cloud. Para obtener más información, ve a Autenticación.

Como se describió anteriormente, las bibliotecas cliente de Google Cloud usan credenciales predeterminadas de la aplicación (ADC) para encontrar las credenciales de tu aplicación. Puedes proporcionar estas credenciales si configuras la variable de entorno GOOGLE_APPLICATION_CREDENTIALS:

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"

Interfaz de configuración de Ruby on Rails

Si usas Ruby on Rails, una alternativa para Ruby es proporcionar los parámetros a través de la interfaz de configuración:

# 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 con lo siguiente:

# 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

Interfaz de configuración de instrumentación

Otra alternativa para Ruby es proporcionar los parámetros a través de la interfaz de configuración cuando se usan en otras aplicaciones basadas en Rack:

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 visor de seguimientos de Cloud Console.

Ir a la página del Lector de seguimiento

Soluciona problemas

Para obtener información sobre la solución de problemas con Cloud Trace, consulta la página de solución de problemas.

Recursos