Запрос журналов ошибок для дополнений 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, чтобы вы могли:

• Узнайте, сталкиваются ли пользователи с ошибками.
• Посмотрите, как часто возникают ошибки и какие встречаются чаще всего.
• Прочтите описательные сообщения об ошибках, которые помогут вам их исправить.

Предварительные условия

Прежде чем запрашивать журналы ошибок надстроек:

• Включите «Cloud Logging API» в проекте Google Cloud надстройки. Чтобы включить API, см. раздел Создание облачного проекта и включение 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, обратите внимание на следующие моменты:

• Надстройки регистрируют только ошибки в обозревателе журналов. Другие типы журналов не записываются.
• Сообщения об ошибках всегда пишутся на английском языке.
• Ведение облачных журналов требует затрат. Дополнительную информацию о ценах на ведение журналов в облаке см. в ценах на возможность наблюдения за облаком Google .