Cette page explique comment configurer une alerte basée sur les journaux pour les ressources mises en coffre-fort à partir de la page Explorateur de journaux de la Google Cloud console.
La page Explorateur de journaux vous guide tout au long des étapes suivantes pour créer et modifier des alertes basées sur les journaux :
- Saisissez un nom et une description pour l'alerte.
- Choisissez les journaux pour lesquels vous souhaitez recevoir une notification.
- Définissez l'intervalle de temps entre les notifications.
- Définissez le délai de fermeture automatique des incidents.
- Indiquez les personnes à avertir.
Vous pouvez configurer des alertes pour les catégories de tâches de sauvegarde et de restauration : SCHEDULED_BACKUP, ON_DEMAND_BACKUP et RESTORE.
Vous pouvez également configurer des alertes pour les catégories de tâches d'association de plan de sauvegarde et de plan de sauvegarde : UPDATE.
Les états de tâche disponibles sont les suivants : SUCCESSFUL, FAILED, SKIPPED et RUNNING.
Vous pouvez configurer un ou plusieurs canaux de notification, tels que Google Chat, un e-mail, un SMS ou des canaux de programme de chat, pour recevoir des notifications lorsqu'une alerte se produit. Pour obtenir des instructions, consultez la page Créer et gérer des canaux de notification.
Avant de commencer
Créer une alerte basée sur les journaux
Pour notifier une alerte, vous devez disposer d'un canal de notification. Vous pouvez créer le canal de notification avant de créer une alerte ou lors de la création d'une alerte.
Suivez les instructions ci-dessous pour créer une alerte basée sur les journaux.
Dans la Google Cloud console, accédez à la page Explorateur de journaux.
Dans le volet Requête , définissez l'alerte pour laquelle vous souhaitez être averti.
La requête suivante est un exemple permettant d'être averti chaque fois qu'une tâche de sauvegarde planifiée échoue.
logName="projects/PROJECT_ID/logs/backupdr.googleapis.com/LOG_NAME" jsonPayload.jobCategory="SCHEDULED_BACKUP" jsonPayload.jobStatus="FAILED"Remplacez les éléments suivants :
PROJECT_ID: nom du projet.LOG_NAME: nom du journal, qui peut être l'un des suivants :bdr_backup_plan_jobs: tâches liées à un plan de sauvegardebdr_backup_plan_association_jobs: tâches liées à l'association de plan de sauvegarde dans le projet d'administrateur, en cas de protection inter-projets.bdr_backup_plan_association_source_jobs: tâches liées à l'association de plan de sauvegarde dans le projet de charge de travail.
Dans l'en-tête du volet Résultats de la requête, cliquez sur Créer une alerte.
Dans la section Détails de l'alerte, procédez comme suit :
- Dans le champ Nom de la règle d'alerte, saisissez un nom pour votre alerte. Ce nom s'affiche dans l'en-tête de la notification.
- Dans le champ Documentation, saisissez la description de l'alerte. Pour obtenir des informations sur la mise en forme et l'affinage du contenu de ce champ, consultez la section Utiliser Markdown et les variables dans les modèles de documentation.
Cliquez sur Suivant.
Dans la section Sélectionner les journaux à inclure dans l'alerte, procédez comme suit :
- Cliquez sur Aperçu des journaux pour vérifier la requête et les résultats. Si nécessaire, vous pouvez également modifier la requête dans ce volet.
Cliquez sur Ajouter une étiquette , puis procédez comme suit. Les étiquettes vous permettent de personnaliser les notifications et de les rendre plus informatives.
- Dans le champ Nom à afficher , saisissez un nom pour l'étiquette.
- Dans la liste Nom du champ de journal, sélectionnez un nom de champ de journal. Ces champs s'affichent en fonction du résultat de la requête sélectionnée.
- Dans le champ Expression régulière, saisissez une expression pour extraire une valeur du champ. Elle doit contenir exactement un groupe d'expressions régulières.
Cliquez sur Suivant.
Pour Définir la fréquence des notifications et le délai pour la fermeture automatique, procédez comme suit :
- Dans la liste Délai entre les notifications, sélectionnez le délai minimal entre les notifications. Cette valeur vous permet de contrôler le nombre de notifications que vous recevez de cette alerte si elle est déclenchée plusieurs fois.
- Dans la liste Durée de fermeture automatique des incidents, sélectionnez une durée après laquelle l'incident est automatiquement fermé en l'absence d'entrées de journal correspondantes.
Cliquez sur Suivant.
Dans la liste Canaux de notification, sélectionnez un ou plusieurs canaux de notification pour votre alerte. Si vous n'avez pas configuré de canal de notification, cliquez sur Gérer les canaux de notification pour en créer un. Pour obtenir des instructions, consultez la page Créer et gérer des canaux de notification.
Cliquez sur Enregistrer.
Tester l'alerte basée sur les journaux
Pour tester l'alerte basée sur les journaux que vous avez créée, vous pouvez écrire manuellement une entrée de journal correspondant à la requête.
Suivez les instructions ci-dessous pour écrire l'entrée de journal.
Accédez à la page de référence sur
logEntries.write.Configurez l'entrée de journal suivante en remplaçant la PROJECT_ID variable par votre ID de projet.
{ "entries": [ { "jsonPayload": { "jobCategory": "SCHEDULED_BACKUP", "jobStatus": "FAILED" } } ], "resource": { "type": "backupdr.googleapis.com/BackupDRProject" }, "logName": "projects/PROJECT_ID/logs/backupdr.googleapis.com%2Fbdr_backup_restore_jobs" }Remplacez les éléments suivants :
PROJECT_ID: nom du projet.
Copiez l'entrée de journal que vous avez configurée précédemment.
Dans le volet Essayer cette API, procédez comme suit :
- Dans le champ Corps de la requête, remplacez le contenu par l'entrée de journal que vous avez copiée à l'étape précédente.
- Cliquez sur Exécuter. Si vous y êtes invité, suivez la procédure d'authentification.
Si l'appel
logEntries.writeaboutit, vous obtenez un code de réponse HTTP200et un corps de réponse vide,{}. Pour en savoir plus sur APIs Explorer, consultez la page Utiliser l'APIs Explorer.L'entrée de journal correspond au filtre spécifié pour l'alerte comme suit :
- La valeur
logNamespécifie les journaux des tâches de sauvegarde ou de restauration dans votre projet cloud. - Le
jsonPayloadcontient une catégorie de tâche ayant échoué,SCHEDULED_BACKUP, ce qui indique que le journal est lié à une sauvegarde planifiée par un plan de sauvegarde. - Le
jsonPayloadcontient l'état de la tâche de champ en tant queFAILED, ce qui signifie que la tâche a échoué.
- La valeur
Une fois l'entrée de journal écrite, la séquence suivante se produit :
- La nouvelle entrée de journal apparaît dans l'explorateur de journaux et déclenche l'alerte.
- Un incident est ouvert dans la page Cloud Monitoring.
Vous recevez une notification pour l'incident. Si vous avez configuré un canal de notification par e-mail, la notification s'affiche.
Vous pouvez cliquer sur Afficher l'incident dans l'e-mail pour afficher l'incident dans la page Cloud Monitoring. Pour en savoir plus sur les incidents, y compris sur la façon de les accuser réception et de les fermer, consultez la page Gérer les incidents pour les alertes basées sur les journaux.