このガイドでは、Google Cloud ログ エクスプローラで Chat アプリのエラーログをクエリする方法について説明します。ログのクエリ:
- エラーが発生しているかどうかを確認する。
- エラーが発生する頻度と、最も頻繁に発生しているエラーを確認します。
- エラーの説明に役立つエラー メッセージとログデータを読み取る。
前提条件
- Google Chat へのアクセス権を持つ Google Workspace アカウント。
- Chat アプリ。Chat アプリを作成するには、こちらのquickstartの手順に沿ってください。
- Chat アプリのエラーロギングを有効にします。
クエリエラーログ
Google Cloud コンソールで、メニュー > [その他のプロダクト] > [ロギング] > [ログ エクスプローラ] をクリックします。
必要に応じてクエリビルダーを表示するには、[クエリを表示] をオンにします。
Chat アプリのエラーログの場合は、次のクエリを入力します。
severity=ERROR resource.type="chat.googleapis.com/Project"
最近のエラーを表示するには、[クエリを実行] をクリックします。発生したエラーを確認するには、[ログをストリーミング] をクリックします。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 アプリのデバッグにも役立ちます。たとえば、Chat アプリが Google Cloud Functions を使用してデプロイされている場合は、ログ エクスプローラで Cloud Functions のログも確認することをおすすめします。
エラー メッセージは常に英語で記述されます。
Cloud Logging には料金が発生します。Cloud Logging の料金の詳細については、Google Cloud のオペレーション スイートの料金をご覧ください。
関連トピック
エラーログをクエリした後、エラーが見つかった場合は、次のガイドを参照してエラーを修正してください。
- 「アプリが応答しない」、「Google Chat API は Google Workspace ユーザーのみが使用できます」、「ユーザーはスペースから除外できます」など、Google Chat アプリのエラーの修正方法をご確認ください。
- カード メッセージ、ダイアログ、リンク プレビューが正しくレンダリングされない、または想定どおりに機能しないなど、カードのエラーを解決する方法をご確認ください。
- デバッグ方法の詳細