Interroger et analyser les traces

Ce document explique comment interroger et analyser vos données de trace à l'aide d' Observability Analytics, qui fournit une interface de requête basée sur SQL. SQL vous permet d'effectuer une analyse agrégée, ce qui peut vous aider à générer des insights et à identifier des tendances. Pour afficher les résultats de votre requête, utilisez des tableaux ou des graphiques. Vous pouvez également enregistrer ces tableaux et graphiques dans vos tableaux de bord personnalisés.

Si vous souhaitez afficher ou explorer des traces ou des délais individuels, ou afficher des attributs associés à des délais, utilisez la page Explorateur de traces. Pour en savoir plus sur cette page, consultez Rechercher et explorer des traces.

Pour analyser vos données de trace, interrogez la vue par défaut, nommée _AllSpans. Cette vue inclut toutes les données de trace stockées par votre projet. Le bucket d'observabilité correspondant est nommé _Trace. Pour en savoir plus sur le stockage de vos données de trace, consultez Présentation du stockage des traces.

À propos des ensembles de données BigQuery associés

Vous n'avez pas besoin d'un ensemble de données BigQuery associé pour interroger vos données de trace, ni pour interroger vos données de trace et de journal. Dans ces cas, vous pouvez utiliser la page Observability Analytics. Pour en savoir plus sur l'interrogation des données de journal, consultez Interroger et analyser des journaux avec Observability Analytics.

Vous avez besoin d'un ensemble de données BigQuery associé lorsque vous souhaitez effectuer l'une des opérations suivantes :

• Joindre des données de trace à d'autres ensembles de données BigQuery.
• Interroger des données de trace à partir d'un autre service, tel que la page BigQuery Studio ou Data Studio.
• Améliorer les performances des requêtes que vous exécutez à partir de Observability Analytics en les exécutant sur vos emplacements réservés BigQuery.
• Surveiller les résultats de vos requêtes SQL à l'aide d'une règle d'alerte.

Ce document ne décrit pas comment créer un ensemble de données BigQuery associé ni comment configurer Observability Analytics pour exécuter des requêtes sur des emplacements réservés. Pour en savoir plus sur ces sujets, consultez Créer un ensemble de données BigQuery associé.

Avant de commencer

Connectez-vous à votre Google Cloud compte. Si vous débutez sur Google Cloud, créez un compte pour évaluer les performances de nos produits en conditions réelles. Les nouveaux clients bénéficient également de 300 $ de crédits sans frais pour exécuter, tester et déployer des charges de travail.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Observability API.

Roles required to enable APIs

To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

Enable the API

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Observability API.

Roles required to enable APIs

To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

Enable the API

1. Pour obtenir les autorisations nécessaires pour charger la page Observability Analytics , écrire, exécuter et enregistrer des requêtes privées sur vos données de trace, demandez à votre administrateur de vous accorder les rôles IAM suivants :

   • Accesseur de vue d'observabilité (roles/observability.viewAccessor) sur les vues d'observabilité que vous souhaitez interroger. Ce rôle est compatible avec les conditions IAM, qui vous permettent de limiter l'octroi à une vue spécifique. Si vous n'associez pas de condition à l'octroi de rôle, le compte principal peut accéder à toutes les vues d'observabilité.
   • Utilisateur Observability Analytics (roles/observability.analyticsUser) sur votre projet. Ce rôle contient les autorisations requises pour enregistrer et exécuter des requêtes privées, ainsi que pour exécuter des requêtes partagées.

   Pour en savoir plus sur l'attribution de rôles, consultez Gérer l'accès aux projets, aux dossiers et aux organisations.

   Vous pouvez également obtenir les autorisations requises via des rôles personnalisés ou d'autres rôles prédéfinis.

Afficher le schéma

Le schéma définit la manière dont les données sont stockées, y compris les champs et leurs types de données. Ces informations sont importantes, car le schéma détermine les champs que vous interrogez et si vous devez convertir des champs en différents types de données. Par exemple, pour écrire une requête qui calcule la latence moyenne des requêtes HTTP, vous devez savoir comment accéder au champ de latence et s'il est stocké sous forme d'entier comme 100 ou sous forme de chaîne comme "100". Si les données de latence sont stockées sous forme de chaîne, la requête doit convertir la valeur en valeur numérique avant de calculer une moyenne.

Pour identifier le schéma, procédez comme suit :

1. Dans la Google Cloud console, accédez à la manage_search Observability Analytics page :

   Accéder à Observability Analytics

   Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Logging.

