Configurer des buckets de journaux

Console Google Cloud

Pour créer un bucket de journaux dans votre projet Google Cloud , procédez comme suit :

1. Dans la console Google Cloud , 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. Cliquez sur Créer un bucket de journaux.

3. Saisissez un Nom et une Description pour votre bucket.

4. Facultatif : Mettez à niveau votre bucket pour utiliser l'Analyse de journaux.

   1. Sélectionnez Effectuez la mise à niveau pour utiliser l'Analyse de journaux.

      Lorsque vous mettez à niveau un bucket pour utiliser l'analyse de journaux, vous pouvez interroger vos journaux sur la page Analyse de journaux à l'aide de requêtes SQL. Vous pouvez également continuer à afficher vos journaux à l'aide de l'explorateur de journaux.

   2. Facultatif : Pour afficher vos journaux dans BigQuery, sélectionnez Créer un ensemble de données BigQuery lié à ce bucket et saisissez un nom d'ensemble de données unique.

      Lorsque vous sélectionnez cette option, BigQuery peut lire les données stockées dans votre bucket de journaux. Vous pouvez désormais effectuer des requêtes dans l'interface BigQuery, où vous pouvez joindre vos données de journaux et accéder aux données d'autres outils tels que Looker Studio et Looker.

5. Facultatif : Pour sélectionner la région de stockage de vos journaux, cliquez sur le menu Sélectionner la région du bucket de journaux et sélectionnez une région. Si vous ne sélectionnez pas de région, la région global est utilisée, ce qui signifie que les journaux peuvent se trouver physiquement dans n'importe quelle région compatible.

6. Facultatif : Pour définir une durée de conservation personnalisée pour les journaux du bucket, cliquez sur Suivant.

   Dans le champ Durée de conservation, saisissez le nombre de jours (compris entre 1 et 3 650 jours) pendant lesquels vous souhaitez que Cloud Logging conserve vos journaux. Si vous ne personnalisez pas la durée de conservation, la valeur par défaut est 30 days.

   Vous pouvez également mettre à jour votre bucket pour appliquer une conservation personnalisée après sa création.

7. Cliquez sur Créer un bucket.

   Une fois le bucket de journaux créé, Logging le met à niveau et crée le lien vers l'ensemble de données, si ces options ont été sélectionnées.

   L'exécution de ces étapes peut prendre un moment.

gcloud

Pour créer un bucket de journaux uniquement, exécutez la commande gcloud logging buckets create. Si vous souhaitez mettre à niveau le bucket de journaux pour utiliser l'Analyse de journaux, incluez les indicateurs --enable-analytics et --async, et assurez-vous de définir la variable LOCATION sur une région acceptée :

gcloud logging buckets create BUCKET_ID --location=LOCATION --enable-analytics --async OPTIONAL_FLAGS

L'option --async force la commande à être asynchrone. Le retour d'une méthode asynchrone est un objet Operation. Il contient des informations sur la progression de la méthode. Une fois la méthode terminée, l'objet Operation contient l'état. Pour en savoir plus, consultez Méthodes d'API asynchrones.

Si vous ne souhaitez pas mettre à niveau le bucket de journaux pour utiliser l'Analyse de journaux, omettez les indicateurs --enable-analytics et --async.

Par exemple, si vous souhaitez créer un bucket avec l'élément BUCKET_ID my-bucket dans la région global, votre commande se présente comme suit :

gcloud logging buckets create my-bucket --location global --description "My first bucket"

Par exemple, pour créer un bucket avec l'élément BUCKET_ID my-upgraded-bucket dans l'emplacement global, puis mettre à niveau le bucket de journaux pour utiliser l'analyse de journaux, votre commande se présente comme suit :

gcloud logging buckets create my-upgraded-bucket --location global \
      --description "My first upgraded bucket" \
      --enable-analytics --retention-days=45

REST

Pour créer un bucket, utilisez la méthode projects.locations.buckets.create ou projects.locations.buckets.createAsync. Préparez les arguments de la méthode comme suit :

1. Définissez le paramètre parent sur la ressource dans laquelle créer le bucket : projects/PROJECT_ID/locations/LOCATION

   La variable LOCATION fait référence à la région dans laquelle vous souhaitez stocker vos journaux.

   Par exemple, si vous souhaitez créer un bucket pour le projet my-project dans la région global, votre paramètre parent se présentera comme suit : projects/my-project/locations/global.

