Enregistrer et partager des requêtes

Aperçu

Ce produit ou cette fonctionnalité est soumis aux "Conditions des offres pré-DG" de la section "Conditions d'utilisation générales du service" des Conditions spécifiques du service. Les produits et fonctionnalités pré-DG sont disponibles "en l'état" et peuvent avoir une compatibilité limitée. Pour en savoir plus, consultez les descriptions des étapes de lancement.

Ce document explique comment enregistrer et partager les requêtes que vous créez dans Observability Analytics. Si vous ne connaissez pas Observability Analytics, consultez Interroger et analyser des traces.

Pour savoir comment représenter vos requêtes sous forme de graphique ou comment interroger vos données de trace dans BigQuery, consultez les documents listés dans la section Étape suivante de ce document.

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.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

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 Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. 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.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

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 Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. 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.
   • Lecteur de journaux (roles/logging.viewer) sur votre projet.

   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 avec des rôles personnalisés ou d'autres rôles prédéfinis.

   **Remarque** : Si vous souhaitez créer et gérer des requêtes partagées, les rôles IAM précédents ne suffisent pas. Pour créer et gérer des requêtes partagées, vos rôles IAM doivent inclure les logging.queries.{share, updateShared, deleteShared} autorisations.

Enregistrer une requête

Toutes les requêtes que vous exécutez sont automatiquement enregistrées pendant 30 jours et sont accessibles en sélectionnant l'onglet Récentes sur la page Observability Analytics. Vous pouvez rechercher, afficher, exécuter et partager les requêtes listées dans l'onglet Récentes.

Si vous souhaitez conserver une requête pour une utilisation ultérieure, l'annoter avec des informations utiles ou permettre à vos coéquipiers de l'afficher et de l'exécuter, enregistrez-la. Vous pouvez rechercher et trier vos requêtes enregistrées par nom, description et libellé de visibilité. Vous pouvez également modifier et supprimer ces requêtes. Les requêtes que vous enregistrez sont conservées jusqu'à ce que vous les supprimiez.

Vous pouvez enregistrer 10 000 requêtes par Google Cloud projet.

Console

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

1. Dans la Google Cloud console, accédez à la 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. Remplissez le volet Requête avec une requête.

   Vous pouvez remplir le volet Requête en saisissant une nouvelle requête, en sélectionnant une requête dans l'onglet Récentes ou en sélectionnant une requête dans l'onglet Enregistrées.

   Votre requête peut inclure n'importe quelle vue valide, plusieurs vues et des vues d'analyse.

   Lorsque la requête du volet Requête est valide, l'option d'enregistrement Enregistrer est activée.

3. Cliquez sur save Save, sélectionnez Save query, puis remplissez les champs Name et Description. Les valeurs que vous définissez pour ces champs s'affichent dans l'onglet Enregistrées.

4. (Facultatif) Pour permettre à tous les utilisateurs ayant accès à la page Observability Analytics du Google Cloud projet d'afficher et d'exécuter votre requête enregistrée, activez le bouton Partager avec le projet.

   Par défaut, ce bouton est désactivé et la visibilité est limitée à vous.

5. Cliquez sur Enregistrer la requête.

6. (Facultatif) Pour afficher, trier et exécuter les requêtes enregistrées qui vous sont visibles, sélectionnez l'onglet Enregistrées.

   Vous pouvez trier et filtrer vos requêtes enregistrées par nom, description et libellé de visibilité. Vous pouvez également filtrer par contenu de la requête.

Vous pouvez modifier et supprimer les requêtes que vous avez créées à l'aide des options de l'onglet Enregistrées :

• Pour modifier une requête, cliquez sur Plus d'options , puis sélectionnez Modifier. Vous pouvez modifier les valeurs des champs Nom et Description. Toutefois, la requête elle-même ne peut pas être modifiée.

• Pour supprimer une requête enregistrée, cliquez sur Plus d'options , puis sélectionnez Supprimer.

