Nhật ký lỗi truy vấn cho tiện ích bổ sung của Google Workspace

Khi một tiện ích bổ sung đã xuất bản của Google Workspace trả về lỗi, giao diện tiện ích bổ sung sẽ trả về thông báo chung "Đã xảy ra lỗi khi thực thi tiện ích bổ sung". Tuy nhiên, những lỗi này được ghi vào Cloud Logs Explorer (Trình khám phá nhật ký trên đám mây).

Lưu ý: Đối với Apps Script, nếu tiện ích bổ sung của bạn được triển khai dưới dạng một bản kiểm thử, thì lỗi sẽ được báo cáo trong cả Trình khám phá nhật ký trên đám mây và trong giao diện tiện ích bổ sung.

Ví dụ: quá trình triển khai kiểm thử tiện ích bổ sung có thể hiển thị một thông báo lỗi như sau trong giao diện: TypeError: card.INVALIDFUNCTIONNAME is not a function [line: 33, function: getContextualAddOn, file: GetContextualAddOn].

Mặc dù những thông báo lỗi như thế này rất hữu ích, nhưng bạn có thể xem thêm thông tin trong Trình khám phá nhật ký. Theo phương pháp hay nhất, hãy truy vấn nhật ký lỗi để biết thêm thông tin. Để biết thêm thông tin về việc kiểm thử việc triển khai tiện ích bổ sung, hãy tham khảo bài viết Kiểm thử và gỡ lỗi tiện ích bổ sung cho Google Workspace.

Hướng dẫn này mô tả cách truy vấn nhật ký lỗi của tiện ích bổ sung trong Cloud Logs Explorer để bạn có thể:

• Tìm hiểu xem người dùng có gặp lỗi hay không.
• Xem tần suất xảy ra lỗi và lỗi nào thường xuyên nhất.
• Đọc thông báo lỗi mô tả để giúp bạn khắc phục lỗi.

Điều kiện tiên quyết

Trước khi truy vấn nhật ký lỗi của tiện ích bổ sung:

• Bật "Cloud Logging API" trong dự án Google Cloud của tiện ích bổ sung. Để bật một API, hãy tham khảo phần Tạo dự án trên Cloud và bật API.
• Xuất bản tiện ích bổ sung trên Google Workspace Marketplace. Để xuất bản một tiện ích bổ sung trên Marketplace, hãy tham khảo phần Xuất bản ứng dụng.

Truy vấn nhật ký lỗi của tiện ích bổ sung

Cách lấy nhật ký cho một tiện ích bổ sung:

1. Mở Google Cloud Console.
2. Bên cạnh "Google Cloud Platform", hãy nhấp vào biểu tượng Mũi tên xuống rồi chọn dự án bổ trợ.
3. Ở góc trên cùng bên trái, hãy nhấp vào biểu tượng Trình đơn > Ghi nhật ký. Trình khám phá nhật ký sẽ mở ra.

4. Đối với nhật ký lỗi của tiện ích bổ sung, trong trình tạo truy vấn, hãy nhập truy vấn sau:

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

5. Để xem các lỗi gần đây, hãy nhấp vào Chạy truy vấn. Hoặc để xem lỗi khi chúng xảy ra, hãy nhấp vào Nhật ký truyền trực tuyến. Nhật ký lỗi của tiện ích bổ sung sẽ xuất hiện trong ngăn "Kết quả truy vấn".

Để biết thêm thông tin về Cloud Logs Explorer và cách viết truy vấn, hãy tham khảo những nội dung sau:

• Sử dụng Logs Explorer
• Tạo truy vấn

Bật hoặc tắt tính năng ghi nhật ký lỗi

Theo mặc định, tính năng ghi nhật ký lỗi sẽ được bật. Khi bạn bật tính năng ghi nhật ký lỗi, tệp kê khai sẽ có những nội dung sau:

"exceptionLogging": "STACKDRIVER",

Để tắt tính năng ghi nhật ký lỗi, hãy thay thế "exceptionLogging": "STACKDRIVER", bằng dòng sau trong tệp kê khai:

// Disable error logging
"exceptionLogging": "NONE"

Để bật lại tính năng ghi nhật ký lỗi, hãy thay thế "exceptionLogging": "NONE" bằng "exceptionLogging": "STACKDRIVER",.

Lưu ý

Khi bạn làm việc với nhật ký lỗi của tiện ích bổ sung trong Cloud Logs Explorer, hãy lưu ý những điều sau:

• Tiện ích bổ sung chỉ ghi lại các lỗi trong Logs Explorer. Các loại nhật ký khác sẽ không được ghi lại.
• Thông báo lỗi luôn được viết bằng tiếng Anh.
• Cloud Logging phát sinh chi phí. Để biết thêm thông tin về giá của Cloud Logging, hãy tham khảo giá của Google Cloud Observability.