Google Chat アプリのエラーログをクエリする

このガイドでは、Google Cloud ログ エクスプローラで Chat 用アプリのエラーログをクエリする方法について説明します。クエリログの宛先:

  • ユーザーがエラーに遭遇したかどうかを確認します。
  • エラーの発生頻度と、最も頻繁に発生するエラーを確認します。
  • エラーの修正に役立つ説明的なエラー メッセージとログデータを読み取ります。

前提条件

クエリ エラーログ

  1. Google Cloud コンソールで、メニュー > [その他のサービス] > [ロギング] > [ログ エクスプローラ] をクリックします。

    [ログ エクスプローラ] に移動

  2. 必要に応じて、[クエリを表示] をオンにしてクエリビルダーを表示します。

  3. Chat 用アプリのエラーログの場合は、次のクエリを入力します。

    severity=ERROR
resource.type="chat.googleapis.com/Project"

  4. 最近のエラーを表示するには、[クエリを実行] をクリックします。エラーの発生時にエラーを確認するには、[ストリームログ] をクリックします。チャットアプリのエラーログが [クエリ結果] ペインに表示されます。

Google Cloud ログ エクスプローラとクエリの作成の詳細については、ログ エクスプローラのドキュメントの次のガイドをご覧ください。

ログからエラー メッセージを読み取る

エラーログをクエリすると、ログを記述する JSON ペイロードで構成される個々のログを表示できます。Chat 用アプリのエラーの場合、JSON には jsonPayload.error.message のエラー メッセージが含まれます。たとえば、次のサンプルログでは、Apps Script 関数の実行に失敗したことを示すエラー メッセージが表示されています。

JSON

{
  "insertId": "INSERT_ID",
  "jsonPayload": {
    "@type": "type.googleapis.com/google.chat.logging.v1.ChatAppLogEntry",
    "error": {
      "code": 9,
      "message": "An Apps Script function failed to execute. To review AppsScript error logs, see \"Logging\" (https://developers.google.com/apps-script/guides/logging)."
    },
    "deployment": "DEPLOYMENT_ID"
  },
  "resource": {
    "type": "chat.googleapis.com/Project",
    "labels": {
      "project_id": "PROJECT_ID"
    }
  },
  "timestamp": "2022-12-06T05:24:18.697255Z",
  "severity": "ERROR",
  "logName": "projects/PROJECT_ID/logs/chat.googleapis.com%2Ferrors",
  "receiveTimestamp": "2022-12-06T05:24:19.207936968Z"
}

考慮事項

Google Cloud ログ エクスプローラで Chat 用アプリのエラーログを操作する際は、次の点に注意してください。

  • Google Chat 用アプリの場合、ログ エクスプローラには現在、次の重大度のログが含まれています。これらは、アプリの誤動作のトラブルシューティングに役立ちます。

    • ERROR

    関連サービスのログも、Chat 用アプリのデバッグに役立ちます。たとえば、Chat 用アプリが Google Cloud Functions を使用してデプロイされている場合は、Cloud Functions のログもログ エクスプローラで確認することをおすすめします。

  • エラー メッセージは常に英語で表示されます。

  • Cloud Logging には費用が発生します。Cloud Logging の料金の詳細については、Google Cloud のオペレーション スイートの料金をご覧ください。

エラーログのクエリを実行してエラーが見つかった場合は、次のガイドでエラーの修正方法を確認してください。