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

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

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

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

• Включите API «Cloud Logging» в проекте Google Cloud дополнения. Чтобы включить 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) влечет за собой затраты. Для получения дополнительной информации о ценах на облачное логирование см. раздел «Цены на Google Cloud Observability» .