Supervisar el uso de la API

En esta página, se describe cómo usar las métricas de API para realizar un seguimiento y comprender el uso de las APIs de Google y las APIs de Google Cloud.

Las API de Google producen métricas de uso detalladas que pueden ayudarte a hacer lo siguiente:

• Realizar un seguimiento del uso de las API de Google y comprender su uso.
• Supervisar el rendimiento de las aplicaciones y las API de Google.
• Descubre problemas entre tus aplicaciones y las API de Google.

Puede acelerar de forma drástica los tiempos de resolución cuando solucionas problemas o necesitas asistencia técnica de Google.

Las métricas que producen las API de Google son las señales estándar que usan los ingenieros de confiabilidad de sitios de Google para evaluar el estado de un servicio. Estas métricas abarcan los recuentos de solicitudes, las tasas de errores, las latencias totales, las latencias de backend, los tamaños de las solicitudes y los tamaños de respuesta. Para ver las definiciones de las métricas de la API, consulta la documentación de Cloud Monitoring.

Puedes ver las métricas de la API en dos lugares: el panel de la API y Cloud Monitoring. Las métricas que ves son específicas de tu proyecto y no reflejan el estado general del servicio.

Usa el panel de la API

La forma más simple de ver las métricas de tu API es usar el Panel de la API de la consola de Google Cloud. Puedes ver una descripción general de todo el uso de las API o desglosar el uso de una API específica.

Para ver una descripción general del uso de la API, sigue estos pasos:

1. Visita la sección APIs y servicios de la consola de Cloud. El panel principal de la API se muestra de forma predeterminada. En esta página, puedes ver todas las API que tienes habilitadas en la actualidad en tu proyecto y los gráficos de descripción general para las métricas siguientes:

   • Tráfico: la cantidad de solicitudes por segundo que realiza el proyecto o acerca de estas en las API habilitadas
   • Errores: El porcentaje de solicitudes a las API habilitadas que generaron errores
   • Latencia mediana: La latencia mediana para las solicitudes a las API habilitadas, si están disponibles.

Nota: El “Visualizador del proyecto” El permiso de IAM es suficiente para ver este panel.

A fin de ver los detalles de uso para una API específica, realiza lo siguiente:

1. Selecciona la API que quieres ver en la lista de las API del panel principal de las API. La página de descripción general de las API muestra un gráfico de tráfico detallado con un desglose por código de respuesta.

2. Para obtener información de uso más detallada, selecciona Ver métricas. De forma predeterminada, se muestran los siguientes gráficos compilados con anterioridad, aunque hay más disponibles:

   • Tráfico por código de respuesta
   • Errores por método de API
   • Latencia general en los percentiles 50, 95 y 99
   • Latencia por método de API (mediana)

3. Si quieres agregar más gráficos, puedes seleccionar gráficos compilados con anterioridad desde el menú desplegable Seleccionar grafos.

Usar Cloud Monitoring

Si usas Cloud Monitoring, puedes profundizar en los datos de la métrica disponibles con el Explorador de métricas a fin de obtener mejores estadísticas del uso de la API. Cloud Monitoring es compatible con una amplia variedad de métricas que puedes combinar con filtros y demás para obtener vistas nuevas y detalladas del rendimiento de las aplicaciones. Por ejemplo, puedes combinar una métrica de recuento de solicitudes con un filtro en la clase Código de respuesta HTTP a fin de compilar un panel que muestre las tasas de error en el tiempo o puedes mirar la latencia percentil 95 de las solicitudes a la API de Cloud Pub/Sub.

Métricas disponibles

En la siguiente tabla, se indican las métricas de serviceruntime disponibles. Las métricas de uso de la API son aquellas que incluyen consumed_api como recurso supervisado.

Las strings de “tipo de métrica” de esta tabla deben tener el prefijo serviceruntime.googleapis.com/. Este prefijo se omitió en las entradas de la tabla. Cuando consultes una etiqueta, usa el prefijo metric.labels.. Por ejemplo, metric.labels.LABEL="VALUE".