2. Définissez le paramètre bucketId (par exemple, my-bucket).

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

   • Pour créer un bucket de journaux, puis le mettre à niveau pour utiliser l'Analyse de journaux :

     1. Définissez le booléen LogBucket.analyticsEnabled sur true.

     2. Appelez la méthode asynchrone projects.locations.buckets.createAsync pour créer le bucket.

        La réponse aux méthodes asynchrones est un objet Operation. Cet objet contient des informations sur la progression de la méthode. Une fois la méthode terminée, l'objet Operation contient l'état. Pour en savoir plus, consultez Méthodes d'API asynchrones.

        L'exécution de la méthode createAsync prend plusieurs minutes. Cette méthode ne génère pas de message d'erreur ni n'échoue lorsque le booléen analyticsEnabled est défini sur true.

   • Sinon, appelez la méthode synchrone projects.locations.buckets.create pour créer le bucket.

Console Google Cloud

Pour mettre à jour les propriétés de votre bucket, procédez comme suit :

1. Dans la console Google Cloud , 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 le bucket que vous souhaitez mettre à jour, cliquez sur more_vert Plus.

3. Cliquez sur Modifier le bucket.

4. Modifiez votre bucket comme désiré.

5. Cliquez sur Mettre à jour le bucket.

gcloud

Pour mettre à jour les propriétés de votre bucket, exécutez la commande gcloud logging buckets update :

gcloud logging buckets update BUCKET_ID --location=LOCATION UPDATED_ATTRIBUTES

Exemple :

gcloud logging buckets update my-bucket --location=global --description "Updated description"

REST

Pour mettre à jour les propriétés de votre bucket, utilisez projects.locations.buckets.patch dans l'API Logging.

Console Google Cloud

Pour mettre à niveau un bucket existant afin d'utiliser l'Analyse de journaux :

1. Dans la console Google Cloud , 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. Recherchez le bucket que vous souhaitez mettre à niveau.

3. Lorsque la colonne Analyse de journaux disponible affiche Mettre à niveau, vous pouvez mettre à niveau le bucket de journaux pour utiliser l'Analyse de journaux. Cliquez sur Mettre à niveau.

   Une boîte de dialogue s'ouvre. Cliquez sur Confirmer.

gcloud

Pour mettre à niveau votre bucket de journaux afin d'utiliser l'analyse de journaux, exécutez la commande gcloud logging buckets update. Vous devez définir l'option --enable-analytics. Nous vous recommandons également d'inclure l'option --async :

gcloud logging buckets update BUCKET_ID --location=LOCATION --enable-analytics --async

L'option --async force la commande à être asynchrone. Le retour d'une méthode asynchrone est un objet Operation, qui contient des informations sur la progression de la méthode. Une fois la méthode terminée, l'objet Operation contient l'état. Pour en savoir plus, consultez Méthodes d'API asynchrones.

REST

Pour mettre à niveau un bucket de journaux afin d'utiliser l'analyse de journaux, utilisez la méthode projects.locations.buckets.updateAsync de l'API Cloud Logging.

Préparez les arguments de la méthode comme suit :

1. Définissez le booléen LogBucket.analyticsEnabled sur true.
2. Pour le paramètre de requête de la commande, utilisez updateMask=analyticsEnabled.

La réponse aux méthodes asynchrones est un objet Operation. Cet objet contient des informations sur la progression de la méthode. Une fois la méthode terminée, l'objet Operation contient l'état. Pour en savoir plus, consultez Méthodes d'API asynchrones.

L'updateAsync peut prendre plusieurs minutes.

Console Google Cloud

Pour créer un lien vers un ensemble de données BigQuery pour un bucket de journaux existant, procédez comme suit :

1. Dans la console Google Cloud , 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. Localisez le bucket de journaux et vérifiez que la colonne Log Analytics disponible affiche Ouvrir.

   Si la colonne affiche Mettre à niveau, cela signifie que le bucket de journaux n'a pas été mis à niveau pour utiliser l'Analyse de journaux. Configurer l'analyse de journaux :

   1. Cliquez sur Mettre à jour.
   2. Cliquez sur Confirmer dans la boîte de dialogue.

   Une fois la mise à niveau terminée, passez à l'étape suivante.

