公開されている Google Workspace アドオンがエラーを返すと、アドオン インターフェースは「アドオンの実行時にエラーが発生しました」という汎用メッセージを返します。ただし、これらのエラーは Cloud ログ エクスプローラに記録されます。
このガイドでは、Cloud ログ エクスプローラでアドオンのエラーログをクエリして、次のことを行う方法について説明します。
- エラーが発生しているかどうかを確認する。
- エラーが発生する頻度と、最も頻繁に発生しているエラーを確認します。
- 修正に役立つわかりやすいエラー メッセージを確認します。
前提条件
アドオンのエラーログをクエリする前に:
- アドオンの 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 ログ エクスプローラとクエリの作成の詳細については、以下をご覧ください。
エラーロギングを有効または無効にする
デフォルトでは、エラーロギングは有効になっています。エラーロギングが有効になっている場合、マニフェスト ファイルは次のようになります。
"exceptionLogging": "STACKDRIVER",
エラーロギングを無効にするには、マニフェスト ファイルの "exceptionLogging": "STACKDRIVER",
を次の行に置き換えます。
// Disable error logging
"exceptionLogging": "NONE"
エラーロギングを再度有効にするには、"exceptionLogging": "NONE"
を "exceptionLogging": "STACKDRIVER",
に置き換えます。
考慮事項
Cloud Logs Explorer でアドオン エラーログを操作する場合は、次の点を考慮してください。
- アドオンはログ エクスプローラにエラーのみを記録します。他のログタイプは記録されません。
- エラー メッセージは常に英語で記述されます。
- Cloud Logging には料金が発生します。Cloud Logging の料金の詳細については、Google Cloud オブザーバビリティの料金をご覧ください。