Registros de erros de consulta para apps do Google Chat
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
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
No console do Google Cloud, clique em Menu
menu
> Mais produtos
> Logging
> Análise de registros.
Acessar a Análise de registros
Se necessário, ative Mostrar consulta para mostrar o criador de consultas.
Para registros de erros do app do Chat, insira a seguinte consulta:
severity=ERROR
resource.type="chat.googleapis.com/Project"
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:
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:
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-08-04 UTC.
[null,null,["Última atualização 2025-08-04 UTC."],[[["\u003cp\u003eThis guide explains how to use Google Cloud Logs Explorer to query error logs for your Google Chat apps.\u003c/p\u003e\n"],["\u003cp\u003eBy querying logs, you can identify, understand the frequency of, and troubleshoot errors within your Chat app using descriptive error messages and log data.\u003c/p\u003e\n"],["\u003cp\u003eError logs can be queried using a specific query within Logs Explorer and examined for details such as error messages within their JSON payload.\u003c/p\u003e\n"],["\u003cp\u003eWhen using Cloud Logging, keep in mind potential costs and that logs related to other services used by your app may also be helpful for debugging.\u003c/p\u003e\n"]]],["To query Chat app error logs, access Google Cloud Logs Explorer and use the query `severity=ERROR resource.type=\"chat.googleapis.com/Project\"`. This allows you to identify user-encountered errors, their frequency, and view descriptive error messages. Click \"Run query\" for recent errors or \"Stream logs\" for live updates. Each error log contains a JSON payload, with the error message found under `jsonPayload.error.message`. Note that logs with `ERROR` severity are included and all error messages are in English.\n"],null,["This guide describes how to query Chat app error logs in [Google Cloud Logs Explorer](https://cloud.google.com/logging/docs/view/logs-viewer-interface). Query logs to:\n\n- Learn if users encounter errors.\n- See how often errors occur, and which are most frequent.\n- Read descriptive error messages and log data that help you fix the errors.\n\nPrerequisites\n\n- A Google Workspace account with access to Google Chat.\n- A Chat app. To build a Chat app, follow this [quickstart](/workspace/chat/quickstart/gcf-app).\n- [Turn on error logging](/workspace/chat/turn-on-error-logging) for the Chat app.\n\nQuery error logs\n\n1. In the Google Cloud console, click **Menu**\n menu\n \\\u003e **More products**\n \\\u003e **Logging**\n \\\u003e **Logs Explorer**.\n\n [Go to Log Explorer](https://console.cloud.google.com/logs/query)\n2. If necessary, to show the query builder, turn on **Show query**.\n\n3. For Chat app error logs, enter the following query:\n\n severity=ERROR\n resource.type=\"chat.googleapis.com/Project\"\n\n4. To see recent errors, click **Run query** . Or, to see errors as they occur, click **Stream logs**. Chat app error logs appear in the \"Query results\" pane.\n\nTo learn more about Google Cloud Logs Explorer and writing queries, see these guides in the Logs Explorer documentation:\n\n- [View logs by using the Logs Explorer](https://cloud.google.com/logging/docs/view/logs-viewer-interface)\n- [Build queries in the Logs Explorer](https://cloud.google.com/logging/docs/view/building-queries)\n\nRead an error message from a log\n\nAfter querying an error log, you can view individual logs which consist of a JSON payload describing the log. For Chat app errors, the JSON includes the error message at `jsonPayload.error.message`. For example, in the following sample log, the error message says that an Apps Script function failed to execute: \n\nJSON \n\n {\n \"insertId\": \"\u003cvar translate=\"no\"\u003eINSERT_ID\u003c/var\u003e\",\n \"jsonPayload\": {\n \"@type\": \"type.googleapis.com/google.chat.logging.v1.ChatAppLogEntry\",\n \"error\": {\n \"code\": 9,\n \"message\": \"An Apps Script function failed to execute. To review AppsScript error logs, see \\\"Logging\\\" (https://developers.google.com/apps-script/guides/logging).\"\n },\n \"deployment\": \"\u003cvar translate=\"no\"\u003eDEPLOYMENT_ID\u003c/var\u003e\"\n },\n \"resource\": {\n \"type\": \"chat.googleapis.com/Project\",\n \"labels\": {\n \"project_id\": \"\u003cvar translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e\"\n }\n },\n \"timestamp\": \"2022-12-06T05:24:18.697255Z\",\n \"severity\": \"ERROR\",\n \"logName\": \"projects/\u003cvar translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e/logs/chat.googleapis.com%2Ferrors\",\n \"receiveTimestamp\": \"2022-12-06T05:24:19.207936968Z\"\n }\n\nConsiderations\n\nAs you work with Chat app error logs in Google Cloud Logs Explorer, take note of these considerations:\n\n- For Google Chat apps, Logs Explorer currently includes logs with the following severities which help troubleshoot a malfunctioning app:\n\n - `ERROR`\n\n Logs of related services can also help debug a Chat app. For example, if a Chat app is deployed using [Google Cloud Functions](https://cloud.google.com/functions/docs), then it's a best practice to check Logs Explorer for Cloud Functions logs too.\n- Error messages are always written in English.\n\n- Cloud Logging incurs a cost. For further information on Cloud Logging pricing, refer to [Google Cloud's operations suite pricing](https://cloud.google.com/stackdriver/pricing).\n\nRelated topics\n\nAfter querying error logs, if you find errors, see the following guides for help fixing errors:\n\n- [Learn how to fix Google Chat app errors](/workspace/chat/troubleshoot-chat-apps) like \"App is not responding\", \"Google Chat API is only available to Google Workspace users\", or \"Users can be excluded from spaces\".\n- [Learn how to fix card errors](/workspace/chat/troubleshoot-cards) like card messages, dialogs, or link previews not rendering or working as expected.\n- [Learn how to debug.](/workspace/chat/debug-apps)"]]
