Consultar registros de erros de complementos do Google Workspace

Quando um complemento publicado do Google Workspace retorna um erro, a interface dele mostra uma mensagem genérica de "Algo deu errado ao executar o complemento". No entanto, esses erros são registrados na Análise de registros do Cloud.

Observação:no Apps Script, se o complemento for implantado como um teste, os erros serão informados na Análise de registros do Cloud 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, mais informações estão disponíveis na Análise 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 na Análise de registros do Cloud para que você possa:

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

Pré-requisitos

Antes de consultar os registros de erros do complemento:

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

Consultar registros de erros de complementos

Para receber 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 do complemento.
3. No canto superior esquerdo, clique em Menu > Registro em log. A Análise de registros é aberta.

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

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

5. Para ver os erros recentes, clique em Executar consulta. Ou, para ver os erros à medida que ocorrem, clique em Fazer streaming de registros. Os registros de erros de complementos aparecem no painel "Resultados da consulta".

Para mais informações sobre a Análise de registros do Cloud e como escrever consultas, consulte o seguinte:

• Usar a Análise de registros
• Criar consultas

Ativar ou desativar o registro de erros

Por padrão, a geração de registros de erros está ativada. Quando a geração de registros de erros está ativada, 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 registram apenas erros na Análise de registros. Outros tipos de registro não são gravados.
• As mensagens de erro são sempre escritas em inglês.
• O Cloud Logging gera um custo. Para mais informações sobre os preços do Cloud Logging, consulte Preços do Google Cloud Observability.