Error Reporting 用 Ruby アプリのインストルメント化

Ruby アプリケーションから Error Reporting にエラーレポートを送信するには、Ruby 用 Error Reporting ライブラリを使用します。 次の場合は、Ruby 用 Error Reporting ライブラリを使用してエラーグループを作成します。

  • ログエントリを含むログバケットに、顧客管理の暗号鍵(CMEK)がある。
  • ログバケットが次のいずれかを満たしている。
    • ログバケットがログエントリの元のプロジェクトに保存されている。
    • ログエントリがプロジェクトに転送され、そのプロジェクトがそれらのログエントリを、所有するログバケットに保存した。
  • カスタム エラーイベントを報告する必要がある。

Error Reporting は、Cloud Functions、App Engine、Compute Engine、Google Kubernetes Engine などの一部の Google Cloud サービスに統合されています。Error Reporting は、こうしたサービスで実行されるアプリケーションによって Cloud Logging に記録されたエラーを表示します。詳細については、このページの Google Cloud での実行をご覧ください。

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

始める前に

  1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

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

  4. Enable the Error Reporting API .

    Enable the API

    5.

  5. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  6. Make sure that billing is enabled for your Google Cloud project.

  7. Enable the Error Reporting API .

    Enable the API

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

クライアント ライブラリをインストールする

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

  1. Gemfile に google-cloud-error_reporting gem を追加します。

    gem "google-cloud-error_reporting"

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

    bundle install

ライブラリの有効化

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

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

require "google/cloud/error_reporting"

use Google::Cloud::ErrorReporting::Middleware

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

クライアント ライブラリを設定する

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

Google Cloud でアプリを実行する

projects.events.report を使用してエラーグループを作成するには、サービス アカウントに Error Reporting 書き込みロール（roles/errorreporting.writer）が必要です。

一部の Google Cloud サービスでは、Error Reporting 書き込みロール（roles/errorreporting.writer）が適切なサービス アカウントに自動的に付与されます。ただし、一部のサービスでは、適切なサービス アカウントにこのロールを付与する必要があります。

Cloud Run と Cloud Run functions

Cloud Run で使用されるデフォルトのサービス アカウントには、Error Reporting 書き込みロール（roles/errorreporting.writer）の権限があります。

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

Cloud Run は、Error Reporting を自動的に使用するように構成されています。JavaScript の未処理の例外は、Logging に表示され、Ruby 用 Error Reporting ライブラリを使用しなくても、Error Reporting によって処理されます。

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

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

# 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 の共有構成を設定することもできます。

# 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 を有効にするには、次のコードを追加します。

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

インストルメンテーション設定インタフェースの使用

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

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

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

require "stackdriver"

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

App Engine フレキシブル環境

App Engine では、デフォルトのサービス アカウントに Error Reporting 書き込みロール（roles/errorreporting.writer）が自動的に付与されます。

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

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

Google Kubernetes Engine

Google Kubernetes Engine で Error Reporting を使用するには、次の操作を行います。

  1. コンテナが使用するサービス アカウントに、Error Reporting 書き込みロール（roles/errorreporting.writer）が付与されていることを確認します。

    Compute Engine のデフォルトのサービス アカウントまたはカスタム サービス アカウントを使用できます。

    ロールの付与については、プロジェクト、フォルダ、組織へのアクセスを管理するをご覧ください。

  2. クラスタを作成し、クラスタに cloud-platform アクセス スコープを付与します。

    たとえば、次の作成コマンドは、cloud-platform アクセス スコープとサービス アカウントを指定します。

    gcloud container clusters create CLUSTER_NAME --service-account  SERVICE_ACCT_NAME --scopes=cloud-platform

Compute Engine

Compute Engine VM インスタンスで Error Reporting を使用する手順は次のとおりです。

  1. VM インスタンスが使用するサービス アカウントに、Error Reporting 書き込みロール（roles/errorreporting.writer）が付与されていることを確認します。

    Compute Engine のデフォルトのサービス アカウントまたはカスタム サービス アカウントを使用できます。

    ロールの付与については、プロジェクト、フォルダ、組織へのアクセスを管理するをご覧ください。

  2. Google Cloud コンソールで、[VM インスタンス] ページに移動します。

    [VM インスタンス] に移動

    検索バーを使用してこのページを検索する場合は、小見出しが [Compute Engine] である結果を選択します。

  3. cloud-platform アクセス スコープを適用する VM インスタンスを選択します。

  4. [停止]、[編集] の順にクリックします。

  5. [ID と API へのアクセス] セクションで、Error Reporting 書き込みロール（roles/errorreporting.writer）を持つサービス アカウントを選択します。

  6. [アクセス スコープ] セクションで、[すべての Cloud API に完全アクセス権を許可] を選択し、変更を保存します。

  7. [開始 / 再開] をクリックします。

例

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

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

手動でのエラー報告

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

require "google/cloud/error_reporting"

begin
  raise "Something went wrong"
rescue StandardError => e
  Google::Cloud::ErrorReporting.report e
end

ローカル開発環境でアプリを実行する

自分のワークステーションでライブラリを実行するなど、ローカル開発環境で Ruby 用 Error Reporting ライブラリを使用するには、ローカル アプリケーションのデフォルト認証情報を使用して、Ruby 用 Error Reporting ライブラリを指定する必要があります。詳細については、Error Reporting に対する認証をご覧ください。

ローカル開発環境でこのページの Ruby サンプルを使用するには、gcloud CLI をインストールして初期化し、ユーザー認証情報を使用してアプリケーションのデフォルト認証情報を設定します。

  1. Install the Google Cloud CLI.

  2. To initialize the gcloud CLI, run the following command: 

    gcloud init

  3. If you're using a local shell, then create local authentication credentials for your user account: 

    gcloud auth application-default login

    You don't need to do this if you're using Cloud Shell.

詳細については Set up authentication for a local development environment をご覧ください。

projects.events.report メソッドは API キーもサポートしています。 認証に API キーを使用する場合、ローカルのアプリケーションのデフォルト認証情報ファイルを設定する必要はありません。詳細については、 Google Cloud の認証に関するドキュメントの API キーを作成するをご覧ください。

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

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

# 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 の共有構成を設定することもできます。

# 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 を有効にするには、次のコードを追加します。

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

インストルメンテーション設定インタフェースの使用

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

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

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

require "stackdriver"

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

エラーレポートの表示

Google Cloud コンソールで、[Error Reporting] ページに移動します。

Error Reporting に移動

このページは、検索バーを使用して見つけることもできます。

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