Abilitazione delle notifiche degli eventi per Backup for VPC

Configurare IBM Cloud® Event Notifications per ricevere avvisi in caso di errore nei processi di Backup for VPC. Invia notifiche tramite e-mail, SMS o webhook per monitorare la creazione delle istantanee di backup, gli errori di conservazione e i problemi relativi ai gruppi di coerenza.

Per inviare informazioni a Event Notifications, è necessario collegare l'istanza IBM Cloud Backup for VPC a Event Notifications. Per ulteriori informazioni su come lavorare con Event Notifications, vedere Iniziare con Event Notifications.

Come vengono raccolti e inviati gli eventi da IBM Cloud Backup for VPC

I lavori di backup soddisfano due tipi di compiti. Un'attività è responsabile dell'acquisizione delle istantanee di backup come programmato, mentre l'altra attività gestisce i backup esistenti e applica la regola di conservazione ai backup. Se un processo di backup non riesce, IBM Cloud Backup for VPC comunica con un'istanza Event Notifications collegata per inoltrare una notifica a una destinazione supportata.

Eventi per IBM Cloud Backup for VPC

La tabella seguente elenca gli eventi IBM Cloud Backup for VPC.

Azioni che generano notifiche di eventi
Tipo di evento Descrizione

Errore nella creazione del lavoro di backup del volume

  • service-to-service-policy-missing
  • snapshot-quota-reached
  • snapshots-bad-state
  • snapshots-source-volume-busy
  • snapshot-volume-too-large
  • snapshot-volume-unavailable
  • snapshots-encryption-key-invalid
Questi eventi vengono creati quando un processo di backup non può creare un'istantanea di backup a causa di un'autorizzazione mancante, di un numero eccessivo di istantanee esistenti o quando il volume sorgente è occupato. Per ulteriori informazioni, vedere limite di snapshot, stati del ciclo di vita di snapshot e autorizzazioni da servizio a servizio. Per ulteriori informazioni sulle possibili soluzioni, consultare gli argomenti relativi alla risoluzione dei problemi del backup.

Errore di conservazione del lavoro di backup del volume

  • service-to-service-policy-missing
  • snapshot-bad-state
  • snapshot-in-pending-state
Questi eventi vengono creati quando un processo di backup non può eliminare un'istantanea di backup a causa di un'autorizzazione mancante o perché l'istantanea era nello stato pending o bad. Per ulteriori informazioni, vedere stati del ciclo di vita dei snapshot e autorizzazioni da servizio a servizio.

Errore di creazione del lavoro di backup dell'istanza

  • service-to-service-policy-missing
  • snapshot_consistency_group-quota-reached
  • snapshot_consistency_group-bad-state
  • snapshot_consistency_group-source-volume-busy
  • snapshot_consistency_group-volume-too-large
  • snapshot_consistency_group-volume-unavailable
  • snapshot_consistency_group-encryption-key-invalid
Questi eventi vengono creati quando un processo di backup non può creare le istantanee di un gruppo di coerenza per vari motivi. Ad esempio, l'autorizzazione mancante, l'indisponibilità dell'istanza a cui sono collegati i volumi, la chiave di crittografia inaccessibile o il raggiungimento dei limiti di servizio per le dimensioni del volume o il numero di istantanee. Per ulteriori informazioni, vedere stati del ciclo di vita dei snapshot e autorizzazioni da servizio a servizio. Per ulteriori informazioni sulle possibili soluzioni, consultare gli argomenti relativi alla risoluzione dei problemi del backup.

Mancato mantenimento del lavoro di backup dell'istanza

  • service-to-service-policy-missing
  • snapshot_consistency_group-bad-state
  • snapshot-consistency-group-in-pending-state
Questi eventi vengono creati quando un processo di backup non può eliminare le istantanee di backup che fanno parte di un gruppo di coerenza a causa di un'autorizzazione mancante, oppure le istantanee si trovano nello stato pending. Per ulteriori informazioni, vedere stati del ciclo di vita dei snapshot e autorizzazioni da servizio a servizio. Per ulteriori informazioni sulle possibili soluzioni, consultare gli argomenti relativi alla risoluzione dei problemi del backup.

Quando si visualizzano questi avvisi, è possibile utilizzare l'API o CLI per confermare il motivo dello stato di fallimento.

Per ulteriori informazioni su come risolvere il problema, consultare Troubleshooting Backup for VPC.

Abilitazione delle notifiche

Gli eventi generati da un'istanza del servizio IBM Cloud Backup for VPC possono essere inoltrati a un'istanza del servizio Event Notifications disponibile nello stesso account. È possibile configurare una sola origine del servizio Backup per un'istanza del servizio Event Notifications.

Se nell'account non esiste ancora un'autorizzazione IAM tra IBM Cloud Backup for VPC e Event Notifications, crearne una con il ruolo Event Source Manager. Per ulteriori informazioni, vedere Stabilire le autorizzazioni da servizio a servizio.