Tipo de métrica ^Etapa de lanzamiento (niveles de jerarquía de recursos) Nombre visible
Clase, tipo, unidad Recursos supervisados	Descripción Etiquetas
api/request_count ^DG  (proyecto) Recuento de solicitudes
DELTA, INT64, 1 api consumed_api produced_api	Es el recuento de solicitudes completadas. Se hace un muestreo cada 60 segundos. Después del muestreo, los datos no se podrán ver durante un máximo de 1,800 segundos. protocol: El protocolo de la solicitud, p.ej., “http”, “grpc”. response_code: El código de respuesta HTTP para las solicitudes HTTP, o el código equivalente de HTTP para las solicitudes gRPC. Consulta la asignación de código en https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto. response_code_class: Es la clase del código de respuesta para las solicitudes HTTP o la clase equivalente de HTTP para las solicitudes de gRPC, p. ej., “2xx” o “4xx”. grpc_status_code: El código de respuesta numérico de gRPC para las solicitudes de gRPC, o el código equivalente de gRPC para las solicitudes HTTP. Consulta la asignación de código en https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto.
api/request_latencies ^GA  (project) Latencias de solicitud
DELTA, DISTRIBUTION, s api consumed_api produced_api	Distribución de latencias en segundos para solicitudes que no son de transmisión. Se hace un muestreo cada 60 segundos. Después del muestreo, los datos no se podrán ver durante un máximo de 1,800 segundos.
api/request_latencies_backend ^GA  (proyecto) Solicita latencias de backend
DELTA, DISTRIBUTION, s api produced_api	Distribución de latencias de backend en segundos para solicitudes que no son de transmisión. Se hace un muestreo cada 60 segundos. Luego del muestreo, los datos no son visibles durante un máximo de 1,800 segundos.
api/request_latencies_overhead ^GA (proyecto) Latencias de sobrecarga de solicitudes
DELTA, DISTRIBUTION, s api produced_api	Distribución de las latencias de solicitud en segundos para solicitudes que no son de transmisión, sin incluir el backend. Se hace un muestreo cada 60 segundos. Luego del muestreo, los datos no son visibles durante un máximo de 1,800 segundos.
api/request_sizes ^GA (proyecto) Tamaños de las solicitudes
DELTA, DISTRIBUTION, By api consumed_api produced_api	Distribución de los tamaños de las solicitudes en bytes registrados cuando se completa la solicitud. Se hace un muestreo cada 60 segundos. Después del muestreo, los datos no se podrán ver durante un máximo de 1,800 segundos.
api/response_sizes ^GA (proyecto) Tamaños de las respuestas
DELTA, DISTRIBUTION, By api consumed_api produced_api	Distribución de los tamaños de las respuestas en bytes registrados cuando se completa la solicitud. Se hace un muestreo cada 60 segundos. Después del muestreo, los datos no se podrán ver durante un máximo de 1,800 segundos.
quota/allocation/usage ^GA (proyecto, carpeta, organización) Uso de la cuota de asignación
GAUGE, INT64, 1 consumer_quota producer_quota	Es la cuota de asignación total consumida. Se descartan los valores informados si son superiores a 1/min. Si no se reciben cambios en el uso de la cuota, el último valor se repite al menos cada 24 horas. Se tomaron muestras cada 60 segundos. quota_metric: El nombre de la métrica de cuota o el grupo de cuotas.
quota/concurrent/exceeded ^ALPHA (proyecto, carpeta, organización) Cuota simultánea excedida
DELTA, INT64, 1 consumer_quota	La cantidad de veces que se intentó superar la cuota simultánea. Se hace un muestreo cada 86,400 segundos. Luego del muestreo, los datos no son visibles durante un máximo de 180 segundos. limit_name: El nombre del límite de cuota, como "Solicitudes por día" o “Direcciones IP en uso”. quota_metric: El nombre de la métrica de cuota o el grupo de cuotas. time_window: El tamaño de la ventana para los límites de operaciones simultáneas.
quota/concurrent/limit ^ALPHA (proyecto, carpeta, organización) Límite de cuota simultánea
GAUGE, INT64, 1 consumer_quota producer_quota	El límite simultáneo de la cuota. Se toman muestras cada 86,400 segundos. Luego del muestreo, los datos no son visibles durante un máximo de 180 segundos. limit_name: El nombre del límite de cuota, como "Solicitudes por día" o “Direcciones IP en uso”. quota_metric: Es el nombre de la métrica o el grupo de cuotas. time_window: Es el tamaño de la ventana para los límites de operaciones simultáneas.
quota/concurrent/usage ^ALPHA (proyecto, carpeta, organización) Uso simultáneo de la cuota
GAUGE, INT64, 1 consumer_quota producer_quota	El uso simultáneo de la cuota. Se hace un muestreo cada 60 segundos. Luego del muestreo, los datos no son visibles durante un máximo de 180 segundos. limit_name: El nombre del límite de cuota, como "Solicitudes por día" o “Direcciones IP en uso”. quota_metric: Es el nombre de la métrica o el grupo de cuotas. time_window: El tamaño de la ventana para los límites de operaciones simultáneas.
quota/exceeded ^GA  (project, folder, organization) Error de cuota excedida
GAUGE, BOOL, 1 consumer_quota	El error ocurrió cuando se superó el límite de la cuota. Se tomaron muestras cada 60 segundos. limit_name: Es el nombre del límite de cuota, como “Solicitudes por día” o “Direcciones IP en uso”. quota_metric: El nombre de la métrica de cuota o el grupo de cuotas.
quota/limit ^GA  (project, folder, organization) Límite de cuota
GAUGE, INT64, 1 consumer_quota producer_quota	Es el límite de la cuota. Se tomaron muestras cada 86,400 segundos. limit_name: El nombre del límite de cuota, como "Solicitudes por día" o “Direcciones IP en uso”. quota_metric: El nombre de la métrica de cuota o el grupo de cuotas.
quota/rate/net_usage ^GA  (project, folder, organization) Calcular el uso de la cuota
DELTA, INT64, 1 consumer_quota producer_quota	Es la cuota de frecuencia de consumo total. Se hace un muestreo cada 60 segundos. Luego del muestreo, los datos no son visibles durante un máximo de 240 segundos. method: El nombre del método de la API, como "disks.list". quota_metric: Es el nombre de la métrica o el grupo de cuotas.
reserved/metric1 ^EARLY_ACCESS  (project) Obsoleto
DELTA, INT64, 1 deprecated_resource	Obsoleto. Se hace un muestreo cada 60 segundos. Luego del muestreo, los datos no son visibles durante un máximo de 180 segundos. quota_name: Obsoleto. credential_id: Obsoleto. quota_location: Obsoleto.

