Error Reporting の Node.js アプリのインストルメント化

Node.js アプリケーションから Error Reporting にエラーレポートを送信するには、Node.js 用 Error Reporting ライブラリを使用します。 次の場合は、Node.js 用 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.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the 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. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the 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. Node.js 開発用の環境を準備します。

   Node.js 設定ガイドに移動

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

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

1. npm を使用してパッケージをインストールします。

   npm install --save @google-cloud/error-reporting

2. エラーの報告を開始するために、ライブラリをインポートしてクライアントをインスタンス化します。

   // Imports the Google Cloud client library
   const {ErrorReporting} = require('@google-cloud/error-reporting');
   
   // Instantiates a client
   const errors = new ErrorReporting();
   
   // Reports a simple error
   errors.report('Something broke!');

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

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

Node.js 用 Error Reporting ライブラリの動作をカスタマイズできます。構成可能なオプションのリストについては、ライブラリの構成をご覧ください。これらのオプションは、ライブラリのコンストラクタに渡される options オブジェクトに渡すことができます。

その他の統合

Node.js 用 Error Reporting ライブラリと他の Node.js ウェブ フレームワークの統合の詳細については、GitHub 上のライブラリのリポジトリをご覧ください。

Google Cloud でアプリを実行する

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

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

App Engine フレキシブル環境

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

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

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

注: stderr に書き込まれたエラー・ログエントリは、Node.js 用 Error Reporting ライブラリを直接使用しなくても、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. [開始 / 再開] をクリックします。

Cloud Functions

Cloud Run 関数は、Error Reporting 書き込みロール（roles/errorreporting.writer）をデフォルトのサービス アカウントに自動的に付与します。

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

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

注: ログエントリにスタック トレースが含まれていて、かつログの重大度が指定されていないか ERROR 以上のログの重大度が指定されている場合は、Node.js 用 Error Reporting ライブラリを使用しなくても、そのログエントリは自動的に処理されます。

例:

// Imports the Google Cloud client library
const {ErrorReporting} = require('@google-cloud/error-reporting');

// Instantiates a client
const errors = new ErrorReporting({
  projectId: 'your-project-id',
  keyFilename: '/path/to/key.json',
});

// Reports a simple error
errors.report('Something broke!');

例

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

// Imports the Google Cloud client library
const {ErrorReporting} = require('@google-cloud/error-reporting');

// Instantiates a client
const errors = new ErrorReporting();

// Use the error message builder to customize all fields ...
const errorEvent = errors.event();

// Add error information
errorEvent.setMessage('My error message');
errorEvent.setUser('root@nexus');

// Report the error event
errors.report(errorEvent, () => {
  console.log('Done reporting error event!');
});

// Report an Error object
errors.report(new Error('My error message'), () => {
  console.log('Done reporting Error object!');
});

// Report an error by provided just a string
errors.report('My error message', () => {
  console.log('Done reporting error string!');
});

Express.js を使用したエラーの報告

Node.js 用 Error Reporting ライブラリを使用すると、Express.js などの一般的な Node.js ウェブ フレームワークに Error Reporting を統合できます。

const express = require('express');

// Imports the Google Cloud client library
const {ErrorReporting} = require('@google-cloud/error-reporting');

// Instantiates a client
const errors = new ErrorReporting();

const app = express();

app.get('/error', (req, res, next) => {
  res.send('Something broke!');
  next(new Error('Custom error message'));
});

app.get('/exception', () => {
  JSON.parse('{"malformedJson": true');
});

// Note that express error handling middleware should be attached after all
// the other routes and use() calls. See the Express.js docs.
app.use(errors.express);

const PORT = process.env.PORT || 8080;
app.listen(PORT, () => {
  console.log(`App listening on port ${PORT}`);
  console.log('Press Ctrl+C to quit.');
});

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

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

ローカル開発環境でこのページの Node.js サンプルを使用するには、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.

   Note: If the gcloud CLI prints a warning that your account doesn't have the serviceusage.services.use permission, then some gcloud CLI commands and client libraries might not work. Ask an administrator to grant you the Service Usage Consumer IAM role (roles/serviceusage.serviceUsageConsumer), then run the following command:

   gcloud auth application-default set-quota-project PROJECT_ID

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

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

例:

// Imports the Google Cloud client library
const {ErrorReporting} = require('@google-cloud/error-reporting');

// Instantiates a client
const errors = new ErrorReporting({
  projectId: 'your-project-id',
  keyFilename: '/path/to/key.json',
});

// Reports a simple error
errors.report('Something broke!');

エラーレポートの表示

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

Error Reporting に移動

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

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