エラーの報告

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

次のように、Cloud Functions の関数から Error Reporting にエラーを送信できます。

// These WILL be reported to Error Reporting
throw new Error('I failed you'); // Will cause a cold start if not caught

// These WILL be reported to Error Reporting
console.error(new Error('I failed you')); // Logging an Error object
console.error('I failed you'); // Logging something other than an Error object
throw 1; // Throwing something other than an Error object
callback('I failed you');
res.status(500).send('I failed you');
index.js

より詳細なエラー報告が必要な場合は、Error Reporting クライアント ライブラリを使用します。

報告されたエラーは、GCP Console の Error Reporting で表示できます。また、GCP Console で関数のリストから関数を選択して、その特定の関数から報告されたエラーを表示することもできます。

関数によって生成され、キャッチされていない例外は、Error Reporting に表示されます。キャッチされなかった例外（非同期でスローされた例外など）は、将来の関数呼び出しでコールド スタートの原因となる可能性があります。これにより、関数の実行時間が長くなります。

エラーを手動で報告する

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

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

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

npm install --save @google-cloud/logging

Cloud Logging クライアント ライブラリをインポートして初期化します。

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

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

Cloud Logging に送信する

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

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

function reportError(err, context = {}) {
  // This is the name of the 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 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 関数を使用すると、エラーを手動で報告できます。

exports.createStripePayment = functions.firestore
  .document('stripe_customers/{userId}/payments/{pushId}')
  .onCreate(async (snap, context) => {
    const { amount, currency, payment_method } = snap.data();
    try {
      // Look up the Stripe customer id.
      const customer = (await snap.ref.parent.parent.get()).data().customer_id;
      // Create a charge using the pushId as the idempotency key
      // to protect against double charges.
      const idempotencyKey = context.params.pushId;
      const payment = await stripe.paymentIntents.create(
        {
          amount,
          currency,
          customer,
          payment_method,
          off_session: false,
          confirm: true,
          confirmation_method: 'manual',
        },
        { idempotencyKey }
      );
      // If the result is successful, write it back to the database.
      await snap.ref.set(payment);
    } catch (error) {
      // We want to capture errors and render them in a user-friendly way, while
      // still logging an exception to Error Reporting.
      functions.logger.log(error);
      await snap.ref.set({ error: userFacingMessage(error) }, { merge: true });
      await reportError(error, { user: context.params.userId });
    }
  });
index.js

ErrorContext パラメータを使用して、ユーザーの詳細を渡すことができます。これらの詳細は Error Reporting の 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();
  });
});