Tabla generada al 3 de octubre de 2024 a las 16:53:41 UTC.

Para ver las métricas de la API en el Explorador de métricas, selecciona API consumida como el tipo de recurso y, luego, selecciona una de las métricas serviceruntime. Luego, usa el filtro y las opciones de agregación para definir mejor tus datos. Una vez que encuentres la información de uso de la API que deseas, puedes usar Cloud Monitoring para crear alertas y paneles personalizados que te ayudarán a supervisar y mantener una aplicación sólida. Puedes obtener información sobre cómo hacer esto en las siguientes páginas:

• Compila gráficos
• Introducción a las alertas
• Administra las políticas de alertas

Para obtener más información, consulta el Explorador de métricas.

Soluciona problemas con las métricas de la API

Las métricas de la API pueden ser muy útiles si necesitas comunicarte con Google cuando tienes un problema y también podrían indicarte que no es necesario hacerlo. Por ejemplo:

• Si todas las llamadas a un servicio solo fallan para un ID de credencial, lo más probable es que haya un problema con esa cuenta que puedes solucionar con facilidad sin abrir un ticket.
• Estás solucionando un problema con la app y notas una correlación entre el rendimiento degradado de la aplicación y un aumento sostenido en la latencia percentil 50 de un servicio fundamental de GCP. Llámanos y cuéntanos sobre esos datos para poder comenzar a trabajar en el problema lo antes posible.
• Las latencias para un informe de servicio de GCP se ven bien y sin cambios, pero las métricas de la app informan que la latencia en llamadas al servicio es inusualmente alta. Eso indica que hay problemas en la red. Comunícate con tu operador de red (Google, en algunos casos) para iniciar el proceso de depuración.

