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