Consultar registros de erros de complementos do Google Workspace

Quando um complemento publicado do Google Workspace retorna um erro, a interface do complemento retorna uma mensagem genérica de "Ocorreu um erro ao executar o complemento". No entanto, esses erros são registrados no Buscador de registros do Cloud.

Observação:no Apps Script, se o complemento for implantado como um teste, os erros serão informados no Cloud Logs Explorer e na interface do complemento.

Por exemplo, uma implantação de teste de complemento pode mostrar uma mensagem de erro como esta na interface: TypeError: card.INVALIDFUNCTIONNAME is not a function [line: 33, function: getContextualAddOn, file: GetContextualAddOn].

Embora mensagens de erro como essa sejam úteis, outras informações estão disponíveis no Explorador de registros. Como prática recomendada, consulte os registros de erros para mais informações. Para mais informações sobre como testar implantações de complementos, consulte Testar e depurar complementos do Google Workspace.

Este guia descreve como consultar registros de erros de complementos no Explorador de registros do Cloud para que você possa:

• Saiba se os usuários encontram erros.
• Confira com que frequência os erros ocorrem e quais são os mais frequentes.
• Leia mensagens de erro descritivas que ajudam a corrigir o problema.

Pré-requisitos

Antes de consultar os registros de erros do complemento:

• Ative a "API Cloud Logging" no projeto do Google Cloud do complemento. Para ativar uma API, consulte Criar um projeto do Cloud e ativar a API.
• Publicar o complemento no Google Workspace Marketplace. Para publicar um complemento no Marketplace, consulte Publicar um app.

Consultar registros de erros do complemento

Para conferir os registros de um complemento:

1. Abra o Console do Google Cloud.
2. Ao lado de "Google Cloud Platform", clique na seta para baixo e selecione o projeto complementar.
3. No canto superior esquerdo, clique em Menu > Registro. A Análise de registros é aberta.

4. Para registros de erros de complemento, no criador de consultas, insira a seguinte consulta:

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

5. Para conferir erros recentes, clique em Executar consulta. Ou, para conferir os erros conforme eles ocorrem, clique em Stream logs. Os registros de erros dos complementos aparecem no painel "Resultados da consulta".

Para mais informações sobre o Explorador de registros do Cloud e como escrever consultas, consulte:

• Usar o Explorador de registros
• Criar consultas

Ativar ou desativar a geração de registros de erros

Por padrão, a geração de registros de erros está ativada. Quando o registro de erros está ativado, o arquivo de manifesto tem o seguinte:

"exceptionLogging": "STACKDRIVER",

Para desativar o registro de erros, substitua "exceptionLogging": "STACKDRIVER", pela seguinte linha no arquivo de manifesto:

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

Para reativar a geração de registros de erros, substitua "exceptionLogging": "NONE" por "exceptionLogging": "STACKDRIVER",.

Considerações

Ao trabalhar com registros de erros de complementos no Cloud Logs Explorer, observe estas considerações:

• Os complementos só registram erros no Buscador de registros. Outros tipos de registro não são registrados.
• As mensagens de erro são sempre escritas em inglês.
• O Cloud Logging gera custos. Para mais informações sobre os preços do Cloud Logging, consulte Preços de observabilidade do Google Cloud.