3. Sur le bucket de journaux, cliquez sur Plusmore_vert, puis sur Modifier le bucket.

   La boîte de dialogue Modifier le bucket de journaux s'ouvre.

4. Sélectionnez Créer un ensemble de données BigQuery associé à ce bucket, puis saisissez le nom du nouvel ensemble de données.

   Le nom de l'ensemble de données doit être unique pour chaque Google Cloud projet. Si vous saisissez le nom d'un ensemble de données existant, l'erreur suivante s'affiche : Dataset name must be unique in the selected region.

5. Cliquez sur OK, puis sur Mettre à jour le bucket.

   Une fois que Logging affiche le nom de l'ensemble de données associé sur la page Stockage des journaux, BigQuery peut mettre plusieurs minutes à reconnaître l'ensemble de données.

gcloud

Pour créer un ensemble de données associé pour un bucket de journaux mis à niveau pour utiliser l'Analyse de journaux, exécutez la commande gcloud logging links create :

gcloud logging links create LINK_ID --bucket=BUCKET_ID --location=LOCATION

Le LINK_ID que vous fournissez est utilisé comme nom de l'ensemble de données BigQuery. La valeur de ce champ doit être unique pour votre projet Google Cloud .

La commande links create est asynchrone. Le retour d'une méthode asynchrone est un objet Operation, qui contient des informations sur la progression de la méthode. Une fois la méthode terminée, l'objet Operation contient l'état. Pour en savoir plus, consultez Méthodes d'API asynchrones.

L'exécution de la commande links create prend plusieurs minutes.

Par exemple, la commande suivante crée un ensemble de données associé nommé mylink pour le bucket de journaux nommé my-bucket :

gcloud logging links create mylink --bucket=my-bucket --location=global

Le nom de l'ensemble de données doit être unique pour chaque Google Cloud projet. Si vous essayez de créer un ensemble de données portant le même nom qu'un ensemble de données existant, l'erreur suivante s'affiche :

BigQuery dataset with name "LINK_ID" already exists.

Si vous tentez de créer un ensemble de données associé pour un bucket de journaux qui n'a pas été mis à niveau pour utiliser l'Analyse de journaux, l'erreur suivante s'affiche :

A link can only be created for an analytics-enabled bucket.

REST

Pour créer un ensemble de données BigQuery associé à un bucket de journaux existant qui a été mis à niveau pour utiliser l'analyse de journaux, appelez la méthode asynchrone projects.locations.buckets.links.create de l'API Cloud Logging.

Préparez les arguments de la méthode comme suit :

1. Créez le corps de la requête pour la commande create. Le corps de la requête est mis en forme en tant qu'objet Link.
2. Pour le paramètre de requête de la commande, utilisez linkId=LINK_ID. Le LINK_ID que vous fournissez est utilisé comme nom de l'ensemble de données BigQuery. La valeur de ce champ doit être unique pour votre projet Google Cloud .

La réponse aux méthodes asynchrones est un objet Operation. Cet objet contient des informations sur la progression de la méthode. Une fois la méthode terminée, l'objet Operation contient l'état. Pour en savoir plus, consultez Méthodes d'API asynchrones.

L'exécution de la méthode links.create prend plusieurs minutes.

Le nom de l'ensemble de données doit être unique pour chaque Google Cloud projet. Si vous essayez de créer un ensemble de données portant le même nom qu'un ensemble de données existant, l'erreur suivante s'affiche :

BigQuery dataset with name "LINK_ID" already exists.

Si vous tentez de créer un ensemble de données associé pour un bucket de journaux qui n'a pas été mis à niveau pour utiliser l'Analyse de journaux, l'erreur suivante s'affiche :

A link can only be created for an analytics-enabled bucket.

Console Google Cloud

La console Google Cloud ne permet pas de verrouiller un bucket de journaux.

gcloud

Pour verrouiller votre bucket, exécutez la commande gcloud logging buckets update avec l'indicateur --locked :

gcloud logging buckets update BUCKET_ID --location=LOCATION --locked

Exemple :

gcloud logging buckets update my-bucket --location=global --locked

REST

