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

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

ログバケットには顧客管理の暗号鍵（CMEK）が含まれています。
ログバケットが global リージョンにない
カスタムエラーイベントを報告する。

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

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

始める前に

Google Cloud アカウントにログインします。Google Cloud を初めて使用する場合は、アカウントを作成して、実際のシナリオでの Google プロダクトのパフォーマンスを評価してください。新規のお客様には、ワークロードの実行、テスト、デプロイができる無料クレジット $300 分を差し上げます。

Google Cloud Console の [プロジェクトセレクタ] ページで、Google Cloud プロジェクトを選択または作成します。

プロジェクトセレクタに移動

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

Error Reporting API を有効にします。

API を有効にする

Google Cloud Console の [プロジェクトセレクタ] ページで、Google Cloud プロジェクトを選択または作成します。

プロジェクトセレクタに移動

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

Error Reporting API を有効にします。

API を有効にする

Node.js 開発用の環境を準備します。
Node.js 設定ガイドに移動

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

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

npm を使用してパッケージをインストールします。
```
npm install --save @google-cloud/error-reporting
```

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

// 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 が自動的に有効になります。特別な設定は必要ありません。

Google Kubernetes Engine

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

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

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

ロールの付与については、プロジェクト、フォルダ、組織へのアクセスを管理するをご覧ください。
クラスタを作成し、そのクラスタに cloud-platform アクセススコープを付与します。

たとえば、次の create コマンドでは、cloud-platform アクセススコープとサービスアカウントを指定します。
```
gcloud container clusters create CLUSTER_NAME --service-account  SERVICE_ACCT_NAME --scopes=cloud-platform
```

Compute Engine

Compute Engine の VM インスタンスで Error Reporting を使用するには、次のようにします。

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

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

ロールの付与については、プロジェクト、フォルダ、組織へのアクセスを管理するをご覧ください。
Google Cloud コンソールのナビゲーションパネルで、[Compute Engine] を選択してから、[VM インスタンス] を選択します。
[VM インスタンス] に移動
cloud-platform アクセススコープを受け取る VM インスタンスを選択します。
[停止]、[編集] の順にクリックします。
[ID と API へのアクセス] セクションで、Error Reporting 書き込みロール（roles/errorreporting.writer）を持つサービスアカウントを選択します。
[アクセススコープ] セクションで、[すべての Cloud API に完全アクセス権を許可] を選択して、変更内容を保存します。
[開始 / 再開] をクリックします。

Cloud Functions

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

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

Cloud Functions は、自動的に Error Reporting を使用するように構成されています。JavaScript の未処理の例外は、Logging に表示され、Node.js 用 Error Reporting ライブラリを使用しなくても、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 をインストールして初期化し、自身のユーザー認証情報を使用してアプリケーションのデフォルト認証情報を設定してください。

Google Cloud CLI をインストールします。
gcloud CLI を初期化するには:
```
gcloud init
```

Google アカウントのローカル認証情報を作成します。
```
gcloud auth application-default login
```
注: 使用しているアカウントに serviceusage.services.use 権限がないという警告が gcloud CLI で表示される場合は、一部の gcloud CLI コマンドとクライアントライブラリが動作しない可能性があります。管理者に Service Usage Consumer IAM ロール（roles/serviceusage.serviceUsageConsumer）を付与してもらってから、次のコマンドを実行してください。
```
gcloud auth application-default set-quota-project PROJECT_ID
```

詳細については、ローカル開発環境の認証の設定をご覧ください。

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 コンソールのナビゲーションパネルで [エラーレポート] を選択し、Google Cloud プロジェクトを選択します。

Error Reporting に移動

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

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

始める前に

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

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

その他の統合

Google Cloud でアプリを実行する

App Engine フレキシブル環境

Google Kubernetes Engine

Compute Engine

Cloud Functions

例

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

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

エラーレポートの表示

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

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