A telemetria de diagnóstico e a análise de erros permitem identificar e resolver falhas de solicitação nas APIs do Google e nas Cloud de Confiance by S3NS APIs. É possível inspecionar as métricas de uso da API, os registros do lado do cliente, os registros de auditoria do Cloud e as respostas de erro estruturadas para diagnosticar as causas raiz nos aplicativos.
Contexto
As APIs do Google são APIs conectadas fornecidas por serviços do Google. Os aplicativos podem acessar as APIs do Google via JSON HTTP e gRPC de diferentes ambientes. Recomendamos que os desenvolvedores usem as bibliotecas de cliente fornecidas pelo Google nos aplicativos. Essas bibliotecas implementam lógicas boilerplate comuns, como autenticação e paginação de listas, o que reduz consideravelmente a sobrecarga de desenvolvimento e os erros comuns.
Para mais informações, veja as Explicações sobre bibliotecas de clientes
Primeiros passos
Se você é novo nas APIs do Google, acesse a página
Primeiros passos para concluir as etapas de
preparação do seu aplicativo. Use o comando curl -v
para enviar solicitações de teste para as APIs do Google que você quer usar.
Assim você pode testar as APIs do Google sem escrever códigos.
Muitas vezes, é possível resolver muitos problemas antes de iniciar o desenvolvimento real de
aplicativos.
Para mais informações, consulte Primeiros passos.
Solução de problemas usando métricas
As APIs do Google fornecem métricas de API sem custo financeiro que abrangem aspectos comuns do uso da API, incluindo contagens de solicitações, erros, latências, tamanhos de solicitações e respostas. Elas oferecem dimensões refinadas em termos de aplicativos e locais. Os desenvolvedores podem descobrir o uso anormal da API e identificar possíveis causas raiz. Por exemplo, erros superiores a 400 podem significar que um aplicativo atualizado recentemente tem alguns bugs lógicos ou que tamanhos maiores de solicitações e respostas podem causar um desempenho mais lento do aplicativo.
Para mais informações, consulte API Monitoring.
Solução de problemas usando registros
Por motivos de segurança e privacidade, as APIs do Google geralmente não fornecem registros de API para desenvolvedores de aplicativos. É altamente recomendável que os desenvolvedores de aplicativos registrem erros de API no lado do cliente. É possível registrar os erros em um armazenamento local ou em uma API de registro remota, como a API Cloud Logging.
Os registros normalmente contêm mais informações sobre erros do que as métricas, como mensagens de erro e detalhes de erros. Eles são extremamente úteis e geralmente necessários para solucionar erros de API. Quando os desenvolvedores notam algum problema com o uso da API, eles podem consultar os registros para encontrar mensagens de erro e detalhes de erros e usar as informações para resolver os erros ou entrar em contato com o suporte.
Registros de auditoria do Cloud
Para atividades que apresentam riscos à segurança, os produtos do Google Cloud podem gerar registros de auditoria com informações detalhadas das atividades. Eles são uma ótima fonte de informações para solucionar problemas de uso das APIs do Google Cloud. Por exemplo, o recurso de simulação do VPC Service Controls gera registros de auditoria para que os administradores avaliem as futuras mudanças na política.
Saiba mais em Registros de auditoria do Cloud.
Como resolver erros
Se você tiver problemas com o uso da API do Google e encontrar as métricas e os registros correspondentes, siga a página de erro do guia de design de API para resolver os erros.
Em geral, cada erro de API tem três informações: código do erro, mensagem de erro e detalhes do erro:
- O código do erro permite que os aplicativos processem o erro no nível mais alto, como tentar novamente após erros
503ou autenticar novamente os usuários após erros401. A mensagem de erro ajuda os desenvolvedores de aplicativos a entender o erro e corrigir a lógica do aplicativo.
Os detalhes do erro contêm outras informações que os aplicativos podem usar para lidar com o erro de maneira programática.
Para mais informações, confira a página Erros.