Google Workspace アドオンのエラーログをクエリする

公開された Google Workspace アドオンがエラーを返すと、アドオン インターフェースは「アドオンの実行中にエラーが発生しました」という一般的なメッセージを返します。ただし、これらのエラーは Cloud Logs Explorer に記録されます。

注: Apps Script の場合、アドオンがテストとしてデプロイされていると、エラーは Cloud Logs Explorer とアドオン インターフェースの両方で報告されます。

たとえば、アドオン テストのデプロイでは、インターフェースに TypeError: card.INVALIDFUNCTIONNAME is not a function [line: 33, function: getContextualAddOn, file: GetContextualAddOn] のようなエラー メッセージが表示されることがあります。

このようなエラー メッセージは役立ちますが、ログ エクスプローラで追加情報を確認できます。ベスト プラクティスとして、エラーログをクエリして詳細情報を取得します。アドオンのデプロイのテストについて詳しくは、Google Workspace アドオンのテストとデバッグをご覧ください。

このガイドでは、Cloud Logs Explorer でアドオンのエラーログをクエリする方法について説明します。これにより、次のことが可能になります。

• ユーザーがエラーに遭遇したかどうかを確認します。
• エラーの発生頻度と、最も頻繁に発生するエラーを確認します。
• エラーを修正するのに役立つ説明的なエラー メッセージが表示されます。

前提条件

アドオンのエラーログをクエリする前に:

• アドオンの Google Cloud プロジェクトで「Cloud Logging API」を有効にします。API を有効にするには、Cloud プロジェクトを作成して API を有効にするをご覧ください。
• Google Workspace Marketplace でアドオンを公開します。Marketplace でアドオンを公開するには、アプリを公開するをご覧ください。

アドオンのエラーログをクエリする

アドオンのログを取得するには:

1. Google Cloud コンソールを開きます。
2. [Google Cloud Platform] の横にある下矢印 をクリックして、アドオン プロジェクトを選択します。
3. 左上のメニュー アイコン > [ロギング] をクリックします。ログ エクスプローラが開きます。

4. アドオンのエラーログの場合は、クエリビルダーに次のクエリを入力します。

   severity>=ERROR
   protoPayload.serviceName="gsuiteaddons.googleapis.com"
   

5. 最近のエラーを表示するには、[クエリを実行] をクリックします。エラーの発生時にエラーを表示するには、[ログをストリームする] をクリックします。アドオンのエラーログが [クエリ結果] ペインに表示されます。

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 の料金をご覧ください。