Registros de erros de consulta dos complementos do Google Workspace

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

Observação: para o Apps Script, se um complemento for implantado como teste, são informados na Análise de registros do Cloud e na do complemento.

Por exemplo, uma implantação de teste de complemento pode exibir 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, há mais informações 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 testes do Google Cloud, consulte Teste e depure complementos do Google Workspace.

Neste guia, descrevemos como consultar registros de erros de complementos no 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 frequentes.
• Leia mensagens de erro descritivas que ajudem você a corrigir os erros.

Pré-requisitos

Antes de consultar os registros de erros de complementos:

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

Registros de erros do complemento de consulta

Para acessar 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 em um projeto de complemento.
3. No canto superior esquerdo, clique em Menu . > Geração de registros. A Análise de registros será 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 acessar os erros recentes, clique em Executar consulta. Ou, para visualizar os erros à medida que ocorrer, clique em Fazer streaming de registros. Os registros de erro de complementos aparecem "Resultados da consulta" .

Para mais informações sobre a Análise de registros do Cloud e como criar 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, arquivo de manifesto tem o seguinte:

"exceptionLogging": "STACKDRIVER",

Para desativar a geração de registros de erros, substitua "exceptionLogging": "STACKDRIVER", pela linha abaixo na 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 nos registros do Cloud Explorer, anote estas considerações:

• Os complementos só registram erros na Análise de registros. Outros tipos de registros são não é gravado.
• As mensagens de erro são sempre escritas em inglês.
• O Cloud Logging gera custos. Para mais informações sobre o Cloud Logging, consulte os preços de observabilidade do Google Cloud.