data_de_atualização: 06/01/2023
Google Cloud fornece as ferramentas para monitorar a confiabilidade dos projetos com Google Cloud Monitoring e depurar problemas com registros de erros Google Cloud Logging. Sempre que ocorre uma falha ao atender às intents do usuário, o pipeline do Google Home Analytics registra essa falha nas métricas e publica um registro de erro nos registros do projeto.
Há duas etapas para solucionar os erros:
- Monitore o estado dos seus projetos com métricas de casa inteligente.
- Investigue os problemas verificando as descrições detalhadas nos registros de erros.
Como monitorar erros
Você pode usar Google Cloud Monitoring dashboards para acessar as métricas do projeto. Alguns gráficos importantes são especialmente úteis para monitorar a qualidade e a depuração:
- O gráfico Taxa de sucesso é o primeiro gráfico a ser usado quando você está monitorando a confiabilidade dos projetos. As quedas neste gráfico podem indicar uma interrupção para uma parte ou toda a base de usuários. Recomendamos monitorar com atenção este gráfico em busca de irregularidades após cada mudança ou atualização do projeto.
- Os gráficos de Detalhamento de erros são mais úteis para solucionar problemas nas integrações. Para cada erro destacado no gráfico de porcentagem de sucesso, um código de erro é exibido no detalhamento. Confira os erros sinalizados pelo Google Home platform e como resolvê-los na tabela abaixo.
Códigos de erro da plataforma
Confira alguns códigos de erro comuns que podem aparecer nos registros do projeto para identificar problemas detectados pelo Google Home platform. Consulte a tabela a seguir para saber como solucionar problemas.
| Código do erro | Descrição |
|---|---|
BACKEND_FAILURE_URL_ERROR |
O Google recebeu um código de erro HTTP 4xx diferente do 401 do seu
serviço.
Use o requestId no GCP Logging para verificar os registros
de serviços de casa inteligente.
|
BACKEND_FAILURE_URL_TIMEOUT |
A solicitação do Google expirou ao tentar acessar seu serviço.
Verifique se o serviço está on-line, aceita conexões e não está acima da capacidade. Além disso, verifique se o dispositivo de destino está ligado, on-line e sincronizado. |
BACKEND_FAILURE_URL_UNREACHABLE |
O Google recebeu um código de erro HTTP 5xx do seu serviço.
Use o requestId no GCP Logging para verificar os registros
de serviços de casa inteligente.
|
DEVICE_NOT_FOUND |
O dispositivo não existe no lado do serviço do parceiro.
Isso normalmente indica uma falha na sincronização de dados ou uma disputa. |
GAL_BAD_3P_RESPONSE |
O Google não pode analisar a resposta do serviço de vinculação de contas
devido a formatos ou valores inválidos no payload.
Use o requestId no GCP Logging para verificar os registros de erros
no serviço de vinculação de contas.
|
GAL_INTERNAL |
Ocorreu um erro interno do Google quando ele tentou recuperar um token de acesso.
Se você vir uma taxa maior desse erro no GCP Logging, entre em contato para mais informações. |
GAL_INVALID_ARGUMENT |
Ocorreu um erro interno do Google quando ele tentou recuperar um token de acesso.
Se você vir uma taxa maior desse erro no GCP Logging, entre em contato para mais informações. |
GAL_NOT_FOUND |
Os tokens de acesso e de atualização do usuário armazenados no Google são invalidados e não podem mais ser atualizados. O usuário precisa
vincular a conta novamente para continuar usando o serviço.
Se você vir uma taxa maior desse erro no GCP Logging, entre em contato para mais informações. |
GAL_PERMISSION_DENIED |
Ocorreu um erro interno do Google quando o compartilhamento de token não é autorizado.
Se você vir uma taxa maior desse erro no GCP Logging, entre em contato para mais informações. |
GAL_REFRESH_IN_PROGRESS |
O token de acesso do usuário expirou, e outra tentativa simultânea de
atualização já está em andamento.
Isso não é um problema, e você não precisa fazer nada. |
INVALID_AUTH_TOKEN |
O Google recebeu um código de erro HTTP 401 do seu serviço.
O token de acesso não expirou, mas foi invalidado pelo serviço. Use o requestId no GCP Logging para verificar os registros do serviço de casa inteligente.
|
INVALID_JSON |
Não é possível analisar ou entender a resposta JSON.
Confira se há sintaxes inválidas na estrutura da resposta JSON, como colchetes não correspondentes, vírgulas ausentes ou caracteres inválidos. |
OPEN_AUTH_FAILURE |
O token de acesso do usuário expirou e o Google não consegue atualizá-lo ou recebeu um código de erro HTTP 401 do seu serviço.
Se você notar uma taxa maior desse código, verifique se também ocorre um aumento na taxa de erros relacionados a intents de casa inteligente ou solicitações de token de atualização. |
PARTNER_RESPONSE_INVALID_ERROR_CODE |
A resposta indica um código de erro não reconhecido.
Se a resposta da solicitação indicar um erro, use um fornecido pelos nossos códigos de erro compatíveis. |
PARTNER_RESPONSE_INVALID_PAYLOAD |
Não é possível analisar o campo payload da resposta como um objeto JSON.
Verifique se o campo de payload na resposta da solicitação tem colchetes correspondentes e está estruturado corretamente como um campo JSON. |
PARTNER_RESPONSE_INVALID_STATUS |
A resposta não indica um status ou indica um status incorreto.
As respostas às solicitações de fulfillment da intent precisam indicar um status com SUCCESS, OFFLINE, ERROR, EXCEPTIONS. Veja mais informações sobre
como lidar com erros e exceções.
|
PARTNER_RESPONSE_MISSING_COMMANDS_AND_DEVICES |
Uma ou mais intents presentes na solicitação estão ausentes na
resposta.
Verifique se a resposta de execução está estruturada corretamente e se os resultados de todas as intents da solicitação estão presentes na resposta. |
PARTNER_RESPONSE_MISSING_DEVICE |
Um ou mais dispositivos presentes na solicitação estão ausentes na
resposta.
Verifique se a resposta de execução está estruturada corretamente e se todos os IDs de dispositivos da solicitação estão presentes na resposta. |
PARTNER_RESPONSE_MISSING_PAYLOAD |
A resposta não contém um campo payload.
Inclua um campo de payload na resposta da solicitação. Saiba mais sobre como criar corretamente uma resposta de execução. |
PARTNER_RESPONSE_NOT_OBJECT |
Não é possível analisar a resposta como um objeto JSON.
Verifique se há caracteres indesejados, colchetes de correspondência ou erros de formatação em todos os campos da resposta da solicitação. Alguns caracteres Unicode podem não ser compatíveis. Além disso, verifique se a resposta está estruturada corretamente como um objeto JSON. |
PROTOCOL_ERROR |
Falha ao processar a solicitação.
Use o requestId no Google Cloud Logging para verificar os
registros do serviço de casa inteligente.
|
RESPONSE_TIMEOUT |
A solicitação expirou enquanto aguardava a resposta.
O tempo limite para enviar uma resposta é de nove segundos a partir do envio da solicitação. Envie uma resposta dentro desse período. |
RESPONSE_UNAVAILABLE |
Nenhuma resposta é recebida ou a resposta não indica o status.
As respostas às solicitações de fulfillment da intent precisam ser estruturadas de acordo com os documentos de casa inteligente e indicar o status. |
TRANSIENT_ERROR |
Um erro temporário é um erro que se resolve sozinho.
Normalmente, esses erros se manifestam como uma conexão a um dispositivo ou serviço que está sendo descartado. Também se não for possível abrir novas conexões com um servidor. |
Logs de pesquisa
Quando você se sentir à vontade para monitorar suas integrações usando métricas, a próxima etapa é resolver erros específicos usando Cloud Logging. Um registro de erro é uma entrada do tipo JSON com campos que contêm informações úteis, como horário, código de erro e detalhes sobre a intent de casa inteligente de origem.
Há vários sistemas em Google Cloud que enviam registros para seu projeto a todo momento. É preciso escrever consultas para filtrar seus registros e encontrar os de que você precisa. As consultas podem ser baseadas em um intervalo de tempo, recurso, gravidade de registro ou entradas personalizadas.
Use os botões de consulta para criar filtros personalizados.
Para especificar um período, clique no botão de seleção de período e escolha uma das opções fornecidas. Isso vai filtrar os registros e mostrar aqueles do período selecionado.
Para especificar um Resource, clique no menu suspenso Resource e escolha Google Assistente Action Project. Isso adiciona um filtro à consulta para mostrar registros do projeto.
Use o botão Gravidade para filtrar por Emergência, Informações, Depuração e outros níveis de registro de gravidade.
Também é possível usar o campo "Consulta" no Logs Explorer
para inserir entradas personalizadas. O mecanismo de consulta usado por esse campo é compatível com consultas básicas, como correspondência de string, e tipos mais avançados de consultas, incluindo comparadores (<, >=, !=) e operadores booleanos (AND, OR, NOT).
Por exemplo, a entrada personalizada abaixo retornaria erros
originados de um tipo de dispositivo LIGHT:
resource.type = "assistant_action_project" AND severity = ERROR AND jsonPayload.executionLog.executionResults.actionResults.device.deviceType = "LIGHT"
Acesse a Biblioteca de consultas para encontrar mais exemplos de como consultar registros com eficiência.
Como testar correções
Depois de identificar erros e aplicar atualizações para corrigi-los, recomendamos testar as correções com o Google Home Test Suite. Oferecemos um guia do usuário sobre como usar Test Suite, que mostra como testar suas mudanças de maneira eficaz.
Recursos de aprendizagem
Este documento apresenta as etapas para resolver erros na ação de casa inteligente. Você também pode conferir nossos codelabs para saber mais sobre depuração:
- Codelab: Depuração de casa inteligente: guia de início rápido para depurar a integração com a nuvem de casa inteligente.
- Codelab: Depuração de casa local: guia de início rápido para depurar a integração local de casa inteligente.