エラーの報告

エラーを自動的に報告する

エラーレベルに応じて Error オブジェクトをコンソールのログに記録するだけで、Cloud Function から Stackdriver Error Reporting にエラーを送信できます。

console.error(new Error('message'));

報告されたエラーは、API Console の Stackdriver Error Reporting で確認できます。また、API Console で関数のリストから関数を選択すると、その関数から報告されたエラーを確認できます。

関数によってキャッチされないエラーが生成された場合や、Error 型のオブジェクトを明示的にスローした場合は、そのエラーが Stackdriver Error Reporting にも表示されます。ただし、キャッチされないエラーや例外により、その後の関数呼び出しに対してコールド スタートが強制されることになります。したがって、パフォーマンス上の理由により、最初のアプローチ（Error オブジェクトのロギング）を使用してください。

以下の場合は、Stackdriver エラーが送信されないことに注意してください。

• Error 以外のオブジェクト（throw 1; など）をスローした場合。
• 情報レベルのエラー オブジェクト（console.info(new Error('message')); など）をログに記録する場合。
• Error 以外のオブジェクト（console.error('message'); など）をログに記録する場合。
• 正常に完了した関数で結果がエラーになった場合。たとえば、HTTP 関数の場合は res.status(500).send('message');、他のバックグランド トリガーの場合は callback('message');。

try-catch ステートメントの catch ブロックや、Promise の catch コールバックでエラーが報告された場合、err オブジェクトがすでに型付き Error オブジェクトになっていることがよくあります。Google 提供のライブラリを介して Google サービスを使用している場合は、提供された err オブジェクトを直接ログに記録できます。

try {
  // Throw an Error object (to simulate a GCP API failure)
  throw new Error('Error object!');
} catch (err) {
  // err is already an Error object
  console.error(err);
}

提供された err が Error オブジェクトであるかどうかわからない場合は、次のようにすることで確認できます。

try {
  // Throw an unknown error type
  if (someCondition) {
    throw 'Error string!';
  } else {
    throw new Error('Error object!');
  }
} catch (err) {
  // Determine the error type
  if (err instanceof Error) {
    console.error(err);
  } else {
    console.error(new Error(err));
  }
}

エラーを手動で報告する

関数から Stackdriver Error Reporting にエラーを報告するには、Stackdriver Logging API を使用します。

依存関係をインポートする

functions ディレクトリから、Node.js 用の Google Stackdriver Logging クライアント ライブラリをインストールします。

npm install --save @google-cloud/logging

Logging API にアクセスするために、Google Cloud クライアント ライブラリをインポートします。

const Logging = require('@google-cloud/logging');

// Instantiates a client
const logging = Logging();

Stackdriver に送信する

ログエントリを適切な形式にするには、MonitoredResource オブジェクトと ErrorEvent オブジェクトが必要です。

この例では、reportError 関数が Stackdriver Error Reporting にエラーを報告するのに必要な最低限のデータがわかります。

function reportError(err, context = {}) {
  // This is the name of the StackDriver log stream that will receive the log
  // entry. This name can be any valid log stream name, but must contain "err"
  // in order for the error to be picked up by StackDriver Error Reporting.
  const logName = 'errors';
  const log = logging.log(logName);

  // https://cloud.google.com/logging/docs/api/ref_v2beta1/rest/v2beta1/MonitoredResource
  const metadata = {
    resource: {
      type: 'cloud_function',
      labels: {function_name: process.env.FUNCTION_NAME},
    },
  };

  // https://cloud.google.com/error-reporting/reference/rest/v1beta1/ErrorEvent
  const errorEvent = {
    message: err.stack,
    serviceContext: {
      service: process.env.FUNCTION_NAME,
      resourceType: 'cloud_function',
    },
    context: context,
  };

  // Write the error log entry
  return new Promise((resolve, reject) => {
    log.write(log.entry(metadata, errorEvent), (error) => {
      if (error) {
       return reject(error);
      }
      return resolve();
    });
  });
}
index.js

reportError 関数を使用すると、エラーを手動で報告できます。

// Charge the Stripe customer whenever an amount is written to the Realtime database
exports.createStripeCharge = functions.database.ref('/stripe_customers/{userId}/charges/{id}')
    .onCreate((snap, context) => {
      const val = snap.val();
      // Look up the Stripe customer id written in createStripeCustomer
      return admin.database().ref(`/stripe_customers/${context.params.userId}/customer_id`)
          .once('value').then((snapshot) => {
            return snapshot.val();
          }).then((customer) => {
            // Create a charge using the pushId as the idempotency key
            // protecting against double charges
            const amount = val.amount;
            const idempotencyKey = context.params.id;
            const charge = {amount, currency, customer};
            if (val.source !== null) {
              charge.source = val.source;
            }
            return stripe.charges.create(charge, {idempotency_key: idempotencyKey});
          }).then((response) => {
            // If the result is successful, write it back to the database
            return snap.ref.set(response);
          }).catch((error) => {
            // We want to capture errors and render them in a user-friendly way, while
            // still logging an exception with StackDriver
            return snap.ref.child('error').set(userFacingMessage(error));
          }).then(() => {
            return reportError(error, {user: context.params.userId});
          });
        });
index.js

ErrorContext パラメータを使用して、ユーザーの詳細を渡すことができます。Stackdriver の UI に表示された詳細情報を使用すると、影響を受けるユーザーの数を計算できます。

ErrorContext に HTTP リクエストに関する情報を渡すこともできます。

export.httpError = functions.https.onRequest((request, response) => {
  const error = new Error('Test error');
  const httpRequest = {
    method: request.method,
    url: request.originalUrl,
    userAgent: request.get('user-agent'),
    referrer: '',
    remoteIp: request.ip
  };
  reportError(error, {httpRequest}).then(() => {
    response.end();
  });
});