Setting Up Stackdriver Logging for Ruby

You can write logs to Stackdriver Logging from Ruby applications by using the Stackdriver Logging library for Ruby, or by using the Stackdriver Logging Cloud client library for Ruby directly.

The Stackdriver Logging agent does not have to be installed to use the Stackdriver Logging library for Ruby on a Compute Engine VM instance.

Before you begin

  1. Sign in to your Google Account.

    If you don't already have one, sign up for a new account.

  2. Select or create a GCP project.

    Go to the Manage resources page

  3. Make sure that billing is enabled for your project.

    Learn how to enable billing

  4. Enable the Stackdriver Logging API.

    Enable the API

  5. Install Ruby 2.2+ or greater.

Installing the library

We provide a Stackdriver Logging library for Ruby, which provides an easy-to-use logger implementation for Rack-based Ruby web frameworks:

  1. Add the Stackdriver gem to your Gemfile:

    gem "stackdriver"

  2. Use Bundler to install the gem:

    bundle install
    

Enabling the library

If you're using Ruby on Rails, Bundler automatically loads the library into your application when it starts, which sets the default Rails.logger to an instance of Stackdriver Logging logger.

Other Rack-based applications can use the Rack Middleware to replace the Rack logger with the Stackdriver Logging logger if your web framework supports Rack logger:

require "google/cloud/logging"

use Google::Cloud::Logging::Middleware

Configuring the library

You can customize the behavior of the Stackdriver Logging library for Ruby. See the library's configuration for a list of possible configuration options.

Using the Stackdriver Logging Logger

Once the Stackdriver Logging library for Ruby is enabled, you can use the logger in your application:

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

For more information on installation, see the documentation for the Stackdriver Logging library for Ruby. You can also report issues using the issue tracker.

Using the Cloud Client Library directly

For information on using the Stackdriver Logging Cloud client library for Ruby directly, see Stackdriver Logging Client Libraries.

Running on Google Cloud Platform

Using Stackdriver Logging library for Ruby requires the Cloud IAM Logs Writer role on Google Cloud Platform. Most Google Cloud Platform environments provide this role by default.

App Engine

Google App Engine grants the Logs Writer role by default.

The Stackdriver Logging library for Ruby can be used without needing to explicitly provide credentials.

Stackdriver Logging is automatically enabled for App Engine applications. No additional setup is required.

Kubernetes Engine

On Google Kubernetes Engine, you must add the logging.write access scope when creating the cluster:

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

Compute Engine

When using Google Compute Engine VM instances, add the cloud-platform access scope to each instance. When creating a new instance through the Google Cloud Platform Console, you can do this in the Identity and API access section of the Create Instance panel. Use the Compute Engine default service account or another service account of your choice, and select Allow full access to all Cloud APIs in the Identity and API access section. Whichever service account you select, ensure that it has been granted the Logs Writer role in the IAM & admin section of the GCP Console.

Running locally and elsewhere

To use the Stackdriver Logging library for Ruby outside of Google Cloud Platform, you must supply your GCP project ID and appropriate service account credentials directly to the Stackdriver Logging library for Ruby. This applies to running the agent on your own workstation, on your data center's computers, or on the VM instances of another cloud provider. For more information see Obtaining and providing service account credentials manually.

*Using Ruby on Rails configuration interface:

Provide the parameters through the Ruby on Rails configuration interface if you are using Ruby on Rails framework:

# 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

You can also set shared configuration for all Stackdriver gems using:

# 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

Using instrumentation configuration interface:

Provide the parameters through the configuration interface when used in other Rack-based applications:

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

You can also set shared configuration for all Stackdriver gems using:

require "stackdriver"

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

Viewing the logs

After deployment, you can view the logs in the GCP Console Logs Viewer.

Go to the Logs Viewer

For more information, see Viewing Logs.

Was this page helpful? Let us know how we did:

Send feedback about...

Stackdriver Logging