Cómo configurar Cloud Logging para Ruby

Puedes escribir registros en Cloud Logging desde las aplicaciones de Ruby con la biblioteca de Cloud Logging para Ruby o directamente con la biblioteca cliente de Cloud de Cloud Logging para Ruby.

No es necesario instalar el agente de Cloud Logging a fin de usar la biblioteca de Cloud Logging para Ruby en una instancia de VM de Compute Engine.

Antes de comenzar

  1. Accede a tu Cuenta de Google.

    Si todavía no tienes una cuenta, regístrate para obtener una nueva.

  2. En la página del selector de proyectos de Google Cloud Console, selecciona o crea un proyecto de Google Cloud.

    Ir a la página del 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 Cloud Logging API.

    Habilita la API

  5. Instala Ruby 2.2+ o una versión superior.

Instala la biblioteca

Proporcionamos una biblioteca de Cloud Logging para Ruby, que proporciona una implementación del registrador fácil de usar para los frameworks web de Ruby basados en Rack:

  1. Agrega la gema del paquete de operaciones de Google Cloud a tu Gemfile:

    gem "stackdriver"
  2. Usa Bundler para instalar la gema:

    bundle install
    

Habilita la biblioteca

Si usas Ruby on Rails, Bundler carga la biblioteca automáticamente en tu aplicación cuando se inicia, lo que establece el valor Rails.logger predeterminado en una instancia de registrador de Cloud Logging.

Otras aplicaciones basadas en Rack pueden usar el middleware de Rack para reemplazar el registrador de Rack con el registrador de Cloud Logging si tu framework web es compatible con el registrador de Rack:

require "google/cloud/logging"

use Google::Cloud::Logging::Middleware

Configura la biblioteca

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

Usa el registrador de Cloud Logging

Una vez que esté habilitada la biblioteca de Cloud Logging para Ruby, puedes usar el registrador en tu aplicación:

logger.info "Hello World!"
logger.error "Oh No!"

Para obtener más información sobre la instalación, consulta la documentación de la biblioteca de Cloud Logging para Ruby. También puedes informar problemas con la Herramienta de seguimiento de errores.

Usa la biblioteca cliente de Cloud directamente

Para obtener información sobre el uso directo de la biblioteca cliente de Cloud Logging para Ruby, consulta Bibliotecas cliente de Cloud Logging.

Ejecuta en Google Cloud

Usar la biblioteca de Cloud Logging para Ruby requiere la función de escritor de registros IAM en Google Cloud. La mayoría de los entornos de Google Cloud proporcionan esta función de forma predeterminada.

App Engine

App Engine otorga la función de escritor de registros de forma predeterminada.

Se puede usar la biblioteca de Cloud Logging para Ruby sin necesidad de proporcionar credenciales de forma explícita.

Cloud Logging se habilita automáticamente para las aplicaciones de App Engine. No se requiere ninguna configuración adicional.

Google Kubernetes Engine

En Google Kubernetes Engine, debes agregar el permiso de acceso logging.write cuando creas el clúster:

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

Compute Engine

Cuando uses las instancias de VM de Compute Engine, agrega el permiso de acceso cloud-platform a cada instancia. Si creas una instancia nueva a través de Google Cloud Console, puedes hacerlo en la sección Identidad y acceso a la API del panel Crear Instancia. Usa la cuenta de servicio predeterminada de Compute Engine o una cuenta de servicio diferente y selecciona Permitir acceso total a las API de Cloud en la sección Identidad y acceso a la API. Asegúrate de que la cuenta de servicio que selecciones tenga la función de escritor de registros en la sección IAM y administración de Cloud Console.

Ejecuta de forma local y en otros lugares

Si deseas usar la biblioteca de Cloud Logging para Ruby fuera de Google Cloud, incluida su ejecución 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, debes proporcionar el ID de tu proyecto de Google Cloud y las credenciales de la cuenta de servicio adecuada directamente a la biblioteca de Cloud Logging para Ruby.

Puedes crear y obtener credenciales de cuentas de servicio de forma manual. Cuando especifiques el campo Función, usa la función escritor de registros. Para obtener más información sobre las funciones de la administración de identidades y accesos, consulta la Guía de control de acceso.

Usa la interfaz de configuración de Ruby on Rails:

Si usas el marco de trabajo de Ruby on Rails, proporciona los parámetros mediante su interfaz de configuración:

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

También puedes configurar la configuración compartida para todas las gemas de conjuntos de operaciones de Google Cloud mediante:

# 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

Logging se habilita de forma predeterminada cuando Rails se ejecuta en el modo de producción. Para habilitar Logging en el modo de desarrollo, agrega lo siguiente:

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

Usa 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/logging"

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

También puedes configurar la configuración compartida para todas las gemas de conjuntos de operaciones de Google Cloud mediante:

require "stackdriver"

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

Ve los registros

Después de la implementación, puedes ver los registros en el visor de registros.

Ir al Explorador de registros

En el Explorador de registros, debes especificar uno o más recursos, aunque la selección de recursos puede no ser obvia. Aquí encontrarás algunas sugerencias que te ayudarán a comenzar:

  • Si implementas tu aplicación en App Engine o utilizas las bibliotecas específicas de App Engine, configura tu recurso como Aplicación de GAE.

  • Si implementas tu aplicación en Compute Engine, configura el recurso como Instancia de VM de GCE.

  • Si implementas tu aplicación en Google Kubernetes Engine, la configuración de registro de tu clúster determina el tipo de recurso de las entradas de registro. Para obtener información detallada sobre Google Cloud's operations suite heredado, las soluciones de Kubernetes Monitoring de Google Cloud's operations suite, y cómo estas dos opciones afectan el tipo de recurso, consulta Migra a Kubernetes Monitoring de Google Cloud's operations suite.

  • Si la aplicación usa la API de Cloud Logging directamente, el recurso depende de la API y de tu configuración. Por ejemplo, en la aplicación, puedes especificar un recurso o usar un recurso predeterminado.

  • Si no ves ningún registro en el Explorador de registros, cambia al modo de consulta avanzada y usa una consulta vacía para ver todas las entradas de registro.

    1. Para cambiar al modo de consulta avanzada, haz clic en menú (▾) en la parte superior del Explorador de registros y selecciona Convertir a filtro avanzado.
    2. Borra el contenido que aparece en el cuadro de filtro.
    3. Haz clic en Enviar filtro.

    Puedes examinar las entradas individuales para identificar tus recursos.

Para obtener más información, consulta Visualiza los registros y Consultas de registros avanzadas.