Pour verrouiller les attributs de votre bucket, utilisez projects.locations.buckets.patch dans l'API Logging. Définissez le paramètre locked sur true.

Console Google Cloud

Dans la console Google Cloud , 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.

Un tableau intitulé Buckets de journaux liste les buckets associés au projetGoogle Cloud actuel.

La table répertorie les attributs suivants pour chaque bucket de journaux :

• Nom : nom du bucket de journaux.
• Description : description du bucket.
• Durée de conservation : nombre de jours pendant lesquels les données du bucket seront stockées par Cloud Logging.
• Région : emplacement géographique où les données du bucket sont stockées.
• État : indique si le bucket est verrouillé ou non.

Si un bucket est en attente de suppression par Cloud Logging, son entrée de table est annotée avec un symbole d'avertissement warning.

gcloud

Exécutez la commande gcloud logging buckets list :

gcloud logging buckets list

Les attributs suivants s'affichent pour les buckets de journaux :

• LOCATION : région dans laquelle les données du bucket sont stockées.
• BUCKET_ID : nom du bucket de journaux.
• RETENTION_DAYS : nombre de jours pendant lesquels les données du bucket seront stockées par Cloud Logging.
• LIFECYCLE_STATE : indique si le bucket est en attente de suppression par Cloud Logging.
• LOCKED : indique si le bucket est verrouillé ou non.
• CREATE_TIME : horodatage indiquant la date de création du bucket.
• UPDATE_TIME : horodatage indiquant la date de la dernière modification du bucket.

Vous pouvez également afficher les attributs d'un seul bucket. Par exemple, pour afficher les détails du bucket de journaux _Default dans la région global, exécutez la commande gcloud logging buckets describe :

gcloud logging buckets describe _Default --location=global

REST

Pour répertorier les buckets de journaux associés à un projet Google Cloud , utilisez projects.locations.buckets.list dans l'API Logging.

Console Google Cloud

Dans la console Google Cloud , 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.

Dans le bucket de journaux, cliquez sur more_vert Plus, puis sélectionnez Afficher les détails du bucket.

La boîte de dialogue répertorie les attributs suivants pour le bucket de journaux :

• Nom : nom du bucket de journaux.
• Description : description du bucket de journaux.
• Durée de conservation : nombre de jours pendant lesquels les données du bucket seront stockées par Cloud Logging.
• Région : emplacement géographique où les données du bucket sont stockées.

• Analyse de journaux : indique si votre bucket a été mis à niveau pour utiliser l'Analyse de journaux.
• Analyse BigQuery : indique si un ensemble de données BigQuery est associé à votre bucket.
• Ensemble de données BigQuery : fournit un lien vers votre ensemble de données BigQuery, qui s'ouvre sur la page BigQuery Studio. La date à laquelle l'association à BigQuery a été activée est également indiquée.

gcloud

Exécutez la commande gcloud logging buckets describe.

Par exemple, la commande suivante affiche les détails du bucket _Default :

gcloud logging buckets describe _Default --location=global

Les attributs suivants s'affichent pour le bucket de journaux :

• createTime : horodatage indiquant la date de création du bucket.
• description : description du bucket de journaux.
• lifecycleState : indique si le bucket est en attente de suppression par Cloud Logging.
• name : nom du bucket de journaux.
• retentionDays : nombre de jours pendant lesquels les données du bucket seront stockées par Cloud Logging.
• updateTime : horodatage indiquant la date de la dernière modification du bucket.

REST

Pour afficher les détails d'un seul bucket de journaux, utilisez projects.locations.buckets.get dans l'API Logging.

Console Google Cloud

Pour supprimer un bucket de journaux, procédez comme suit :

1. Dans la console Google Cloud , 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. Recherchez le bucket que vous souhaitez supprimer, puis cliquez sur more_vertPlus.

3. Si la colonne Ensemble de données associé dans BigQuery affiche un lien, supprimez l'ensemble de données BigQuery associé :

   1. Cliquez sur Modifier le bucket.

   2. Décochez Créer un ensemble de données BigQuery associé à ce bucket, cliquez sur OK, puis sur Mettre à jour le bucket.

      Une fois de retour sur la page Stockage des journaux, cliquez sur more_vertPlus pour le bucket que vous souhaitez supprimer, puis passez aux étapes suivantes.