2. Dans le menu Vues, accédez à la section Traces , puis sélectionnez _Trace.Spans._AllSpans.

   Le volet Schéma est mis à jour. Observability Analytics déduit automatiquement les champs d'une colonne lorsque le type de données est JSON. Pour afficher la fréquence d'apparition de ces champs déduits dans vos données, cliquez sur more_vert Options , puis sélectionnez Afficher les informations et la description.

   Pour en savoir plus sur le schéma, consultez Schéma de stockage des données de trace.

   Si vous ne voyez pas de vue nommée _Trace.Spans._AllSpans, cela signifie que votre Google Cloud projet ne contient pas de bucket d'observabilité nommé _Trace. Pour savoir comment résoudre cet échec, consultez Échec de l'initialisation du stockage des traces.

Interroger les données de trace

Cette section décrit les approches que vous pouvez utiliser pour interroger vos données de trace :

• Chargez une requête définie par le système, modifiez-la, puis exécutez-la.
• Saisissez et exécutez une requête personnalisée. Par exemple, vous pouvez coller une requête que vous possédez ou en écrire une. Les requêtes personnalisées peuvent inclure des jointures, des requêtes imbriquées et d'autres instructions SQL complexes. Pour obtenir des exemples, consultez Exemples de requêtes SQL.
• Créez une requête en effectuant des sélections dans le menu, puis exécutez-la. Observability Analytics convertit vos sélections en requête SQL, que vous pouvez afficher et modifier.

Charger, modifier et exécuter la requête définie par le système

1. Dans la Google Cloud console, accédez à la manage_search Observability Analytics page :

   Accéder à Observability Analytics

   Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Logging.

2. Dans le menu Vues, accédez à la section Traces , puis sélectionnez _Trace.Spans._AllSpans.

   Si vous ne voyez pas de vue nommée _Trace.Spans._AllSpans, cela signifie que votre Google Cloud projet ne contient pas de bucket d'observabilité nommé _Trace. Pour savoir comment résoudre cet échec, consultez Échec de l'initialisation du stockage des traces.

3. Effectuez l'une des opérations suivantes :

   • Pour charger une requête définie par le système qui s'appuie sur le générateur de requêtes, qui vous permet de définir la requête à l'aide de sélections de menu, assurez-vous que le volet Requête affiche Générateur de requêtes. Si un éditeur SQL s'affiche, alors cliquez sur tune Générateur.

   • Pour charger une requête définie par le système qui extrait des valeurs JSON, assurez-vous que le volet Requête affiche l'éditeur SQL. Si ce volet affiche Générateur de requêtes, cliquez sur code SQL.

4. Dans le volet Schéma, sélectionnez Requête, puis cliquez sur Écraser.

   Le volet Requête affiche une requête définie par le système. Si vous avez sélectionné le Générateur de requêtes mode, mais que vous souhaitez afficher la requête SQL, cliquez sur code SQL.

5. Facultatif : modifiez la requête.

6. Pour exécuter la requête, accédez à la barre d'outils et sélectionnez Exécuter la requête.

   Observability Analytics présente les résultats de la requête dans un tableau. Toutefois, vous pouvez créer un graphique, et vous pouvez également enregistrer le tableau ou le graphique dans un tableau de bord personnalisé. Pour en savoir plus, consultez Représenter les résultats d'une requête SQL sous forme de graphique.

   Si la barre d'outils affiche Exécuter dans BigQuery, vous devez configurer Observability Analytics pour qu'il utilise le moteur de requête par défaut. Pour effectuer cette modification, dans la barre d'outils du volet Requête, cliquez sur settings Paramètres , puis sélectionnez Analytics (par défaut).

Saisir et exécuter une requête personnalisée

Pour saisir une requête SQL, procédez comme suit :

1. Dans la Google Cloud console, accédez à la manage_search Observability Analytics page :

   Accéder à Observability Analytics

   Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Logging.

2. Dans le volet Requête, cliquez sur code SQL.

   • Pour spécifier une période, nous vous recommandons d'utiliser le sélecteur de période. Si vous ajoutez une clause WHERE qui spécifie le champ timestamp, cette valeur remplace le paramètre du sélecteur de période, et ce sélecteur est désactivé.

   • Pour obtenir des exemples, consultez Exemples de requêtes SQL.

   • L'éditeur SQL affiche le nom complet de la vue _Trace.Spans._AllSpans, qui se présente comme suit :

     FROM `PROJECT_ID.LOCATION._Trace.Spans._AllSpans`

     Les champs de l'expression précédente ont la signification suivante :

     • PROJECT_ID : identifiant du projet.
     • LOCATION : l'emplacement du bucket d'observabilité.

     Si le volet de requête affiche un message d'erreur faisant référence à l'instruction FROM, cela signifie que la vue est introuvable. Pour savoir comment résoudre cet échec, consultez Message d'erreur indiquant qu'une vue n'existe pas.

3. Pour exécuter la requête, accédez à la barre d'outils et sélectionnez Exécuter la requête.

   Observability Analytics présente les résultats de la requête dans un tableau. Toutefois, vous pouvez créer un graphique, et vous pouvez également enregistrer le tableau ou le graphique dans un tableau de bord personnalisé. Pour en savoir plus, consultez