La telemetría de diagnóstico y el análisis de errores te permiten identificar y resolver fallas de solicitudes en las APIs de Google y las Cloud de Confiance by S3NS APIs. Puedes inspeccionar las métricas de uso de la API, los registros del cliente, los registros de auditoría de Cloud y las respuestas de error estructuradas para diagnosticar las causas raíz en tus aplicaciones.
Fondo
Las APIs de Google son APIs en red que proporcionan los servicios de Google. Las aplicaciones pueden acceder a las APIs de Google a través de JSON HTTP y gRPC desde diferentes entornos. Recomendamos a los desarrolladores que usen las bibliotecas cliente que proporciona Google en sus aplicaciones. Estas bibliotecas implementan una lógica de código estándar común, como la autenticación y la paginación de listas, lo que reduce en gran medida la sobrecarga de desarrollo y los errores comunes.
Para obtener más información, consulta Explicación de las bibliotecas cliente.
Comenzar
Si eres nuevo en las APIs de Google, debes seguir la
página Cómo comenzar para completar los
pasos de preparación de tu aplicación. Primero, debes usar el comando curl -v para enviar solicitudes de prueba a las APIs de Google que deseas usar.
Te permite experimentar con las APIs de Google sin escribir código.
A menudo, puedes resolver muchos problemas antes de comenzar el desarrollo real de la aplicación.
Para obtener más información, consulta Cómo comenzar.
Soluciona problemas con las métricas
Las APIs de Google proporcionan métricas de API gratuitas que abarcan aspectos comunes del uso de la API, incluidos los recuentos de solicitudes, los errores, las latencias y los tamaños de solicitud y respuesta. Proporcionan dimensiones detalladas en términos de aplicaciones y ubicaciones. Los desarrolladores pueden descubrir el uso anormal de la API y, también, identificar posibles causas raíz. Por ejemplo, una mayor cantidad de errores 400 puede significar que una aplicación actualizada recientemente tiene algunos errores lógicos, o bien que los tamaños de solicitud y respuesta más grandes pueden provocar un rendimiento más lento de la aplicación.
Para obtener más información, consulta el uso de API de Monitoring.
Soluciona problemas con los registros
Por motivos de seguridad y privacidad, las APIs de Google generalmente no proporcionan registros de API a los desarrolladores de aplicaciones. Recomendamos a los desarrolladores de aplicaciones que registren los errores de la API en el cliente. Puedes registrar los errores en un almacenamiento local o en una API de registro remoto, como la API de Cloud Logging.
Por lo general, los registros contienen más información sobre los errores que las métricas, como mensajes de error y detalles de errores. Son extremadamente útiles y, a menudo, necesarios para solucionar problemas de errores de la API. Cuando los desarrolladores notan algún problema con el uso de la API, pueden consultar los registros para encontrar mensajes de error y detalles de errores, y usar la información para resolver los errores o comunicarse con el equipo de asistencia.
Registros de auditoría de Cloud
Para las actividades sensibles a la seguridad, los productos de Google Cloud pueden generar registros de auditoría que contengan información detallada de las actividades. Son una excelente fuente de información para solucionar problemas relacionados con el uso de las APIs de Google Cloud. Por ejemplo, la función de ejecución de prueba de Controles del servicio de VPC genera registros de auditoría para que los administradores evalúen los próximos cambios en las políticas.
Para obtener más información, consulta Registros de auditoría de Cloud.
Resolviendo errores
Si tienes problemas con el uso de la API de Google y encontraste las métricas y los registros correspondientes, puedes seguir la página de error Errores de la Guía de diseño de APIs para resolver los errores.
En general, cada error de la API tiene 3 datos: código de error, mensaje de error y detalles del error:
- El código de error permite que las aplicaciones controlen el error en el nivel superior, como volver a intentar después de errores
503o volver a autenticar a los usuarios después de errores401. El mensaje de error permite que los desarrolladores de aplicaciones comprendan el error y corrijan la lógica de su aplicación.
Los detalles del error contienen información adicional que las aplicaciones pueden usar para controlar el error de forma programática.
Para obtener más información, consulta la página Errores.