Prima di poter abilitare le notifiche per IBM Cloud Backup for VPC, assicurarsi di avere un Event Notifications istanza di servizio che sia nello stesso account dell'istanza IBM Cloud Backup for VPC.

A questo punto, puoi utilizzare la sezione " Azioni > Notifiche sugli eventi " nella pagina dei dettagli della politica " IBM Cloud Backup " per collegare i servizi.

A questo punto, è possibile connettersi a Event Notifications a livello di programmazione richiamando l'API di notifica degli eventi.

Connessione a Event Notifications nella console

  1. Nella console IBM Cloud, fai clic sull'icona del menu di navigazione > icona VPC infrastruttura > Archiviazione > Criteri di backup.

  2. Fare clic sul nome di un criterio.

  3. Fare clic su Azioni Icona Azioni e selezionare Notifiche eventi.

  4. Nel pannello laterale Connetti a Event Notifications, esaminare i dettagli dell'origine della connessione e fornire una descrizione.

  5. Selezionare il gruppo di risorse e l'istanza del servizio Event Notifications che si desidera collegare.

    Se nel vostro account non esiste un'autorizzazione IAM tra IBM Cloud Backup for VPC e Event Notifications, seguite la procedura descritta in Abilitazione dell'autorizzazione da servizio a servizio per Event Notifications per configurarla. Per impostare le autorizzazioni è necessario il ruolo di amministratore AIM.

  6. Per confermare la connessione, fare clic su Salva.

Connessione a Event Notifications da CLI

Per collegare la sorgente IBM Cloud Backup for VPC alla CLI, utilizzare il comando ibmcloud event-notifications sources-create.

ibmcloud event-notifications sources-create --instance-id INSTANCE-ID --name NAME --source BACKUP POLICY CRN --description DESCRIPTION [--enabled ENABLED]

Per ulteriori informazioni, consultare il Riferimento della CLI per la notifica degli eventi.

Connessione a Event Notifications con l'API

L'esempio seguente mostra una query da usare per registrare i dettagli dell'origine IBM Cloud Backup for VPC con Event Notifications. Quando si chiama l'API, sostituire le variabili ID e il token IAM con i valori specifici dell'istanza IBM Cloud Backup for VPC.

È possibile trovare il valore " event_notifications_instance_crn " nella console accedendo alla pagina "Elenco risorse" e facendo clic sulla riga relativa all'istanza " 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>::"
      }'

Una risposta corretta restituisce il valore CRN dell'istanza di servizio Event Notifications collegata. Per ulteriori informazioni sui parametri di richiesta obbligatori e facoltativi, consultare i documenti Api di notifica degli eventi.

Connessione a Event Notifications con Terraform

Per collegare il servizio IBM Cloud Backup for VPC a Event Notifications, utilizzare la risorsa ibm_en_source. Per ulteriori informazioni sugli argomenti e gli attributi, vedere il riferimento di Terraform per la risorsa 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
}

Consegna delle notifiche a destinazioni selezionate

Dopo aver attivato le notifiche per IBM Cloud Backup for VPC, creare argomenti e sottoscrizioni in Event Notifications in modo che gli avvisi possano essere inoltrati e consegnati alle destinazioni selezionate.

Per un elenco completo delle destinazioni supportate, consultare la documentazione di Event Notifications.

Notifiche email

È possibile utilizzare IBM Cloud servizio e-mail come canale di consegna per le notifiche di eventi IBM Cloud Backup for VPC. Creare un Event Notifications abbonamento tra un argomento esistente e il servizio di posta elettronica IBM Cloud per inoltrare gli avvisi a vari destinatari via e-mail.

Un messaggio di posta elettronica da IBM Cloud che contiene informazioni su un evento IBM Cloud Backup for VPC assomiglia al seguente esempio:

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"
 }

Per ricevere informazioni dettagliate su una notifica di evento via e-mail, seleziona l'opzione " Aggiungi payload di notifica " quando crei un abbonamento Event Notifications. L'e-mail visualizza i dettagli del carico di notifica associati all'evento.

Webhook

È possibile configurare una destinazione webhook in modo che una notifica in arrivo possa essere consumata in modo programmatico da un'applicazione o un servizio. Per ulteriori informazioni sull'impostazione dei webhook, consultare la documentazione Event Notifications.

Dettagli del carico utile della notifica

Gli eventi di successo generati da IBM Cloud Backup for VPC contengono vari campi che aiutano a identificare l'origine e i dettagli di un evento.

Le notifiche relative agli eventi provenienti da IBM Cloud Backup for VPC contengono solo proprietà di metadati, quali nomi o identificatori delle risorse. I dati sensibili, ad esempio le chiavi API o le password, non sono inclusi negli eventi generati.

Le proprietà inviate a Event Notifications variano a seconda del tipo di evento. Ad esempio, se si verifica un evento Backup job creation failed, IBM Cloud Backup for VPC invia un payload di notifica a Event Notifications simile al seguente esempio.

{
  "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"
}