Quando um complemento publicado do Google Workspace retorna um erro, a interface do complemento retorna a mensagem genérica "Algo deu errado ao executar o complemento". No entanto, esses erros são registrados no Cloud Logs Explorer.
Neste guia, descrevemos como consultar registros de erros de complementos no Explorador de registros do Cloud para que seja possível:
- Saiba se os usuários encontram erros.
- Veja com que frequência ocorrem erros e quais são os mais frequentes.
- Leia mensagens de erro descritivas que ajudam a corrigi-las.
Pré-requisitos
Antes de consultar os registros de erros de complementos:
- Ative a "API Cloud Logging" no projeto do complemento 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 Publicar um aplicativo.
Registros de erros de complementos de consulta
Para acessar os registros de um complemento:
- Abra o Console do Google Cloud.
- Ao lado de "Google Cloud Platform", clique na seta para baixo e selecione o projeto do complemento.
- No canto superior esquerdo, clique em Menu > Logging. O Explorador de registros é aberto.
Para registros de erro de complementos, no criador de consultas, insira a seguinte consulta:
severity>=ERROR protoPayload.serviceName="gsuiteaddons.googleapis.com"
Para ver os erros recentes, clique em Executar consulta. Ou, para ver os erros à medida que eles ocorrem, clique em Fazer streaming de registros. Os registros de erro de complementos aparecem no painel "Resultados da consulta".
Para mais informações sobre o Explorador de registros do Cloud e a criação de consultas, consulte:
Ativar ou desativar o registro de erros
Por padrão, o registro de erros está ativado. 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 Buscador de registros do Cloud, observe as seguintes considerações:
- Erros de registro de complementos apenas no Explorador 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 um custo. Para mais informações sobre os preços do Cloud Logging, consulte Preços do pacote de operações do Google Cloud.