公開されている Google Workspace アドオンがエラーを返すと、 という一般的なメッセージが返されます。 「アドオンの実行中にエラーが発生しました。」ただし これらのエラーは Cloud ログ エクスプローラに記録されます。
このガイドでは、Google Cloud コンソールでアドオンのエラーログをクエリする方法について説明します。 次のことが可能になります。
- ユーザーにエラーが発生しているかどうかを確認する。
- エラーの発生頻度と、最も発生頻度の高いエラーを確認できます。
- エラーの修正に役立つわかりやすいエラー メッセージを確認します。
前提条件
アドオンのエラーログをクエリする前に:
- Cloud Logging API を有効にする（アドオンの Google Cloud プロジェクトですAPI を有効にするには、このモジュールの Cloud プロジェクトを作成して API を有効にします。
- Google Workspace Marketplace でアドオンを公開します。 Google Chat でアドオンを公開するには、 参照先: アプリを公開する
アドオンのエラーログをクエリする
アドオンのログを取得するには:
- Google Cloud コンソールを開きます。
- [Google Cloud Platform]の横で下矢印 をクリックし、 プロジェクトです。
- 左上のメニュー アイコン をクリックします。 >Logging。ログ エクスプローラが開きます。
アドオンのエラーログの場合は、クエリビルダーで次のように入力します。 次のクエリを実行します。
severity>=ERROR protoPayload.serviceName="gsuiteaddons.googleapis.com"最近のエラーを表示するには、[クエリを実行] をクリックします。発生したエラーを [ログをストリーミング] をクリックします。アドオンのエラーログは クエリ結果クリックします。
Cloud ログ エクスプローラとクエリの作成について詳しくは、このモジュールの 次のとおりです。
エラーロギングを有効または無効にする
デフォルトでは、エラーロギングは有効になっています。エラーロギングを有効にすると マニフェスト ファイル 次の要素があります。
"exceptionLogging": "STACKDRIVER",
エラーロギングを無効にするには、
"exceptionLogging": "STACKDRIVER", は、
次のとおりです。
// Disable error logging
"exceptionLogging": "NONE"
エラーロギングを再度有効にするには、"exceptionLogging": "NONE" を
"exceptionLogging": "STACKDRIVER",。
考慮事項
Cloud Logs でアドオンのエラーログを操作する際 以下の考慮事項に留意してください。
- アドオンはログ エクスプローラにエラーのみを記録します。その他のログタイプは、 記録されません。
- エラー メッセージは常に英語で記述されます。
- Cloud Logging には費用が発生します。Cloud Logging および Google Cloud の Google Cloud Observability の料金をご覧ください。