Ruby 用 Error Reporting の設定

ベータ版です。

このプロダクトまたは機能はプレリリース版の状態であり、変更されたりサポートが制限されたりする可能性があります。詳細については、プロダクトのリリース ステージをご覧ください。

Ruby 用の Stackdriver Error Reporting ライブラリを使用して、Ruby アプリケーションから Stackdriver Error Reporting にエラーレポートを送信できます。

Error Reporting は、App Engine、Compute Engine、Google Kubernetes Engine などの一部の Google Cloud Platform プロダクトに統合されています。Error Reporting は、それらのプロダクトで実行中のアプリケーションによって Stackdriver Logging に記録されたエラーを表示します。詳細については、Google Cloud Platform での実行をご覧ください。

Stackdriver Logging を使用してエラーデータを Error Reporting に送信することもできます。データのフォーマット要件については、Stackdriver Logging でのエラー メッセージのフォーマットをご覧ください。

始める前に

1. Google アカウントにログインします。

   Google アカウントをまだお持ちでない場合は、新しいアカウントを登録します。

2. Google Cloud Platform プロジェクトを選択または作成します。

   注: このチュートリアルで作成するリソースをそのまま保持する予定でない場合、既存のプロジェクトを選択するのではなく、新しいプロジェクトを作成してください。チュートリアルの完了後にそのプロジェクトを削除すれば、プロジェクトとチュートリアルに関連するすべてのリソースを削除できます。

   [リソースの管理] ページに移動

3. Google Cloud Platform プロジェクトに対して課金が有効になっていることを確認します。

   課金を有効にする方法について

4. Error Reporting API を有効にします。

   APIを有効にする

5. Ruby 2.2+ 以上をインストールします。

クライアント ライブラリのインストール

Ruby 用の Stackdriver Error Reporting ライブラリを使用すると、ほとんどの場所で動作している Ruby アプリケーションから報告されるエラーをモニタリングして表示できます。

1. Gemfile に Stackdriver gem を追加します。
   GitHub で表示 フィードバック

   gem "stackdriver"

2. Bundler を使用して gem をインストールします。

   bundle install

ライブラリの有効化

Ruby on Rails を使用している場合、Bundler は起動時に、ライブラリをアプリケーションに自動的に読み込みます。

他のラックベースのアプリケーションでは、ライブラリが提供するラック ミドルウェアを使用できます。

GitHub で表示 フィードバック

require "google/cloud/error_reporting"

use Google::Cloud::ErrorReporting::Middleware

インストールの詳細については、Ruby 用の Stackdriver Error Reporting ライブラリのドキュメントをご覧ください。問題追跡ツールを使用して問題を報告することもできます。

クライアント ライブラリの構成

Ruby 用の Stackdriver Error Reporting ライブラリの動作をカスタマイズできます。構成可能なオプションのリストについては、ライブラリの構成をご覧ください。

エラーの報告

ラックベースのフレームワークでのエラー報告

Ruby 用の Stackdriver Error Reporting ライブラリを使用すると、Ruby on Rails や Sinatra などの一般的なラックベースの Ruby ウェブ フレームワークに Stackdriver Error Reporting を簡単に統合できます。ライブラリを有効にすると、アプリケーションのラックスタックからキャプチャされた例外が自動的に報告されます。

手動でのエラー報告

次の例に示すように、report メソッドを呼び出すと、手動でエラーを報告できます。

GitHub で表示 フィードバック

require "google/cloud/error_reporting"

begin
  raise "Raise an exception for Error Reporting."
rescue StandardError => exception
  Google::Cloud::ErrorReporting.report exception
end

Google Cloud Platform での実行

Ruby 用 Stackdriver Error Reporting ライブラリを使用するには、Cloud IAM Error Reporting 書き込み役割が必要です。ほとんどの Google Cloud Platform コンピューティング プラットフォームでは、デフォルトでこの役割が提供されています。

App Engine フレキシブル環境

App Engine は、デフォルトで Error Reporting 書き込み役割を付与します。

Ruby 用の Stackdriver Error Reporting ライブラリは、明示的に認証情報を提示しなくても使用できます。

App Engine のフレキシブル環境のアプリケーションでは、Error Reporting が自動的に有効になります。特別な設定は必要ありません。

注: stderr に書き込まれたエラーログは、Ruby 用 Stackdriver Error Reporting ライブラリを直接使用しなくても、Error Reporting によって自動的に処理されます。

GKE

GKE では、次のコマンド例に示すように、クラスタの作成時に cloud-platform アクセス スコープを追加する必要があります。

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

Compute Engine

Compute Engine VM インスタンスを使用する場合は、各インスタンスに cloud-platform アクセス スコープを追加します。Google Cloud Platform Console で新しいインスタンスを作成する場合は、[インスタンスの作成] パネルの [ID と API へのアクセス] セクションで行うことができます。Compute Engine のデフォルト サービス アカウントや別のサービス アカウントを使用して、[ID と API へのアクセス] セクションの [すべての Cloud API に完全アクセス権を許可] を選択します。どのサービス アカウントを選択する場合でも、GCP Console の [IAM と管理] セクションで、そのアカウントに Error Reporting 書き込み役割が付与されていることを確認してください。

ローカルとその他の場所での実行

Google Cloud Platform の外部で Ruby 用の Stackdriver Error Reporting ライブラリを使用するには、GCP プロジェクト ID と該当するサービス アカウント認証情報を Ruby 用の Stackdriver Error Reporting ライブラリに直接指定する必要があります。これは、自分のワークステーション、データセンターのコンピュータ、または別のクラウド プロバイダの VM インスタンスでライブラリを実行する場合に適用されます。詳しくは、サービス アカウント認証情報の手動による取得と提供をご覧ください。

Ruby on Rails 構成インターフェースの使用

Ruby on Rails フレームワークで Ruby 用の Stackdriver Error Reporting ライブラリを使用するには、Ruby on Rails 構成インターフェースを介してパラメータを指定します。

GitHub で表示 フィードバック

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

次のコマンドを使用して、すべての Stackdriver gem の共有構成を設定することもできます。

GitHub で表示 フィードバック

# 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

Rails を本番環境で実行すると、デフォルトで Error Reporting が有効になります。開発モードで Error Reporting を有効にするには、次のコードを追加します。

GitHub で表示 フィードバック

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

インストゥルメンテーション構成インターフェースの使用

他のラックベース アプリケーションで Ruby 用の Stackdriver Error Reporting ライブラリを使用するには、定インターフェースを介してパラメータを指定します。

GitHub で表示 フィードバック

require "google/cloud/error_reporting"

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

次のコマンドを使用して、すべての Stackdriver gem の共有構成を設定することもできます。

GitHub で表示 フィードバック

require "stackdriver"

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

エラーレポートの表示

デプロイ後は、GCP Console の Error Reporting ダッシュボードでエラーレポートを表示できます。

Error Reporting ダッシュボードに移動

詳細については、エラーの表示をご覧ください。