Écrire et interroger des entrées de journal avec la gcloud CLI

Écrire des entrées de journal à l'aide de la gcloud CLI

Logging accepte les entrées de journal avec des données structurées et non structurées. Les données structurées consistent en une structure de données JSON, par exemple {"weather": "partly cloudy"}. Les données non structurées sont une chaîne de caractères, par exemple "A simple entry".

Dans les étapes suivantes, vous allez utiliser la gcloud CLI pour écrire une entrée de journal contenant des données non structurées et une entrée de journal contenant des données structurées. gcloud CLI fournit une interface de ligne de commande à l'API Cloud Logging.

1. Écrivez une entrée de journal avec des données non structurées dans le journal my-test-log, puis exécutez la commande gcloud logging write:

   gcloud logging write my-test-log "A simple entry."
   

   Une fois l'exécution de la commande terminée, le message suivant s'affiche : Created log entry.

2. Écrivez une entrée de journal avec des données non structurées dans le journal my-test-log :

   gcloud logging write --payload-type=json my-test-log '{ "message": "My second entry", "weather": "partly cloudy"}'
   

   Lorsque vous écrivez une entrée de journal avec des données structurées, vous devez inclure --payload-type=json. Si vous omettez ce champ, Logging interprète la charge utile comme des données non structurées.

Si le journal my-test-log n'existe pas, Logging le crée lorsque l'entrée de journal est reçue.

Répertorier des entrées de journal à l'aide de la gcloud CLI

Vous pouvez extraire des entrées de journal de Logging et les afficher à l'aide de la gcloud CLI. Par exemple, pour extraire et afficher les entrées de journal avec un type de ressource de global, exécutez la commande suivante:

gcloud logging read "resource.type=global"

La commande renvoie un résultat semblable à celui-ci :

---
insertId: jpj9zjf73t1mn
jsonPayload:
  message: My second entry
  weather: partly cloudy
logName: projects/myloggingproject/logs/my-test-log
receiveTimestamp: '2018-11-01T18:39:31.114507977Z'
resource:
  labels:
    project_id: myloggingproject
  type: global
timestamp: '2018-11-01T18:39:31.114507977Z'
---
insertId: vd4m1if7h7u1a
logName: projects/myloggingproject/logs/my-test-log
receiveTimestamp: '2018-11-01T18:39:19.718100792Z'
resource:
  labels:
    project_id: myloggingproject
  type: global
textPayload: A simple entry
timestamp: '2018-11-01T18:39:19.718100792Z'

Pour en savoir plus sur la lecture des journaux, consultez la documentation de référence sur gcloud logging read.

Répertorier les entrées de journal à l'aide de l'explorateur d'API

Pour exécuter les méthodes de l'API Logging sans écrire de code, consultez la section Utiliser l'explorateur d'API. Pour lire la liste des entrées de journal de Logging, procédez comme suit:

1. Consultez la page traitant de la méthode d'API entries.list dans la documentation de référence de l'API :

   Accéder à la page de l'API entries.list

2. Configurez et exécutez la commande d'API :

   1. Remplacez PROJECT_ID dans le texte suivant:

      "resourceNames": [
      "projects/PROJECT_ID"
      ],
      "filter": "resource.type=global",
      "orderBy": "timestamp desc"
      

   2. Copiez le texte mis à jour à l'étape précédente et collez-le dans le champ Corps de la requête d'Apis Explorer.

   3. Cliquez sur Exécuter.

   La méthode renvoie une réponse semblable à la suivante :

   {
     "entries": [
       {
         "textPayload": "A simple entry",
         "insertId": "vd4m1if7h7u1a",
         "resource": {
           "type": "global",
           "labels": {
             "project_id": "myloggingproject"
           }
         },
         "timestamp": "2018-11-01T18:39:19.718100792Z",
         "logName": "projects/myloggingproject/logs/my-test-log",
         "receiveTimestamp": "2018-11-01T18:39:19.718100792Z"
       },
       {
         "insertId": "jpj9zjf73t1mn",
         "jsonPayload": {
           "message": "My second entry",
           "weather": "partly cloudy"
         },
         "resource": {
           "type": "global",
           "labels": {
             "project_id": "myloggingproject"
           }
         },
         "timestamp": "2018-11-01T18:39:31.114507977Z",
         "logName": "projects/myloggingproject/logs/my-test-log",
         "receiveTimestamp": "2018-11-01T18:39:31.114507977Z"
       }
     ]
   }
   

Afficher les entrées de journal dans l'explorateur de journaux

Pour afficher les entrées de journal dans la console Google Cloud, vous pouvez utiliser l'explorateur de journaux. La plupart des projets Google Cloud stockent un grand nombre de journaux. Vous pouvez sélectionner certaines entrées de journal en écrivant une requête.

Pour afficher les entrées de journal que vous avez écrites à l'aide de l'explorateur de journaux, procédez comme suit:

