Usa las métricas del cliente de gRPC

En esta página, se describe cómo emitir métricas del cliente gRPC a Cloud Monitoring cuando usas gRPC para interactuar con Cloud Storage a través de una de las siguientes interfaces compatibles:

Las métricas del cliente se pueden usar para supervisar el rendimiento de la aplicación cliente que interactúa con Cloud Storage a través de gRPC. La métrica del cliente difiere de las métricas del servidor, que proporcionan estadísticas sobre el rendimiento de Cloud Storage desde la perspectiva del servidor.

Cómo funciona

Puedes habilitar la emisión de métricas del cliente a Cloud Monitoring cuando usas gRPC para interactuar con Cloud Storage a través de una de las interfaces compatibles.

Precios

Las métricas del cliente de Cloud Storage no son facturables, lo que significa que puedes emitir, almacenar y acceder a ellas sin incurrir en cargos de Cloud Monitoring. Para obtener más información sobre los precios, consulta los precios de Google Cloud Observability.

Antes de comenzar

Para usar métricas del cliente, primero debes completar los siguientes pasos:

  1. Verifica que la biblioteca cliente o el conector de Cloud Storage que deseas usar sean compatibles con gRPC. Las siguientes bibliotecas cliente y conectores de Cloud Storage admiten gRPC:

  2. Configura la autenticación.

  3. Habilita la API de Cloud Monitoring.

  4. Habilita la API de Cloud Storage.

    Ir a la API de Cloud Storage

  5. Configura los roles y permisos necesarios para emitir métricas del cliente.

Roles obligatorios

Para establecer los permisos que necesitas para emitir métricas del cliente de gRPC a Cloud Monitoring, otorga el rol de IAM de Escritor de métricas de Monitoring (roles/monitoring.metricWriter) en la cuenta de servicio que usa el cliente de gRPC.

Este rol predefinido contiene los permisos necesarios para emitir métricas del cliente de gRPC a Cloud Monitoring. Para ver los permisos exactos que son necesarios, consulta la sección Permisos requeridos:

Permisos necesarios

  • monitoring.timeSeries.create

Este permiso de IAM se incluye en los siguientes roles predefinidos de Cloud Storage:

También puedes obtener estos permisos con otros roles personalizados o roles predefinidos. Para obtener más información sobre el rol de Monitoring Metric Writer, consulta la documentación de IAM sobre roles/monitoring.metricWriter.

Descripciones de las métricas

En las siguientes secciones, se describen las métricas del cliente de Cloud Storage que se pueden usar para supervisar el rendimiento del cliente de gRPC.

Métricas del cliente por intento

Las siguientes métricas recopilan datos de rendimiento sobre los intentos individuales que realiza un cliente para comunicarse con un servidor. Las métricas por intento del cliente pueden ayudarte a medir el comportamiento de reintento, los embudos y optimizar la comunicación entre un cliente y un servidor.

Métrica completa Descripción Tipo de instrumento Unidad Atributos
storage.googleapis.com/client/grpc/client/attempt/started Preview: Es la cantidad total de intentos de RPC iniciados, incluidos los que no se completaron. Contador {attempt}
  • grpc.method: Es el nombre completo del método gRPC, incluidos el paquete, el servicio y el método.
  • grpc.target: Es el URI de destino canonizado que se usa cuando se crea el canal de gRPC.
storage.googleapis.com/client/grpc/client/attempt/duration Preview. Es el tiempo de extremo a extremo que se toma para completar un intento de RPC, incluido el tiempo que lleva elegir un subcanal. Histograma s
  • grpc.method: Nombre completo del método gRPC, incluidos el paquete, el servicio y el método.
  • grpc.target: Es el URI de destino canonizado que se usa cuando se crea el canal de gRPC.
  • grpc.status: Código de estado del servidor de gRPC recibido, como OK, CANCELLED o DEADLINE_EXCEEDED.
  • grpc.lb.locality: Es la localidad a la que se envía el tráfico. Se establecerá en el atributo del solucionador que se pasó desde la política weighted_target o en la cadena vacía si no se estableció el atributo del solucionador.
storage.googleapis.com/client/grpc/client/attempt/sent_total_compressed_message_size Preview: Es el total de bytes, comprimidos pero no encriptados, que se envían en todos los mensajes de solicitud, excepto los metadatos, por intento de RPC. Esto no incluye los bytes de gRPC ni de encuadre de transporte. Histograma By
  • grpc.method: Nombre completo del método gRPC, incluidos el paquete, el servicio y el método.
  • grpc.target: Es el URI de destino canonizado que se usa cuando se crea el canal de gRPC.
  • grpc.status: Código de estado del servidor de gRPC recibido, como OK, CANCELLED o DEADLINE_EXCEEDED.
  • grpc.lb.locality: Es la localidad a la que se envía el tráfico. Se establecerá en el atributo del solucionador que se pasó desde la política weighted_target o en la cadena vacía si el atributo del solucionador no se estableció.
storage.googleapis.com/client/grpc/client/attempt/rcvd_total_compressed_message_size Preview: Es el total de bytes, comprimidos pero no encriptados, que se reciben en todos los mensajes de respuesta, excepto los metadatos, por intento de RPC. Esto no incluye los bytes de gRPC ni de encuadre de transporte. Histograma By
  • grpc.method: Nombre completo del método gRPC, incluidos el paquete, el servicio y el método.
  • grpc.target: Es el URI de destino canonizado que se usa cuando se crea el canal de gRPC.
  • grpc.status: Código de estado del servidor de gRPC recibido, como OK, CANCELLED o DEADLINE_EXCEEDED.
  • grpc.lb.locality: Es la localidad a la que se envía el tráfico. Se establecerá en el atributo del solucionador que se pasó desde la política weighted_target o en la cadena vacía si el atributo del solucionador no se estableció.

Para obtener más información sobre los instrumentos por intento del cliente, consulta la documentación de métricas de OpenTelemetry en GitHub.

Métricas del cliente por llamada

Las siguientes métricas proporcionan una vista agregada de todo el ciclo de vida de una llamada del cliente a un servidor. Las métricas por llamada del cliente proporcionan datos de alto nivel sobre las llamadas del cliente, métricas de seguimiento para comprender los patrones de llamadas y te ayudan a identificar las frecuencias de los errores.

Métrica completa Descripción Tipo de instrumento Unidad Atributos
storage.googleapis.com/client/grpc/client/call/duration Preview: Mide el tiempo de extremo a extremo que tarda la biblioteca de gRPC en completar una RPC desde la perspectiva de la aplicación. Histograma s
  • grpc.method: Nombre completo del método gRPC, incluidos el paquete, el servicio y el método.
  • grpc.target: Es el URI de destino canonizado que se usa cuando se crea el canal de gRPC.
  • grpc.status: Código de estado del servidor de gRPC recibido, como OK, CANCELLED o DEADLINE_EXCEEDED.

Para obtener más información sobre los instrumentos de cliente por llamada, consulta la documentación de métricas de OpenTelemetry en GitHub.

Métricas de detección de carga de solicitudes

Las siguientes métricas proporcionan estadísticas sobre la eficacia del uso de la detección de carga de solicitudes de tu aplicación cliente. Las métricas de detección de carga de solicitudes pueden ayudarte a equilibrar las cargas del servidor, optimizar el uso de recursos y mejorar los tiempos de respuesta del cliente. Las siguientes métricas solo están disponibles con conectividad directa.

Métrica completa Descripción Tipo de instrumento Unidad Atributos
storage.googleapis.com/client/grpc/lb/rls/cache_entries Preview: Es la cantidad de entradas en la caché de detección de carga de solicitudes. Indicador {entry}
  • grpc.target: Indica el destino del canal de gRPC en el que se usa el WRR.
  • grpc.lb.rls.server_target: Es el URI de destino con el que se comunica el servidor de detección de carga de solicitudes.
  • grpc.lb.rls.instance_uuid: Es un identificador único universal (UUID) para una instancia de cliente individual de detección de carga de solicitudes. El valor no es significativo por sí solo, pero es útil para diferenciar entre las instancias de cliente de detección de carga de solicitudes en los casos en que hay varias instancias en el mismo canal de gRPC o en los que hay varios canales para el mismo destino.
storage.googleapis.com/client/grpc/lb/rls/cache_size Preview: Es el tamaño actual de la caché de detección de carga de solicitudes. Indicador By
  • grpc.target: Es el destino del canal de gRPC en el que se usa el WRR.
  • grpc.lb.rls.server_target: Es el URI de destino con el que se comunica el servidor de detección de carga de solicitudes.
  • grpc.lb.rls.instance_uuid: Es un UUID para una instancia de cliente individual de detección de carga de solicitudes. El valor no es significativo por sí solo, pero es útil para diferenciar entre las instancias de cliente de detección de carga de solicitudes en los casos en que hay varias instancias en el mismo canal de gRPC o en los que hay varios canales para el mismo destino.
storage.googleapis.com/client/grpc/lb/rls/default_target_picks Preview: Es la cantidad de selecciones del balanceador de cargas (LB) que se envían al destino predeterminado. Contador {pick}
  • grpc.target: Indica el destino del canal de gRPC en el que se usa la detección de carga de solicitudes.
  • grpc.lb.rls.server_target: Es el URI de destino del servidor de detección de carga de solicitudes con el que se comunicará.
  • grpc.lb.rls.data_plane_target: Es una cadena de destino que usa la detección de carga de solicitudes para enrutar el tráfico del plano de datos. El valor lo devuelve el servidor de detección de carga de solicitudes para una clave en particular o se configura como el objetivo predeterminado en la configuración de detección de carga de solicitudes.
  • grpc.lb.pick_result:Es el resultado de una selección de LB, como "complete", "fail" o "drop".
storage.googleapis.com/client/grpc/lb/rls/target_picks Preview. Es la cantidad de selecciones del LB que se envían a cada objetivo de detección de carga de la solicitud. Si el servidor de detección de carga de solicitudes también devuelve el destino predeterminado, las RPCs que se envían a ese destino desde la caché se contabilizan en esta métrica, no en grpc.rls.default_target_picks. Contador {pick}
  • grpc.target: Es el destino del canal de gRPC en el que se usa la detección de carga de solicitudes.
  • grpc.lb.rls.server_target: Es el URI de destino del servidor de detección de carga de solicitudes con el que se comunicará.
  • grpc.lb.rls.data_plane_target: Es una cadena de destino que utiliza la detección de carga de solicitudes para enrutar el tráfico del plano de datos. El valor lo devuelve el servidor de detección de carga de solicitudes para una clave en particular o se configura como el objetivo predeterminado en la configuración de detección de carga de solicitudes.
  • grpc.lb.pick_result: Es el resultado de una selección de LB, como "complete", "fail" o "drop".
storage.googleapis.com/client/grpc/lb/rls/failed_picks Preview: Es la cantidad de selecciones de LB que fallaron debido a una solicitud de detección de carga fallida o a la limitación del canal de detección de carga de la solicitud. Contador {pick}
  • grpc.target: Es el destino del canal de gRPC en el que se usa la detección de carga de solicitudes.
  • grpc.lb.rls.server_target: Es el URI de destino del servidor de detección de carga de solicitudes con el que se comunicará.

Métricas del cliente del servicio de xDiscovery

Las siguientes métricas proporcionan estadísticas sobre cómo tu aplicación cliente interactúa con el plano de control del servicio xDiscovery (xDS) para descubrir y configurar conexiones a los servicios de backend. Las métricas de xDS pueden ayudarte a hacer un seguimiento de la latencia de las solicitudes de servicio, supervisar las actualizaciones de configuración y optimizar el rendimiento general de xDS.

Las siguientes métricas solo están disponibles con conectividad directa.

Métrica completa Descripción Tipo de instrumento Unidad Atributos
storage.googleapis.com/client/grpc/xds_client/connected Preview. Mide si el cliente de xDS tiene o no una transmisión de ADS en funcionamiento hacia el servidor de xDS. En el caso de un servidor determinado, esta métrica se establece en 1 cuando se crea el flujo inicialmente. Si hay una falla de conectividad o cuando falla la transmisión de ADS sin ver un mensaje de respuesta según A57, la métrica se establece en 0. Una vez que se establece en 0, la métrica se restablecerá en 1 cuando se reciba la primera respuesta en una transmisión de ADS. Esta métrica solo está disponible para las bibliotecas cliente de Cloud para C++. Indicador {bool}
  • grpc.target: Para los clientes, indica el destino del canal de gRPC en el que se usa XdsClient. Para los servidores, será la cadena "#server".
  • grpc.xds.server: Es el URI de destino del servidor xDS con el que se comunica XdsClient.
storage.googleapis.com/client/grpc/xds_client/resource_updates_invalid Preview: Es la cantidad de recursos recibidos que se consideraron no válidos. Esta métrica solo está disponible para las bibliotecas cliente de Cloud para C++. Contador {resource}
  • grpc.target: Para los clientes, indica el destino del canal de gRPC en el que se usa XdsClient. Para los servidores, será la cadena "#server".
  • grpc.xds.server: Es el URI de destino del servidor xDS con el que se comunica XdsClient.
  • grpc.xds.resource_type: Indica un tipo de recurso xDS, como "envoy.config.listener.v3.Listener".
storage.googleapis.com/client/grpc/xds_client/resource_updates_valid Preview: Es la cantidad de recursos recibidos que se consideraron válidos, incluso si no se modificaron. Esta métrica solo está disponible para las bibliotecas cliente de Cloud para C++. Contador {resource}
  • grpc.target: Para los clientes, indica el destino del canal de gRPC en el que se usa XdsClient. Para los servidores, será la cadena "#server".
  • grpc.xds.server: Es el URI de destino del servidor xDS con el que se comunica XdsClient.
  • grpc.xds.resource_type: Indica un tipo de recurso xDS, como "envoy.config.listener.v3.Listener".
storage.googleapis.com/client/grpc/xds_client/resources Preview: Es la cantidad de recursos xDS. Esta métrica solo está disponible para las bibliotecas cliente de Cloud para C++. Indicador {resource}
  • grpc.target: Para los clientes, indica el destino del canal de gRPC en el que se usa XdsClient. Para los servidores, será la cadena "#server".
  • grpc.xds.authority: Es la autoridad de xDS. El valor será "#old" para los nombres de recursos que no sean de xdstp y que se hayan identificado en la API de xDS, antes de la introducción de la representación de URI xdstp://.
  • grpc.xds.cache_state: Indica el estado de la caché de un recurso xDS.
  • grpc.xds.resource_type indica un tipo de recurso de xDS, como "envoy.config.listener.v3.Listener".
storage.googleapis.com/client/grpc/xds_client/server_failure Preview: Es la cantidad de servidores de xDS que ya no funcionan correctamente y que no están disponibles, están sobrecargados o proporcionan datos de configuración incorrectos o no válidos. Esta métrica solo está disponible para las bibliotecas cliente de Cloud para C++. Contador {failure}
  • grpc.target: Es el URI de destino del servidor de xDS con el que se comunica XdsClient.
  • grpc.xds.server: Para los clientes, indica el destino del canal de gRPC en el que se usa XdsClient. Para los servidores, esta es la cadena "#server".

Para obtener más información sobre las métricas del cliente de xDS, consulta la documentación sobre el balanceo de cargas global basado en xDS en GitHub.

Cómo inhabilitar las métricas del cliente

Si es necesario, puedes inhabilitar las métricas del cliente.

Java

public GrpcStorageOptions.Builder setEnableGrpcClientMetrics(false enableGrpcClientMetrics)

Para obtener más información, consulta el método GrpcStorageOptions.Builder de la clase de las bibliotecas cliente de Cloud para Java para las métricas del cliente de gRPC.

C++

Para inhabilitar las métricas del cliente para la API de gRPC con las bibliotecas cliente de Cloud para C++, consulta Struct EnableGrpcMetricsOption.

Si usas Bazel para compilar tu aplicación y quieres inhabilitar las métricas del cliente, configura la opción enable_grpc_metrics en false en el archivo de compilación de tu aplicación.