Activation des notifications d'événements pour Backup for VPC
Configurez IBM Cloud® Event Notifications pour recevoir des alertes en cas d'échec des tâches de sauvegarde pour VPC. Envoyez des notifications par e-mail, SMS ou webhooks pour surveiller la création des instantanés de sauvegarde, les échecs de conservation et les problèmes liés aux groupes de cohérence.
Pour envoyer des informations à Event Notifications, vous devez connecter votre instance IBM Cloud Backup for VPC à Event Notifications. Pour plus d'informations sur l'utilisation de Event Notifications, voir Initiation à Event Notifications.
Comment les événements sont collectés et envoyés par IBM Cloud Backup for VPC
Les travaux de sauvegarde remplissent deux types de tâches. Une tâche est chargée de prendre les instantanés de sauvegarde comme prévu, l'autre tâche gère les sauvegardes existantes et applique la règle de rétention sur les sauvegardes. Si une tâche de sauvegarde échoue, IBM Cloud Backup for VPC communique avec une instance Event Notifications connectée pour transmettre une notification à une destination prise en charge.
Événements pour IBM Cloud Backup for VPC
Le tableau suivant répertorie les événements IBM Cloud Backup for VPC.
| Type d'événement | Description |
|---|---|
|
Échec de la création d'une tâche de sauvegarde de volume
|
Ces événements sont créés lorsqu'une tâche de sauvegarde ne peut pas créer un instantané de sauvegarde en raison d'une autorisation manquante, d'un trop grand nombre d'instantanés existants ou lorsque le volume source est occupé. Pour plus d'informations, voir limite de l'instantané, états du cycle de vie de l'instantané, et autorisations de service à service. Pour plus d'informations sur les correctifs possibles, consultez les rubriques Dépannage de sauvegarde. |
|
Échec de la conservation du travail de sauvegarde du volume
|
Ces événements sont créés lorsqu'une tâche de sauvegarde ne peut pas supprimer un instantané de sauvegarde en raison d'une autorisation manquante ou parce que l'instantané était dans l'état pending ou bad. Pour
plus d'informations, voir états du cycle de vie de l'instantané, et autorisations de service à service. |
|
Échec de la création d'une tâche de sauvegarde d'instance
|
Ces événements sont créés lorsqu'un travail de sauvegarde ne peut pas créer les instantanés d'un groupe de cohérence pour diverses raisons. Par exemple, autorisation manquante, indisponibilité de l'instance à laquelle les volumes sont attachés, clé de chiffrement inaccessible, ou limites de service pour la taille du volume ou le nombre d'instantanés atteintes. Pour plus d'informations, voir états du cycle de vie de l'instantané, et autorisations de service à service. Pour plus d'informations sur les correctifs possibles, consultez les rubriques Dépannage de sauvegarde. |
|
Échec de la conservation du travail de sauvegarde de l'instance
|
Ces événements sont créés lorsqu'un travail de sauvegarde ne peut pas supprimer les instantanés de sauvegarde qui font partie d'un groupe de cohérence en raison d'une autorisation manquante, ou lorsque les instantanés sont dans l'état
pending. Pour plus d'informations, voir états du cycle de vie de l'instantané, et autorisations de service à service.
Pour plus d'informations sur les correctifs possibles, consultez les rubriques Dépannage de sauvegarde. |
Lorsque vous voyez ces alertes, vous pouvez utiliser le API ou le CLI pour confirmer la raison de l'échec.
Pour plus d'informations sur la résolution du problème, voir Dépannage de Backup for VPC.
Activation des notifications
Les événements générés par une instance du service « IBM Cloud Backup for VPC » peuvent être transférés vers une instance du service « Event Notifications » disponible dans le même compte. Vous ne pouvez configurer qu'une seule source de service de sauvegarde par instance du service « Event Notifications ».
Si une autorisation IAM entre IBM Cloud Backup for VPC et Event Notifications n'existe pas encore dans votre compte, créez-en une avec le rôle Event Source Manager. Pour plus d'informations, voir Établissement d'autorisations de service à service.
Avant d'activer les notifications pour IBM Cloud Backup for VPC, assurez-vous que vous disposez d'une Event Notifications instance de service qui se trouve dans le même compte que votre IBM Cloud Backup for VPC instance.
Vous pouvez ensuite utiliser la section « Actions > Notifications d'événements » de la page de détails de la politique « IBM Cloud Backup » pour connecter les services.
Vous pouvez ensuite vous connecter à l' Event Notifications 'un code en appelant l'API de notification d'événements.
Connexion à Event Notifications depuis la console
-
Dans la console IBM Cloud, cliquez sur l'icône de
Navigation > Infrastructure
> Stockage > Politiques de sauvegarde.
-
Cliquez sur le nom d'une politique.
-
Cliquez sur Actions
et sélectionnez Notifications d'événements.
-
Dans le panneau latéral Connecter à Event Notifications, examinez les détails de la source pour la connexion et fournissez une description.
-
Sélectionnez le groupe de ressources et l'instance du service « Event Notifications » à laquelle vous souhaitez vous connecter.
Si une autorisation IAM entre IBM Cloud Backup for VPC et Event Notifications n'existe pas dans votre compte, suivez les étapes décrites dans Activation de l'autorisation de service à service pour Event Notifications pour la configurer. Le rôle d'administrateur AIM est nécessaire pour définir les autorisations.
-
Pour valider la connexion, cliquez sur « Enregistrer ».
Connexion à Event Notifications depuis le CLI
Pour connecter votre source IBM Cloud Backup for VPC à partir de la CLI, utilisez la commande ibmcloud event-notifications sources-create.
ibmcloud event-notifications sources-create --instance-id INSTANCE-ID --name NAME --source BACKUP POLICY CRN --description DESCRIPTION [--enabled ENABLED]
Pour plus d'informations, voir la Référence CLI pour la notification d'événements.
Connexion à Event Notifications avec l'API
L'exemple suivant présente une requête que vous pouvez utiliser pour enregistrer les informations relatives à votre source « IBM Cloud Backup for VPC » sur Event Notifications. Lorsque vous appelez l'API, remplacez les variables d'ID et le jeton IAM par les valeurs propres à votre instance d' IBM Cloud Backup for VPC.
Vous pouvez trouver la valeur « event_notifications_instance_crn » dans la console en accédant à la page « Liste des ressources » et en cliquant sur la ligne correspondant à l'instance « Event Notifications ».
curl -X POST "{base_url}/v1/instances/{instance_id}/sources"
-H "Authorization: Bearer {iam_token}"
-H "Content-Type: application/json"
-d '{
"name":"Event Notification Source - Backup policy",
"source" : "crn:v1:bluemix:public:is:us-south:a/{{account_id}}::backup-policy:",
"description":"Backup policy service registration. This source provides notifications for backup job failures.",
"enabled":true,
"event_notifications_instance_crn": "crn:v1:bluemix:public:event-notifications:<region>:a/<account-id>:<service-instance>::"
}'
Une réponse réussie renvoie la valeur CRN de votre instance du service « Event Notifications » connectée. Pour plus d'informations sur les paramètres de demande obligatoires et facultatifs, voir la Documentation de l'API de notification d'événements.
Connexion à Event Notifications avec Terraform
Pour connecter le service IBM Cloud Backup for VPC à Event Notifications, utilisez la ressource ibm_en_source. Pour plus d'informations sur les arguments et les attributs, voir la référence Terraform pour la ressource ibm_en_source.
resource "ibm_en_source" "en_source" {
instance_guid = ibm_resource_instance.en_terraform_test_resource.guid
name = "EN Source for Backup jobs"
source = "crn:v1:bluemix:public:is:us-south:a/{{account_id}}::backup-policy:"
description = "API source for Event notification destinations"
enabled = true
}
Distribution de notifications pour sélectionner des destinations
Une fois que vous aurez activé les notifications pour IBM Cloud Backup for VPC, créez des sujets et des abonnements sur Event Notifications afin que les alertes puissent être transmises et envoyées vers les destinations de votre choix.
Pour obtenir la liste complète des destinations prises en charge, voir la documentation Event Notifications.
Notifications par e-mail
Vous pouvez utiliser le IBM Cloud service de courrier électronique comme canal de distribution pour les notifications d'événements IBM Cloud Backup for VPC. Création d'un abonnement Event Notifications entre une rubrique existante et le service de messagerie électronique IBM Cloud pour transmettre vos alertes à différents destinataires par email.
Un courriel de IBM Cloud qui contient des informations sur un événement IBM Cloud Backup for VPC ressemble à l'exemple suivant :
Email Title: Volume Backup Job Creation Failure
Email Body:
Volume Backup Job Creation Failure. Resource: crn:v1:bluemix:public:is:us-south-1:a/be09dae34250437f96fc8b27ae7d233b::volume:r006-f6583aac-8ba9-4d04-ab7a-acfe7b420016. BackupJobID: r006-899ab8fb-3b71-4fc8-bca5-1544cb425e4f. Reason: Snapshot quota per volume reached.
Notification details:
{
"backup_policy": "r006-306fd8f6-b14c-410d-8f29-f05282b6daa9",
"backup_policy_job": "r006-899ab8fb-3b71-4fc8-bca5-1544cb425e4f",
"backup_policy_plan": "r006-444bb07f-3399-42d5-b895-febcaca8d1bc",
"match_resource_type" : "volume",
"job_type" : "creation",
"reasons": [
{
"more_info": "https://cloud.ibm.com/docs/vpc?topic=vpc-troubleshooting-backup-for-vpc",
"status": "source_volume_too_large"
}
],
"resource": "crn:v1:bluemix:public:is:us-south-1:a/be09dae34250437f96fc8b27ae7d233b::volume:r006-f6583aac-8ba9-4d04-ab7a-acfe7b420016"
}
Pour recevoir sur votre adresse e-mail des informations détaillées au sujet d'une notification d’évènement , sélectionnez l'option Ajouter une charge de notification lorsque vous créez un abonnement Event Notifications . Votre e-mail affiche le Détails de la charge de notification qui est associé à l'évènement.
Webhooks
Vous pouvez configurer une destination webhook de sorte qu'une notification entrante puisse être consommée à l'aide d'un programme par une application ou un service. Pour plus d'informations sur la configuration des webhooks, consultez le fichier de la documentation Event Notifications.
Détails du contenu de la notification
Les événements réussis générés par IBM Cloud Backup for VPC contiennent divers champs qui vous aident à identifier la source et les détails d'un événement.
Les notifications d'événements provenant de IBM Cloud Backup for VPC ne contiennent que des propriétés de métadonnées, telles que les noms ou les identifiants des ressources. Les données sensibles, par exemple les clés d'API ou les mots de passe, ne sont pas incluses dans les événements générés.
Les propriétés transmises à Event Notifications varient en fonction du type d'événement. Par exemple, si un événement Backup job creation failed a lieu, IBM Cloud Backup for VPC envoie une charge utile de notification à Event Notifications
qui est similaire à l'exemple suivant.
{
"ibmendefaultlong": "{\"status\":\"Backup job creation / retention failed\",
\"backup_policy\": r006-6da51cfe-6f7b-4638-a6ba-00e9c327b178,
\"backup_policy_plan\":\"r006-076191ba-49c2-4763-94fd-c70de73ee2e6\",
\"status_reason\": \"source_volume_busy: The source volume has busy set (after multiple retries)\",
\"match_resource_type\": \"instance\",
\"job_type\": \"creation\",
\"more_info\": \"https://cloud.ibm.com/docs/vpc?topic=vpc-baas-troubleshoot\"}",
"ibmendefaultshort": "Backup Job creation / retention failed",
"id": "b2198eb8-04b1-48ec-a78c-ee87694dd845",
"time": "2024-04-22T20:59:34Z",
"ibmenseverity": "medium",
"type": "com.ibm.cloud.is.backup-policy.backup-volume-creation",
"source": "com.ibm.cloud.is.backup-policy",
"specversion": "1.0",
"ibmensourceid": "41cdb7d4-db3e-496b-b7df-d4ead362c412:api"
}