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

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

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

前提条件

エラーログをクエリする

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

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

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

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

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

  4. 最近のエラーを表示するには、[クエリを実行] をクリックします。または、エラーが発生したときに表示するには、[ログをストリーミング] をクリックします。Chat アプリのエラーログが [クエリ結果] ペインに表示されます。

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 アプリのデバッグに役立ちます。たとえば、Google Cloud Run functions を使用して Chat アプリをデプロイする場合は、ログ エクスプローラで Cloud Run functions のログも確認します。

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

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

エラーログをクエリしてエラーが見つかった場合は、次のガイドを参照してエラーを修正してください。