Enregistrer et partager des requêtes SQL

Ce document explique comment enregistrer et partager les requêtes que vous créez dans Observability Analytics.

Ce document suppose que vous connaissez Observability Analytics et que vous savez utiliser la page Observability Analytics pour interroger les données de vos journaux. Si ce n'est pas le cas, consultez Interroger et analyser des journaux.

Pour découvrir comment représenter graphiquement les résultats de vos requêtes et comment enregistrer ces graphiques dans un tableau de bord personnalisé, consultez Représenter graphiquement les résultats d'une requête SQL.

Différences entre les requêtes enregistrées et les vues Analytics

Une requête enregistrée est une requête que vous exécutez à l'aide de la page Observability Analytics , puis que vous enregistrez en tant que requête. L'action d'enregistrement vous permet de réexécuter cette requête à votre convenance. Lorsque vous enregistrez la requête, vous pouvez la rendre privée ou la rendre visible aux autres utilisateurs disposant des autorisations nécessaires pour utiliser Observability Analytics. Vous ne pouvez pas écrire de requête SQL dans laquelle la clause FROM spécifie une requête enregistrée.

Une vue Analytics contient une requête que vous pouvez réexécuter à votre convenance. Vous créez une vue Analytics en écrivant une requête SQL sur une vue de journal, puis en enregistrant le résultat en tant que vue. Contrairement aux requêtes enregistrées, vous ne pouvez pas rendre une vue Analytics privée. Vous pouvez interroger une vue Analytics. Cette fonctionnalité vous permet de transformer les données de vos journaux du format LogEntry en un autre format plus adapté à vos besoins. Ensuite, au lieu d'écrire vos requêtes sur une vue de journal, vous interrogez la vue Analytics.

Vous pouvez enregistrer des requêtes qui interrogent une vue de journal ou une vue Analytics.

Avant de commencer

Cette section décrit les étapes que vous devez suivre pour pouvoir utiliser Observability Analytics.

Configurer des buckets de journaux

Assurez-vous que vos buckets de journaux ont été mis à niveau pour utiliser Observability Analytics :

  1. Dans la Google Cloud console, accédez à la page Stockage des journaux :

    Accéder à la page Stockage des journaux

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

  2. Pour chaque bucket de journaux comportant une vue de journal que vous souhaitez interroger, assurez-vous que la colonne Observability Analytics available affiche Open. Si Upgrade (Mettre à niveau) s'affiche, cliquez sur Upgrade (Mettre à niveau) et remplissez la boîte de dialogue.

Configurer des rôles et des autorisations IAM

Cette section décrit les rôles ou les autorisations IAM requis pour utiliser Observability Analytics :

  • Pour obtenir les autorisations nécessaires pour utiliser Observability Analytics et interroger des vues de journal, demandez à votre administrateur de vous accorder les rôles IAM suivants sur votre projet :

    Vous pouvez limiter un compte principal à une vue de journal spécifique en ajoutant une condition IAM à l'attribution du rôle Accesseur de vues de journaux effectuée au niveau du projet, ou en ajoutant une liaison IAM au fichier de stratégie de la vue de journal. Pour en savoir plus, consultez Contrôler l'accès à une vue de journal.

    Il s'agit des mêmes autorisations que celles dont vous avez besoin pour afficher les entrées de journal sur la page Explorateur de journaux. Pour en savoir plus sur les rôles supplémentaires dont vous avez besoin pour interroger des vues sur des buckets définis par l'utilisateur ou pour interroger la vue _AllLogs du bucket de journaux _Default, consultez Rôles Cloud Logging.

  • Pour obtenir les autorisations nécessaires pour interroger des vues Analytics, demandez à votre administrateur de vous accorder le rôle IAM Utilisateur Observability Analytics (roles/observability.analyticsUser) sur votre projet.

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 Recent (Récentes) sur la page Observability Analytics. Vous pouvez rechercher, afficher, exécuter et partager les requêtes listées dans l'onglet Recent (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 page Analyse de journaux :

    Accéder à l'Analyse de journaux

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

  2. Renseignez le volet Query (Requête) avec une requête.

    Vous pouvez renseigner le volet Query (Requête) en saisissant une nouvelle requête, en sélectionnant une requête dans l'onglet Recent (Récentes) ou en sélectionnant une requête dans l'onglet Saved (Enregistrées).

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

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

  3. Cliquez sur Save (Enregistrer), sélectionnez Save query (Enregistrer la requête), puis remplissez les champs Name (Nom) et Description. Les valeurs que vous définissez pour ces champs s'affichent dans l'onglet Saved (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 Share with project (Partager avec le projet).

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

  5. Cliquez sur Save query (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 Saved (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 Saved (Enregistrées) :

  • Pour modifier une requête, cliquez sur More Options (Plus d'options), puis sélectionnez Edit (Modifier). Vous pouvez modifier les valeurs des champs Name (Nom) et Description, mais vous ne pouvez pas modifier la requête elle-même.

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

API

Pour enregistrer une requête à l'aide de l'API Logging, utilisez la méthode savedQueries.create. Pour en savoir plus sur cette méthode, ses paramètres et les données de réponse, consultez la page de référence de savedQueries.create.

Vous pouvez exécuter la méthode savedQueries.create à l'aide du widget APIs Explorer sur la page de référence de la méthode. Pour les requêtes Observability Analytics, vous devez spécifier le champ opsAnalyticsQuery. L'exemple suivant illustre un exemple de 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 page Analyse de journaux :

    Accéder à l'Analyse de journaux

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

  2. Renseignez le volet Query (Requête) avec une requête, puis cliquez sur Run query (Exécuter la requête).

    Vous pouvez renseigner le volet Query (Requête) en saisissant une nouvelle requête, en sélectionnant une requête dans l'onglet Recent (Récentes) ou en sélectionnant une requête dans l'onglet Saved (Enregistrées).

  3. Cliquez sur Share link (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 ouvrir l'URL, le rôle IAM de votre coéquipier sur le Google Cloud projet doit inclure les autorisations requises pour afficher la page Observability Analytics.

API

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 Recent (Récentes) sur la page Observability Analytics , puis recherchez la requête :

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

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

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

Étape suivante