このガイドでは、Google Cloud ログ エクスプローラで Chat アプリのエラーログをクエリする方法について説明します。ログをクエリして、次の情報を取得します。
- ユーザーにエラーが発生しているかどうかを確認する。
- エラーが発生する頻度と、最も頻繁に発生するエラーを確認します。
- エラーの修正に役立つ説明的なエラー メッセージとログデータを確認します。
前提条件
- Google Chat へのアクセス権を持つ Google Workspace アカウント。
- Chat アプリ。Chat アプリを作成するには、こちらのクイックスタートをご覧ください。
- Chat アプリのエラー ロギングを有効にする。
エラーログをクエリする
Google Cloud コンソールで、メニュー > [その他のサービス] > [ロギング] > [ログ エクスプローラ] をクリックします。
必要に応じて、クエリビルダーを表示するには、[クエリを表示] をオンにします。
Chat アプリのエラーログの場合は、次のクエリを入力します。
severity=ERROR resource.type="chat.googleapis.com/Project"
最近のエラーを表示するには、[クエリを実行] をクリックします。エラーが発生したときに確認するには、[ストリームログ] をクリックします。チャットアプリのエラーログが [クエリ結果] ペインに表示されます。
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 アプリのエラーを修正する方法をご確認ください。
- カード メッセージ、ダイアログ、リンク プレビューがレンダリングされない、または想定どおりに機能しないなどのカードのエラーを修正する方法をご確認ください。
- デバッグ方法の詳細