Registros de erros de consulta para apps do Google Chat

Neste guia, descrevemos como consultar os 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 Mostrar consulta para mostrar o criador de consultas.

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

    severity=ERROR
resource.type="chat.googleapis.com/Project"

  4. Para ver os erros recentes, clique em Executar consulta. Ou, para ver os erros à medida que eles ocorrem, clique em Registros de stream. Os registros de erros do app de chat aparecem no painel "Resultados da consulta".

Para saber mais sobre o Explorador de registros do Google Cloud e como escrever consultas, consulte estes guias na documentação do Explorador de registros:

Ler uma mensagem de erro de um registro

Depois de consultar um registro de erros, é possível ver registros individuais, que consistem em um payload JSON que descreve o registro. Para erros do app de chat, o JSON inclui a mensagem de erro em jsonPayload.error.message. Por exemplo, no registro de amostra a seguir, a mensagem de erro informa que uma função do Apps Script não foi executada:

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 na Análise de registros do Google Cloud, observe estas considerações:

  • Para apps do Google Chat, o Explorador de registros inclui registros com as seguintes gravidades, que ajudam a resolver problemas de um app com mau funcionamento:

    • ERROR

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

  • 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.

Depois de consultar os registros de erros, se você encontrar algum, consulte os seguintes guias para receber ajuda na correção: