Utiliser les métriques gRPC côté client

Cette page explique comment émettre des métriques côté client gRPC vers Cloud Monitoring lorsque vous utilisez gRPC pour interagir avec Cloud Storage à l'aide de l'une des interfaces compatibles suivantes :

Les métriques côté client peuvent être utilisées pour surveiller les performances de l'application cliente qui interagit avec Cloud Storage à l'aide de gRPC. La métrique côté client diffère des métriques côté serveur, qui fournissent des insights sur les performances de Cloud Storage du point de vue du serveur.

Fonctionnement

Vous pouvez choisir d'envoyer des métriques côté client à Cloud Monitoring lorsque vous utilisez gRPC pour interagir avec Cloud Storage à l'aide de l'une des interfaces compatibles.

Tarifs

Les métriques côté client Cloud Storage ne sont pas facturables. Vous pouvez donc émettre, stocker et accéder à ces métriques sans encourir de frais Cloud Monitoring. Pour en savoir plus sur les tarifs, consultez la page Tarifs de Google Cloud Observability.

Avant de commencer

Pour utiliser les métriques côté client, vous devez d'abord effectuer les étapes suivantes :

  1. Vérifiez que la bibliothèque cliente ou le connecteur Cloud Storage que vous souhaitez utiliser est compatible avec gRPC. Les bibliothèques clientes et connecteurs Cloud Storage suivants sont compatibles avec gRPC :

  2. Configurez l'authentification.

  3. Activez l'API Cloud Monitoring.

  4. Activez l'API Cloud Storage.

    Accéder à l'API Cloud Storage

  5. Définissez les rôles et autorisations requis pour émettre des métriques côté client.

Rôles requis

Pour définir les autorisations nécessaires pour émettre des métriques côté client gRPC vers Cloud Monitoring, accordez le rôle IAM Rédacteur de métriques Monitoring (roles/monitoring.metricWriter) au compte de service utilisé par le client gRPC.

Ce rôle prédéfini contient les autorisations requises pour émettre des métriques côté client gRPC vers Cloud Monitoring. Pour connaître les autorisations exactes requises, consultez la section Autorisations requises :

Autorisations requises

  • monitoring.timeSeries.create

Cette autorisation IAM est incluse dans les rôles Cloud Storage prédéfinis suivants :

Vous pouvez également obtenir ces autorisations avec des rôles personnalisés ou d'autres rôles prédéfinis. Pour en savoir plus sur le rôle "Rédacteur de métriques Monitoring", consultez la documentation IAM concernant roles/monitoring.metricWriter.

Descriptions des métriques

Les sections suivantes décrivent les métriques Cloud Storage côté client qui peuvent être utilisées pour surveiller les performances du client gRPC.

Métriques côté client par tentative

Les métriques suivantes collectent des données sur les performances des tentatives individuelles effectuées par un client pour communiquer avec un serveur. Les métriques par tentative du client peuvent vous aider à mesurer le comportement des nouvelles tentatives, les goulots d'étranglement et à optimiser la communication entre un client et un serveur.

Métrique complète Description Type d'instrument Unité Attributs
storage.googleapis.com/client/grpc/client/attempt/started Preview : nombre total de tentatives de RPC lancées, y compris celles qui ne sont pas terminées. Compteur {attempt}
  • grpc.method : nom complet de la méthode gRPC, y compris le package, le service et la méthode.
  • grpc.target : URI cible canonique utilisé lors de la création du canal gRPC.
storage.googleapis.com/client/grpc/client/attempt/duration Preview. Temps de bout en bout nécessaire pour effectuer une tentative RPC, y compris le temps nécessaire pour sélectionner un sous-canal. Histogramme s
  • grpc.method : nom complet de la méthode gRPC, y compris le package, le service et la méthode.
  • grpc.target : URI cible canonique utilisé lors de la création du canal gRPC.
  • grpc.status : code d'état du serveur gRPC reçu (par exemple, OK, CANCELLED ou DEADLINE_EXCEEDED)
  • grpc.lb.locality : localité vers laquelle le trafic est envoyé. Cette valeur sera définie sur l'attribut de résolution transmis par la règle weighted_target ou sur une chaîne vide si l'attribut de résolution n'est pas défini.
storage.googleapis.com/client/grpc/client/attempt/sent_total_compressed_message_size Preview : nombre total d'octets, compressés mais non chiffrés, envoyés par tous les messages de requête, à l'exception des métadonnées, par tentative RPC. Cela n'inclut pas les octets de tramage gRPC ou de transport. Histogramme By
  • grpc.method : nom complet de la méthode gRPC, y compris le package, le service et la méthode.
  • grpc.target : URI cible canonique utilisé lors de la création du canal gRPC.
  • grpc.status : code d'état du serveur gRPC reçu (par exemple, OK, CANCELLED ou DEADLINE_EXCEEDED).
  • grpc.lb.locality : localité vers laquelle le trafic est envoyé. Cette valeur sera définie sur l'attribut de résolution transmis par la règle weighted_target, ou sur une chaîne vide si l'attribut de résolution n'est pas défini.
storage.googleapis.com/client/grpc/client/attempt/rcvd_total_compressed_message_size Preview : nombre total d'octets (compressés, mais non chiffrés) reçus par tous les messages de réponse, à l'exception des métadonnées, par tentative de RPC. Cela n'inclut pas les octets de tramage gRPC ou de transport. Histogramme By
  • grpc.method : nom complet de la méthode gRPC, y compris le package, le service et la méthode.
  • grpc.target : URI cible canonique utilisé lors de la création du canal gRPC.
  • grpc.status : code d'état du serveur gRPC reçu (par exemple, OK, CANCELLED ou DEADLINE_EXCEEDED).
  • grpc.lb.locality : localité vers laquelle le trafic est envoyé. Cette valeur sera définie sur l'attribut de résolveur transmis par la règle weighted_target, ou sur une chaîne vide si l'attribut de résolveur n'est pas défini.

Pour en savoir plus sur les instruments par tentative du client, consultez la documentation sur les métriques OpenTelemetry sur GitHub.

Métriques client par appel

Les métriques suivantes fournissent une vue globale de l'ensemble du cycle de vie d'un appel client vers un serveur. Les métriques par appel du client fournissent des données de haut niveau sur les appels du client, des métriques de suivi pour comprendre les schémas d'appel et vous aident à identifier les fréquences d'erreurs.

Métrique complète Description Type d'instrument Unité Attributs
storage.googleapis.com/client/grpc/client/call/duration Preview : mesure le temps de bout en bout nécessaire à la bibliothèque gRPC pour effectuer un RPC du point de vue de l'application. Histogramme s
  • grpc.method : nom complet de la méthode gRPC, y compris le package, le service et la méthode.
  • grpc.target : URI cible canonique utilisé lors de la création du canal gRPC.
  • grpc.status : code d'état du serveur gRPC reçu (par exemple, OK, CANCELLED ou DEADLINE_EXCEEDED)

Pour en savoir plus sur les instruments par appel du client, consultez la documentation sur les métriques OpenTelemetry sur GitHub.

Métriques de détection de la charge des requêtes

Les métriques suivantes fournissent des informations sur l'efficacité de l'utilisation de la détection de la charge de requêtes par votre application cliente. Les métriques de détection de charge des requêtes peuvent vous aider à équilibrer les charges du serveur, à optimiser l'utilisation des ressources et à améliorer les temps de réponse des clients. Les métriques suivantes ne sont disponibles qu'avec la connectivité directe.

Métrique complète Description Type d'instrument Unité Attributs
storage.googleapis.com/client/grpc/lb/rls/cache_entries Preview. Nombre d'entrées dans le cache de détection de la charge de la requête. Jauge {entry}
  • grpc.target : indique la cible du canal gRPC dans lequel le WRR est utilisé.
  • grpc.lb.rls.server_target : URI cible du serveur de détection de charge de requête avec lequel le serveur communique.
  • grpc.lb.rls.instance_uuid : identifiant unique universel (UUID) pour une instance client de détection de la charge de requête individuelle. La valeur n'est pas significative en elle-même, mais elle est utile pour différencier les instances clientes de détection de charge de requête lorsqu'il existe plusieurs instances dans le même canal gRPC ou plusieurs canaux vers la même cible.
storage.googleapis.com/client/grpc/lb/rls/cache_size Preview. Taille actuelle du cache de détection de charge des requêtes. Jauge By
  • grpc.target : cible du canal gRPC dans lequel le WRR est utilisé.
  • grpc.lb.rls.server_target : URI cible auquel le serveur de détection de la charge de requête s'adresse.
  • grpc.lb.rls.instance_uuid : UUID d'une instance de client de détection de charge de requête individuelle. La valeur n'a pas de sens en soi, mais elle est utile pour différencier les instances clientes de détection de la charge de requêtes dans les cas où il existe plusieurs instances dans le même canal gRPC ou plusieurs canaux vers la même cible.
storage.googleapis.com/client/grpc/lb/rls/default_target_picks Preview : nombre de sélections d'équilibreur de charge (LB) envoyées à la cible par défaut. Compteur {pick}
  • grpc.target : indique la cible du canal gRPC dans lequel la détection de charge des requêtes est utilisée.
  • grpc.lb.rls.server_target : URI cible du serveur de détection de charge de requête avec lequel communiquer.
  • grpc.lb.rls.data_plane_target : chaîne cible utilisée par la détection de la charge de la requête pour le routage du trafic du plan de données. La valeur est soit renvoyée par le serveur de détection de charge des requêtes pour une clé particulière, soit configurée comme cible par défaut dans la configuration de détection de charge des requêtes.
  • grpc.lb.pick_result : résultat d'une sélection d'équilibrage de charge, tel que "complete", "fail" ou "drop".
storage.googleapis.com/client/grpc/lb/rls/target_picks Preview : nombre de choix d'équilibrage de charge envoyés à chaque cible de détection de charge de requête. Si la cible par défaut est également renvoyée par le serveur de détection de charge des requêtes, les RPC envoyés à cette cible à partir du cache sont comptabilisés dans cette métrique, et non dans grpc.rls.default_target_picks. Compteur {pick}
  • grpc.target : cible du canal gRPC dans lequel la détection de charge des requêtes est utilisée.
  • grpc.lb.rls.server_target : URI cible du serveur de détection de charge de requêtes avec lequel communiquer.
  • grpc.lb.rls.data_plane_target : chaîne cible utilisée par la détection de la charge de la requête pour le routage du trafic du plan de données. La valeur est renvoyée par le serveur de détection de charge des requêtes pour une clé particulière ou configurée comme cible par défaut dans la configuration de détection de charge des requêtes.
  • grpc.lb.pick_result : résultat d'une sélection LB, par exemple "complete", "fail" ou "drop".
storage.googleapis.com/client/grpc/lb/rls/failed_picks Preview : nombre de sélections LB ayant échoué en raison d'une demande de détection de charge ayant échoué ou d'une limitation du canal de détection de charge des demandes. Compteur {pick}
  • grpc.target : cible du canal gRPC dans lequel la détection de charge des requêtes est utilisée.
  • grpc.lb.rls.server_target : URI cible du serveur de détection de la charge de la requête avec lequel communiquer.

Métriques du client du service xDiscovery

Les métriques suivantes fournissent des insights sur la façon dont votre application cliente interagit avec le plan de contrôle xDiscovery Service (xDS) pour découvrir et configurer les connexions aux services de backend. Les métriques xDS peuvent vous aider à suivre la latence des demandes de service, à surveiller les mises à jour de configuration et à optimiser les performances xDS globales.

Les métriques suivantes ne sont disponibles qu'avec la connectivité directe.

Métrique complète Description Type d'instrument Unité Attributs
storage.googleapis.com/client/grpc/xds_client/connected Preview : indique si le client xDS dispose ou non d'un flux ADS opérationnel vers le serveur xDS. Pour un serveur donné, cette métrique est définie sur 1 lors de la création initiale du flux. En cas d'échec de connectivité ou d'échec du flux ADS sans message de réponse conformément à A57, la métrique est définie sur 0. Une fois définie sur 0, la métrique est réinitialisée sur 1 lorsque la première réponse est reçue sur un flux ADS. Cette métrique n'est disponible que pour les bibliothèques clientes Cloud pour C++. Jauge {bool}
  • grpc.target : pour les clients, indique la cible du canal gRPC dans lequel XdsClient est utilisé. Pour les serveurs, la chaîne sera "#server".
  • grpc.xds.server : URI cible du serveur xDS avec lequel XdsClient communique.
storage.googleapis.com/client/grpc/xds_client/resource_updates_invalid Preview. Nombre de ressources reçues considérées comme non valides. Cette métrique n'est disponible que pour les bibliothèques clientes Cloud pour C++. Compteur {resource}
  • grpc.target : pour les clients, indique la cible du canal gRPC dans lequel XdsClient est utilisé. Pour les serveurs, la chaîne sera "#server".
  • grpc.xds.server : URI cible du serveur xDS avec lequel le XdsClient communique.
  • grpc.xds.resource_type : indique un type de ressource xDS, tel que "envoy.config.listener.v3.Listener".
storage.googleapis.com/client/grpc/xds_client/resource_updates_valid Preview. Nombre de ressources reçues considérées comme valides, même si elles n'ont pas été modifiées. Cette métrique n'est disponible que pour les bibliothèques clientes Cloud pour C++. Compteur {resource}
  • grpc.target : pour les clients, indique la cible du canal gRPC dans lequel XdsClient est utilisé. Pour les serveurs, il s'agit de la chaîne "#server".
  • grpc.xds.server : URI cible du serveur xDS avec lequel le XdsClient communique.
  • grpc.xds.resource_type : indique un type de ressource xDS, tel que "envoy.config.listener.v3.Listener".
storage.googleapis.com/client/grpc/xds_client/resources Preview : nombre de ressources xDS. Cette métrique n'est disponible que pour les bibliothèques clientes Cloud pour C++. Jauge {resource}
  • grpc.target : pour les clients, indique la cible du canal gRPC dans lequel XdsClient est utilisé. Pour les serveurs, il s'agit de la chaîne "#server".
  • grpc.xds.authority : autorité xDS. La valeur sera "#old" pour les noms de ressources non xdstp identifiés dans l'API xDS, avant l'introduction de la représentation URI xdstp://.
  • grpc.xds.cache_state : indique l'état du cache d'une ressource xDS.
  • grpc.xds.resource_type indique un type de ressource xDS, tel que "envoy.config.listener.v3.Listener".
storage.googleapis.com/client/grpc/xds_client/server_failure Preview : nombre de serveurs xDS qui ne fonctionnent plus correctement et qui sont devenus indisponibles, surchargés ou qui fournissent des données de configuration incorrectes ou non valides. Cette métrique n'est disponible que pour les bibliothèques clientes Cloud pour C++. Compteur {failure}
  • grpc.target : URI cible du serveur xDS avec lequel XdsClient communique.
  • grpc.xds.server : pour les clients, cela indique la cible du canal gRPC dans lequel le XdsClient est utilisé. Pour les serveurs, il s'agit de la chaîne "#server".

Pour en savoir plus sur les métriques du client xDS, consultez la documentation sur l'équilibrage de charge mondial basé sur xDS sur GitHub.

Désactiver les métriques côté client

Vous pouvez désactiver les métriques côté client si nécessaire.

Java

public GrpcStorageOptions.Builder setEnableGrpcClientMetrics(false enableGrpcClientMetrics)

Pour en savoir plus, consultez la méthode de classe GrpcStorageOptions.Builder des bibliothèques clientes Cloud pour Java pour les métriques du client gRPC.

C++

Pour désactiver les métriques côté client pour l'API gRPC à l'aide des bibliothèques clientes Cloud pour C++, consultez Struct EnableGrpcMetricsOption.

Si vous utilisez Bazel pour créer votre application et que vous souhaitez désactiver les métriques côté client, définissez l'option enable_grpc_metrics sur false dans le fichier de compilation de votre application.