Recomendaciones

Aunque las métricas de la API son una herramienta muy útil, hay problemas que tienes que considerar a fin de asegurarte de que proporcionen información importante, en particular cuando se configuran alertas según valores de métrica. Las recomendaciones siguientes te ayudarán a aprovechar al máximo los datos de las métricas de la API.

¿La latencia causa problemas?

Algunos servicios son sensibles a la latencia y otros al escalamiento y a la confiabilidad. Algunas API, Cloud Storage o BigQuery, por ejemplo, pueden tener unos segundos de latencia alta sin que los clientes lo noten. Con datos de las métricas de la API, puedes averiguar lo que necesitan los usuarios de un servicio dado.

Busca cambios de la norma

Antes de emitir una alerta en un valor de métrica particular, considera qué es en realidad un comportamiento inusual. Si miras las métricas de la API, puedes ver que los resultados de la latencia para la mayoría de los servicios se encuentran dentro de una distribución normal: una gran concentración y valores atípicos a cada lado. Las métricas ayudan a entender la distribución normal para que puedas diseñar tu app a fin de que funcione bien en la curva de distribución. Las métricas también pueden ayudarte a correlacionar cambios de la distribución con momentos en los que la app no funciona como está previsto y descubrir la causa de un problema. Se espera que el percentil 99 se vea muy diferente que la mediana, lo que no se esperan son los cambios dramáticos en esos percentiles con el paso del tiempo.

También puedes notar que algunos tipos de solicitudes llevan más tiempo que otras. Si el tamaño medio de una foto subida en Google Photos es de 4 MB, pero en general subes archivos RAW de 20 MB, el tiempo promedio de carga de 20 fotos es peor que el de la mayoría de los usuarios, pero sigue siendo tu comportamiento normal.

Eso significa que no es de gran utilidad alertar la primera vez que se detecta una RPC de un segundo o una llamada de 5xx HTTP. En cambio, cuando investigas un Servicio de Google como una causa posible de un problema que experimenta la aplicación, compara los códigos de retorno y las tasas de latencia en el tiempo y busca cambios continuos de la norma relacionados con los problemas observados en la aplicación.

Tasa de tráfico

Las métricas de la API son más útiles cuando tienes un volumen grande de tráfico en la API. Si llamas a un servicio solo de manera intermitente, las métricas de la API no serán válidas de manera estadística y no proporcionarán información de evaluación significativa.

Por ejemplo, si quieres hacer un seguimiento de la latencia percentil de 99.5 de un servicio y solo realizas 100 llamadas por hora, verificar la medición de un período de dos horas solo te daría un dato que representa el percentil de 99.5 que no tiene mucha información sobre el comportamiento normal de la API o de la aplicación. Asegúrate de que la tasa de tráfico, el percentil al que sigues y el período que consideras generen algún dato de interés o los datos de supervisión no serán útiles.

API admitidas

Todas las API de Google y las de Google Cloud, así como las API compiladas sobre Cloud Endpoints y API Gateway, admiten las métricas de la API. Si eres un consumidor de la API, puedes ver las métricas de la API consumidas en el panel de la API. Si eres un productor de API, puedes ver las métricas de la API producidas en el panel de Endpoints.