Registros de erros de consulta para apps do Google Chat

Este guia descreve como consultar registros de erros do app de chat no Explorador de registros do Google Cloud. Consultar registros para:

  • 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 e dados de registro que ajudam a corrigir os erros.

Pré-requisitos

Consultar registros de erros

  1. No console do Google Cloud, clique em Menu > Mais produtos > Logging > Análise de registros.

    Acessar a Análise de registros

  2. Se necessário, ative a opção Mostrar consulta para mostrar o criador de consultas.

  3. Para os registros de erros do app do Chat, digite a seguinte consulta:

    severity=ERROR
    resource.type="chat.googleapis.com/Project"
    
  4. Para acessar os erros recentes, clique em Executar consulta. Para conferir os erros conforme eles ocorrem, clique em Registros de transmissão. Os registros de erros do app de chat aparecem no painel "Resultados da consulta".

Para saber mais sobre a Análise de registros do Google Cloud e como escrever consultas, consulte estes guias na documentação da Análise de registros:

Ler uma mensagem de erro de um registro

Depois de consultar um registro de erro, você pode conferir registros individuais que consistem em um payload JSON que descreve o registro. Para erros do app do Chat, o JSON inclui a mensagem em jsonPayload.error.message. Por exemplo, no registro de amostra a seguir, a mensagem de erro informa que houve falha na execução de uma função do Apps Script:

JSON

{
  "insertId": "INSERT_ID",
  "jsonPayload": {
    "@type": "type.googleapis.com/google.chat.logging.v1.ChatAppLogEntry",
    "error": {
      "code": 9,
      "message": "An Apps Script function failed to execute. To review AppsScript error logs, see \"Logging\" (https://developers.google.com/apps-script/guides/logging)."
    },
    "deployment": "DEPLOYMENT_ID"
  },
  "resource": {
    "type": "chat.googleapis.com/Project",
    "labels": {
      "project_id": "PROJECT_ID"
    }
  },
  "timestamp": "2022-12-06T05:24:18.697255Z",
  "severity": "ERROR",
  "logName": "projects/PROJECT_ID/logs/chat.googleapis.com%2Ferrors",
  "receiveTimestamp": "2022-12-06T05:24:19.207936968Z"
}

Considerações

Ao trabalhar com registros de erros do app de chat no Google Cloud Logs Explorer, observe estas considerações:

  • Para apps do Google Chat, o Explorador de registros atualmente inclui registros com as seguintes severidades, que ajudam a resolver problemas em apps com mau funcionamento:

    • ERROR

    Os registros de serviços relacionados também podem ajudar a depurar um app de chat. Por exemplo, se um app de chat for implantado usando o Google Cloud Functions, é recomendável verificar o Logs Explorer também para os registros do Cloud Functions.

  • 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 do pacote de operações do Google Cloud.

Depois de consultar os registros de erros, se você encontrar erros, consulte os seguintes guias para ajudar a corrigir os erros: