Instrument pour Cloud Trace

Ce document fournit une brève présentation sur la manière d'instrumenter votre application pour Cloud Trace. Pour obtenir des instructions détaillées sur la configuration de Cloud Trace, consultez les pages de configuration spécifiques à chaque langage.

Cloud Trace fournit des données de traçage distribuées pour vos applications. Après avoir instrumenté votre application, vous pouvez inspecter les données de latence d'une seule requête et afficher la latence globale d'une application entière dans la console Cloud Trace.

Quand instrumenter votre application

Lorsque les données de trace ne sont pas capturées automatiquement, vous devez instrumenter votre application pour les collecter.

Vous pouvez instrumenter votre application de sorte qu'elle collecte des informations spécifiques à l'application. Plusieurs frameworks d'instrumentation Open Source vous permettent de collecter des métriques, des journaux et des traces à partir de votre application et d'envoyer ces données à n'importe quel fournisseur, y compris Google Cloud. Pour instrumenter votre application, nous vous recommandons d'utiliser un framework d'instrumentation Open Source neutre du point du vue du fournisseur, tel qu'OpenTelemetry, plutôt que des API spécifiques aux fournisseurs et aux produits ou des bibliothèques clientes.

Pour en savoir plus sur l'instrumentation de vos applications à l'aide de frameworks d'instrumentation indépendants du fournisseur, consultez la page Instrumentation et observabilité.

Comment instrumenter les applications

Pour instrumenter vos applications afin de collecter des données de trace, vous pouvez effectuer l'une des opérations suivantes:

Quand créer des délais

Les bibliothèques clientes Cloud Trace gèrent généralement un contexte de trace global contenant des informations sur le délai actuel, y compris son ID de trace et si la trace est échantillonnée. Ces bibliothèques créent généralement des délais sur les limites RPC. Cependant, vous devrez peut-être créer des délais si l'algorithme de création par défaut n'est pas suffisant pour vos besoins.

Le délai actif actuel est accessible par le contexte de trace global, parfois encapsulé dans un objet Traceur. Vous pouvez ajouter des informations pertinentes à votre application en utilisant des annotations et des tags personnalisés pour les délais existants, ou créer des délais enfants avec leurs propres annotations et tags pour suivre le comportement de l'application avec une plus grande précision. Comme le contexte est global, les applications multithread qui mettent à jour le contexte doivent utiliser l'isolation appropriée.

Quand fournir des identifiants d'authentification

En règle générale, vous n'avez pas besoin de fournir des identifiants d'authentification à votre application ni de spécifier l'ID de votre projet Google Cloud lorsque vous l'exécutez sur Google Cloud. Pour certains langages, vous devez spécifier votre ID de projet Google Cloud même si vous exécutez sur Google Cloud. De plus, si vous utilisez le mode Autopilot pour Google Kubernetes Engine ou si vous activez Workload Identity, vous devez configurer votre application pour qu'elle utilise Workload Identity.

Si vous exécutez en dehors de Google Cloud, vous devez fournir des identifiants d'authentification à votre application. Vous devez également spécifier votre ID de projet Google Cloud dans votre application.

Pour en savoir plus, consultez les pages de configuration propres à chaque langue.

Forcer le traçage d'une requête

À moins que votre application n'échantillonne toujours chaque délai, il n'est généralement pas possible de forcer le traçage d'une requête de bout en bout, car chaque composant d'une requête de bout en bout prend sa propre décision concernant l'échantillonnage. Toutefois, vous pouvez influencer la décision en ajoutant à l'en-tête de trace une option sampled, que vous définissez sur true. Ce paramètre indique aux composants enfants comment échantillonner la requête. Pour en savoir plus sur les en-têtes de trace, consultez la section Protocoles pour la propagation contextuelle.

Pour les composants en aval dont vous êtes propriétaire de code, vous devez déterminer si votre logique d'instrumentation respecte l'option sampled. Par exemple, lorsque vous utilisez OpenTelemetry pour l'instrumentation, vous pouvez utiliser l'échantillonneur ParentBased pour vous assurer que l'indicateur d'échantillon parent est respecté.

Les services Google Cloud qui enregistrent les informations de traçage dans Cloud Trace acceptent généralement l'indicateur d'échantillonnage parent comme indice. Cependant, la plupart d'entre eux utilisent également un échantillonnage de limite de débit. Chaque service Google Cloud détermine s'il accepte le traçage, la manière dont l'indicateur d'échantillonnage parent est utilisé et la limite de débit pour l'échantillonnage.

Mettre en corrélation les données de métrique et de trace

Vous pouvez corréler les données de métriques à valeur de distribution avec des traces en joignant des exemples aux points de données de métriques. Si vous suivez les étapes de configuration nécessaires, OpenTelemetry, la bibliothèque d'instrumentation recommandée, ajoute automatiquement ces exemples. Pour en savoir plus, consultez Corréler des métriques et des traces à l'aide d'exemples.

Configurer votre projet et votre plate-forme

  1. Assurez-vous que l'API Cloud Trace est activée.

    Par défaut, l'API Cloud Trace est activée pour les projets Google Cloud et aucune action n'est requise de votre part. Toutefois, les contraintes de sécurité définies par votre organisation peuvent avoir désactivé l'API. Pour obtenir des informations de dépannage, consultez la page Développer des applications dans un environnement Google Cloud contraint.

    Activez l'API Cloud Trace

    Activer l'API

  2. Configurez votre plate-forme.

    Vous pouvez utiliser Cloud Trace sur Google Cloud et d'autres plates-formes.

    • Google Cloud: lorsque votre application s'exécute sur Google Cloud, vous n'avez pas besoin de fournir des identifiants d'authentification sous la forme d'un compte de service à la bibliothèque cliente. Vous devez toutefois vous assurer que le champ d'application de l'accès à l'API Cloud Trace est activé sur votre plate-forme Google Cloud Platform.

      Pour les configurations suivantes, les paramètres de niveau d'accès par défaut incluent le niveau d'accès l'API Cloud Trace:

      Si vous utilisez des niveaux d'accès personnalisés, vous devez vous assurer que le champ d'application de l'accès à l'API Cloud Trace est activé. Par exemple, si vous utilisez la Google Cloud CLI pour créer un cluster GKE et que vous spécifiez l'option --scopes, assurez-vous que le champ d'application inclut trace.append. La commande suivante montre comment définir l'option --scopes:

      gcloud container clusters create example-cluster-name --scopes=https://www.googleapis.com/auth/trace.append

    • Exécution locale et ailleurs: si votre application s'exécute en dehors de Google Cloud, vous devez fournir des identifiants d'authentification sous la forme d'un compte de service à la bibliothèque cliente. Le compte de service doit disposer du rôle Agent Cloud Trace (roles/cloudtrace.agent). Pour en savoir plus sur les rôles, consultez la page Contrôler les accès avec IAM.

      Les bibliothèques clientes Google Cloud utilisent les identifiants par défaut de l'application (ADC) pour trouver les identifiants de votre application. Vous pouvez fournir ces identifiants de trois manières:

      • Exécuter gcloud auth application-default login

      • Placez le compte de service dans un chemin d'accès par défaut pour votre système d'exploitation. Voici la liste des chemins d'accès par défaut pour Windows et Linux:

        • Windows : %APPDATA%/gcloud/application_default_credentials.json

        • Linux : $HOME/.config/gcloud/application_default_credentials.json

      • Définissez la variable d'environnement GOOGLE_APPLICATION_CREDENTIALS sur le chemin d'accès à votre compte de service:

        Linux/macOS

          export GOOGLE_APPLICATION_CREDENTIALS=path-to-your-service-accounts-private-key

        Windows

          set GOOGLE_APPLICATION_CREDENTIALS=path-to-your-service-accounts-private-key

        Powershell :

          $env:GOOGLE_APPLICATION_CREDENTIALS="path-to-your-service-accounts-private-key"

Étapes suivantes

Pour obtenir des informations de configuration détaillées, des exemples et des liens vers GitHub et d'autres dépôts Open Source, accédez à la page de configuration de votre langage.