Enregistrer et partager des requêtes

Console

Lorsque vous utilisez la Google Cloud console pour accéder aux Google Cloud services et aux API, vous n'avez pas besoin de configurer l'authentification.

gcloud

Dans la Google Cloud console, activez Cloud Shell.

Activer Cloud Shell

En bas de la Google Cloud console, une session Cloud Shell démarre et affiche une invite de ligne de commande. Cloud Shell est un environnement shell dans lequel Google Cloud CLI est déjà installé, et dans lequel des valeurs sont déjà définies pour votre projet actuel. L'initialisation de la session peut prendre quelques secondes.

REST

Pour utiliser les exemples API REST de cette page dans un environnement de développement local, vous devez utiliser les identifiants que vous fournissez à la gcloud CLI.

Installez la Google Cloud CLI.

Si vous utilisez un fournisseur d'identité (IdP) externe, vous devez d'abord vous connecter à la gcloud CLI avec votre identité fédérée.

Pour en savoir plus, consultez la section S'authentifier pour utiliser REST dans la documentation sur l' Google Cloud authentification.

Console

Pour enregistrer une requête, 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. 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 d'analyse.

   Lorsque la requête du volet Query (Requête) est valide, le bouton save Save (Enregistrer) est activé.

3. Cliquez sur save Save (Enregistrer), sélectionnez Save query (Enregistrer la requête), puis renseignez 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_vert More Options (Plus d'options), puis sélectionnez Edit (Modifier). Vous pouvez modifier les valeurs des champs Name (Nom) et Description, mais la requête elle-même ne peut pas être modifiée.

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

gcloud

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

1. Avant d'utiliser les données de la commande ci-dessous, effectuez les remplacements suivants :

   • DISPLAY_NAME : nom à afficher de la requête enregistrée.
   • LOCATION : emplacement de la requête enregistrée.
   • VISIBILITY : définissez la valeur sur private ou shared.
   • SQL_QUERY : requête SQL. Si des guillemets simples inversés (`) entourent le chemin d'accès ou les champs du chemin d'accès, vous devez les échapper :

         "SELECT * FROM \`PROJECT_ID.LOCATION.my-log-bucket._AllLogs\`"
         

     ou

         "SELECT * FROM \`PROJECT_ID.LOCATION._Trace.Spans._AllSpans\`"
         

     Les guillemets simples inversés (`) sont obligatoires lorsqu'un élément de chemin d'accès contient un point (.).

   • ID : ID de la requête enregistrée. Cet ID est une entrée obligatoire pour les commandes qui décrivent, mettent à jour ou suppriment une requête enregistrée. Si vous ne fournissez pas l'ID lors de la création d'une requête enregistrée, le système génère un ID numérique.
   • DESCRIPTION : description textuelle de la requête. Facultatif.
   • PROJECT_ID : identifiant du projet.

   Exécutez la gcloud logging saved-queries create commande :

   Linux, macOS ou Cloud Shell

   gcloud logging saved-queries create --display-name=DISPLAY_NAME \
    --location=LOCATION --visibility=VISIBILITY --sql-query-text=SQL_QUERY \
    --id=ID --description=DESCRIPTION --project=PROJECT_ID

   Windows (PowerShell)

   gcloud logging saved-queries create --display-name=DISPLAY_NAME `
    --location=LOCATION --visibility=VISIBILITY --sql-query-text=SQL_QUERY `
    --id=ID --description=DESCRIPTION --project=PROJECT_ID

   Windows (cmd.exe)

   gcloud logging saved-queries create --display-name=DISPLAY_NAME ^
    --location=LOCATION --visibility=VISIBILITY --sql-query-text=SQL_QUERY ^
    --id=ID --description=DESCRIPTION --project=PROJECT_ID

   Voici un exemple de réponse lorsque l'ID fourni dans la commande était my-saved-query :

   Created saved query [projects/PROJECT_ID/locations/LOCATION/savedQueries/my-saved-query].
   

   La réponse à la commande create liste le nom complet de la requête, qui inclut son ID. L'ID de requête, qui dans cet exemple est my-saved-query, est une entrée obligatoire pour les commandes Google Cloud CLI qui décrivent, suppriment ou mettent à jour une requête enregistrée.

2. Pour inspecter la requête enregistrée, exécutez la commande suivante :

    gcloud logging saved-queries list --location=- --project=PROJECT_ID
   

   Dans l'expression précédente, la valeur de l'emplacement est un trait d'union (-), qui sert de caractère générique. Vous pouvez également fournir un emplacement spécifique.

Il existe des commandes Google Cloud CLI pour supprimer, lister, décrire et mettre à jour les requêtes enregistrées. Pour en savoir plus, consultez la présentation de gcloud logging saved-queries overview.

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 exécuter une commande. 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"
   }
}

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 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. 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 link 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.

gcloud

Lorsque vous souhaitez créer une requête enregistrée qui peut être exécutée par d'autres utilisateurs, définissez la valeur du champ visibility sur shared :

--visibility=shared

Pour modifier la visibilité d'une requête enregistrée existante, utilisez la commande update. Pour en savoir plus sur les commandes disponibles, consultez la présentation de gcloud logging saved-queries overview.

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.