4. Cliquez sur Supprimer le bucket.

5. Dans le panneau de confirmation, cliquez sur Supprimer.

6. Sur la page Stockage des journaux, un indicateur spécifie que votre bucket est en attente de suppression. Le bucket, y compris tous les journaux qu'il contient, est supprimé au bout de sept jours.

gcloud

Pour supprimer un bucket de journaux, exécutez la commande gcloud logging buckets delete :

gcloud logging buckets delete BUCKET_ID --location=LOCATION

Vous ne pouvez pas supprimer un bucket de journaux lorsqu'il est associé à un ensemble de données BigQuery :

• Pour lister les liens associés à un bucket de journaux, exécutez la commande gcloud logging links list.
• Pour supprimer un ensemble de données associé, exécutez la commande gcloud logging links delete.

REST

Pour supprimer un bucket, utilisez projects.locations.buckets.delete dans l'API Logging.

La suppression d'un bucket de journaux est impossible si un ensemble de données BigQuery y est associé. Vous devez supprimer l'ensemble de données associé avant de supprimer le bucket de journaux :

• Pour lister les liens associés à un bucket de journaux, exécutez la méthode projects.locations.buckets.links.list.
• Pour supprimer un ensemble de données associé, exécutez la méthode projects.locations.buckets.links.delete.

Console Google Cloud

Pour restaurer un bucket de journaux en attente de suppression, procédez comme suit :

1. Dans la console Google Cloud , 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 le bucket que vous souhaitez restaurer, cliquez sur more_vert Plus, puis sélectionnez Restaurer un bucket supprimé.

3. Dans le panneau de confirmation, cliquez sur Restaurer.

4. Sur la page Stockage des journaux, l'indicateur de suppression en attente est retiré de votre bucket de journaux.

gcloud

Pour restaurer un bucket de journaux en attente de suppression, exécutez la commande gcloud logging buckets undelete :

gcloud logging buckets undelete BUCKET_ID --location=LOCATION

REST

Pour restaurer un bucket en attente de suppression, utilisez projects.locations.buckets.undelete dans l'API Logging.

Console Google Cloud

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. Pour personnaliser les journaux affichés dans l'explorateur de journaux, cliquez sur Affiner le champ d'application, puis sélectionnez une option. Par exemple, vous pouvez afficher les journaux stockés dans un projet ou par vue de journal.

3. Cliquez sur Appliquer. Le volet Résultats de la requête est actualisé avec les journaux correspondant à l'option que vous avez sélectionnée.

Pour en savoir plus, consultez Présentation de l'explorateur de journaux : affiner le champ d'application.

gcloud

Pour lire les journaux d'un bucket de journaux, utilisez la commande gcloud logging read et ajoutez un LOG_FILTER pour sélectionner les données :

gcloud logging read LOG_FILTER --bucket=BUCKET_ID --location=LOCATION --view=LOG_VIEW_ID

REST

Pour lire les journaux d'un bucket de journaux, utilisez la méthode entries.list. Définissez resourceNames pour spécifier le bucket et la vue de journaux appropriés, et définissez filter pour sélectionner les données.

Console Google Cloud

Pour mettre à jour la durée de conservation d'un bucket de journaux, procédez comme suit :

1. Dans la console Google Cloud , 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 le bucket que vous souhaitez mettre à jour, cliquez sur more_vert Plus, puis sélectionnez Modifier le bucket.

3. Dans le champ Conservation, saisissez le nombre de jours (compris entre 1 et 3 650 jours) pendant lesquels vous souhaitez que Cloud Logging conserve vos journaux.

4. Cliquez sur Mettre à jour le bucket. Votre nouvelle durée de conservation apparaît dans la liste Bucket de journaux.

gcloud

Pour mettre à jour la durée de conservation d'un bucket de journaux, exécutez la commande gcloud logging buckets update, après avoir défini une valeur pour RETENTION_DAYS :

gcloud logging buckets update BUCKET_ID  --location=LOCATION --retention-days=RETENTION_DAYS

Par exemple, pour conserver les journaux dans le bucket _Default dans l'emplacement global pendant un an, votre commande se présentera comme suit :

gcloud logging buckets update _Default --location=global --retention-days=365