1. Dans la console Google Cloud, accédez à la page Explorateur de journaux.

   Accéder à l'explorateur de journaux

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

   Assurez-vous que votre projet Google Cloud est sélectionné dans la barre de navigation de Google Cloud. Si nécessaire, utilisez la liste déroulante des projets Google Cloud pour sélectionner votre projet Google Cloud.

2. Dans le menu Ressource, sélectionnez Global.

   Si vous ne voyez pas l'option de menu Global ou si vous ne voyez pas vos entrées de journal, attendez quelques minutes et actualisez la page. Logging peut mettre quelques minutes avant de recevoir des entrées de journal.

3. Pour afficher les détails d'une entrée de journal, cliquez sur son menu chevron_right.

   Les données de la première entrée de journal sont stockées dans textPayload. La deuxième entrée de journal contient des données structurées stockées dans jsonPayload. La charge utile structurée contient les clés message et weather.

Pour en savoir plus sur le format de données des entrées de journal, consultez le type LogEntry.

Interroger des entrées de journal dans l'explorateur de journaux

Vous pouvez interroger des entrées de journal à l'aide de l'éditeur de requêtes et, avec des journaux structurés, en fonction de la clé et de la valeur. Par exemple, pour afficher toutes les entrées de journal contenant le texte simple, procédez comme suit:

1. Dans la console Google Cloud, accédez à la page Explorateur de journaux.

   Accéder à l'explorateur 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. Dans le menu Ressource, sélectionnez Global.

3. Dans l'éditeur de requêtes, saisissez la chaîne simple entre guillemets. Seule l'entrée de journal A simple entry. apparaît dans l'affichage de journaux.

4. Après avoir consulté votre journal, supprimez la chaîne de requête que vous avez ajoutée, puis cliquez sur Run query (Exécuter la requête). Les deux entrées du journal réapparaissent à l'écran.

Pour afficher toutes les entrées de journal avec des données structurées contenant une clé de weather où le champ value contient partly, procédez comme suit:

1. L'éditeur de requêtes contient la ligne resource.type="global". Saisissez la commande suivante :

   jsonPayload.weather:partly
   

2. Cliquez sur Exécuter la requête. Le résultat est l'unique entrée de journal My second entry :

L'explorateur de journaux propose également des requêtes enregistrées, suggérées et récentes. Pour en savoir plus sur les requêtes, consultez la page Générer des requêtes dans l'explorateur de journaux.

Pour obtenir des exemples de requêtes, consultez la page Exemples de requêtes avec l'explorateur de journaux.

Dépannage

• Les erreurs typographiques et les noms de champs inconnus font que les commandes de la gcloud CLI aboutissent à des messages d'argument non valide. Par exemple, si vous oubliez le point dans resource.type, l'erreur suivante est renvoyée:

   ERROR: (gcloud.logging.read) INVALID_ARGUMENT: Field not found: 'resourcetype'.
  

• Lorsque Cloud Logging n'a pas obtenu les autorisations d'accès nécessaires, les commandes de gcloud CLI sont complétées par des messages d'autorisation refusée. Par exemple, si une instance de VM Compute Engine est configurée avec les paramètres d'API par défaut, la commande list aboutit à une erreur de type "Autorisation refusée" :

   ERROR: (gcloud.logging.read) PERMISSION_DENIED: Request had insufficient authentication scopes.
  

  Pour résoudre ce problème, modifiez les autorisations de votre instance de VM Compute Engine afin d'accorder l'autorisation de lecture de Cloud Logging en procédant comme suit:

  1. Accédez à la page Informations sur l'instance de VM correspondant à votre instance de VM. Cliquez sur Arrêter. Cette action peut prendre une minute ou deux.
  2. Pour modifier la configuration, cliquez sur Modifier.
  3. Recherchez l'en-tête Niveaux d'accès aux API Cloud, puis cliquez sur Détails pour afficher les paramètres de chaque API. Passez l'entrée de l'API Cloud Logging sur Complet. Cliquez sur Enregistrer.
  4. Pour redémarrer votre instance de VM, cliquez sur Démarrer. Après quelques instants, votre VM est prête à être utilisée.

• Lorsque l'explorateur d'API ne peut pas terminer votre commande ou nécessite une autorisation supplémentaire, il affiche un message ou un code d'erreur :

  • Code de réponse 200 et aucune entrée: si le message nextPageToken est affiché, cela signifie que l'explorateur d'API n'a pas eu le temps de terminer la recherche. Ajoutez un pageToken à votre requête, définissez la valeur à l'identique de celle indiquée avec la clé nextPageToken, puis réessayez d'exécuter la commande.
  • Code de réponse 400 : la valeur de la requête n'est pas valide. Par exemple, si vous écrivez gloobal au lieu de global, le message est Unsupported resource type: gloobal.
  • Code de réponse 404 : l'ID de projet n'est pas valide. Vérifiez l'orthographe de votre identifiant de projet.
  • Vous serez peut-être invité à vous connecter à votre projet Google Cloud et à autoriser l'APIs Explorer à accéder à votre compte.