گزارش های خطای پرس و جو برای افزونه های 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] .

اگرچه پیام‌های خطایی مانند این مفید هستند، اما اطلاعات بیشتر در Logs Explorer موجود است. به عنوان یک روش بهتر، برای اطلاعات بیشتر، گزارش‌های خطا را جستجو کنید. برای اطلاعات بیشتر در مورد آزمایش استقرار افزونه‌ها، به Test and debug Google Workspace add-ons مراجعه کنید.

این راهنما نحوه‌ی جستجوی گزارش‌های خطای افزونه در Cloud Logs Explorer را شرح می‌دهد، بنابراین می‌توانید:

• اگر کاربران با خطایی مواجه شدند، مطلع شوید.
• ببینید چند وقت یکبار خطاها رخ می‌دهند و کدام‌ها رایج‌تر هستند.
• پیام‌های خطای توصیفی را بخوانید که به شما در رفع آنها کمک می‌کنند.

پیش‌نیازها

قبل از بررسی گزارش‌های خطای افزونه:

• «Cloud Logging API» را در پروژه Google Cloud افزونه فعال کنید. برای فعال کردن API، به «ایجاد یک پروژه ابری» مراجعه کنید و API را فعال کنید .
• افزونه را در بازار Google Workspace منتشر کنید. برای انتشار افزونه در بازار، به «انتشار برنامه» مراجعه کنید.

گزارش‌های خطای افزونه را جستجو کنید

برای دریافت گزارش‌های مربوط به یک افزونه:

1. کنسول گوگل کلود را باز کنید.
2. در کنار «پلتفرم ابری گوگل»، روی فلش رو به پایین کلیک کنید و پروژه افزونه را انتخاب کنید.
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، به این نکات توجه کنید:

• افزونه‌ها فقط خطاها را در Logs Explorer ثبت می‌کنند. انواع دیگر گزارش ثبت نمی‌شوند.
• پیام‌های خطا همیشه به زبان انگلیسی نوشته می‌شوند.
• ثبت وقایع ابری هزینه دارد. برای اطلاعات بیشتر در مورد قیمت ثبت وقایع ابری، به قیمت‌گذاری Google Cloud Observability مراجعه کنید.