REST

Vous pouvez enregistrer une requête à l'aide de l'API Cloud Logging. Pour enregistrer une requête, utilisez la savedQueries.create méthode.

Pour exécuter cette méthode, procédez comme suit :

1. Sélectionnez savedQueries.create.
2. Sur la page de référence, utilisez APIs Explorer pour émettre une commande. Vous devez spécifier le champ opsAnalyticsQuery.

L'exemple suivant illustre un corps de requête, qui contient une instance de SavedQuery :

{
   "parent": "projects/my-project/locations/global"
   "saved_query":
   {
      "ops_analytics_query":
      {
         "sql_query_text" :
            "SELECT
            timestamp, log_name, severity, json_payload, resource, labels
            FROM
            `VIEW`
            WHERE
            timestamp > TIMESTAMP_SUB(CURRENT_TIMESTAMP(), INTERVAL 1 HOUR)
            ORDER BY timestamp ASC
            LIMIT 100"
      }
   "visibility": "PRIVATE"
   }
}

Partager une requête

Vous pouvez partager une requête enregistrée avec tous les utilisateurs ayant accès à votre Google Cloud projet. Toutefois, les rôles IAM du compte principal déterminent si la requête peut être exécutée et les données qu'elle renvoie.

Console

Lorsque vous résolvez un problème ou que vous constatez des résultats anormaux, vous pouvez partager une requête et ses résultats avec un coéquipier. Lorsque vous affichez les résultats d'une requête sur la page Observability Analytics, vous pouvez copier une URL qui, une fois ouverte, affiche la requête que vous avez exécutée et ses résultats.

Pour partager une requête et ses résultats avec un coéquipier, procédez comme suit :

1. Dans la Google Cloud console, accédez à la 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. Remplissez le volet Requête avec une requête, puis cliquez sur Exécuter la requête.

   Vous pouvez remplir le volet Requête en saisissant une nouvelle requête, en sélectionnant une requête dans l'onglet Récentes ou en sélectionnant une requête dans l'onglet Enregistrées.

3. Cliquez sur Partager le lien.

4. Envoyez le lien à votre coéquipier.

   Lorsque votre coéquipier ouvre le lien, la page Observability Analytics s'ouvre et affiche la requête, mais ne l'exécute pas. Votre coéquipier doit exécuter la requête manuellement.

   La page Observability Analytics affiche une boîte de dialogue d'avertissement lorsque la requête s'exécute sur le moteur BigQuery et que les ressources interrogées ne se trouvent pas dans la même limite de propriété. Les limites de propriété sont déterminées par plusieurs facteurs, dont la hiérarchie des ressources utilisées par la requête.

   Pour que votre coéquipier puisse ouvrir l'URL, son rôle IAM sur le Google Cloud projet doit inclure les autorisations requises pour afficher la page Observability Analytics.

REST

Vous pouvez utiliser l'API Logging pour créer une requête partagée à l'aide de la méthode savedQueries.Create et en spécifiant la valeur SHARED dans le champ visibility. Pour en savoir plus, consultez la page de référence de savedQueries.create.

Afficher et exécuter des requêtes récentes ou enregistrées

Pour afficher ou réexécuter une requête, sélectionnez l'onglet Récentes sur la page Observability Analytics , puis recherchez la requête :

• Pour exécuter la requête, cliquez sur Exécuter.
• Pour afficher la requête, utilisez les options du menu Plus d'options.

Pour afficher, modifier ou exécuter une requête enregistrée, sélectionnez l'onglet Enregistrées sur la page Observability Analytics, puis recherchez la requête :

• Pour exécuter la requête, cliquez sur Exécuter.
• Pour modifier, afficher ou supprimer la requête, utilisez les options du Plus d'options menu.

Étape suivante

• Représenter les résultats d'une requête SQL sous forme de graphique.
• Exemples de requêtes SQL.
• Interroger un ensemble de données associé dans BigQuery.