Activación de las notificaciones de eventos para Backup for VPC

Configura IBM Cloud® Event Notifications para recibir alertas cuando fallen las tareas de Backup for VPC. Envía notificaciones por correo electrónico, SMS o webhooks para supervisar la creación de instantáneas de copia de seguridad, los fallos de retención y los problemas relacionados con los grupos de consistencia.

Para enviar información a Event Notifications, debe conectar su instancia IBM Cloud Backup for VPC a Event Notifications. Para obtener más información sobre cómo trabajar con Event Notifications, consulte Iniciación a Event Notifications.

Cómo se recopilan y envían los eventos por IBM Cloud Backup for VPC

Los trabajos de copia de seguridad cumplen 2 tipos de tareas. Una tarea es responsable de tomar las instantáneas de las copias de seguridad según lo programado, la otra tarea gestiona las copias de seguridad existentes y aplica la regla de retención en las copias de seguridad. Si un trabajo de copia de seguridad falla, IBM Cloud Backup for VPC se comunica con una instancia Event Notifications conectada para reenviar una notificación a un destino compatible.

Eventos para IBM Cloud Backup for VPC

En la siguiente tabla se enumeran los eventos IBM Cloud Backup for VPC.

Acciones que generan notificaciones de eventos
Tipo de suceso Descripción

Fallo en la creación del trabajo de copia de seguridad de volumen

  • 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
Estos eventos se crean cuando un trabajo de copia de seguridad no puede crear una instantánea de copia de seguridad debido a la falta de autorización, a la existencia de demasiadas instantáneas o a que el volumen de origen está ocupado. Para obtener más información, consulte límite de instantáneas, estados del ciclo de vida de las instantáneas y autorizaciones de servicio a servicio. Para obtener más información sobre posibles soluciones, consulte Solución de problemas de copia de seguridad.

Fallo de retención del trabajo de copia de seguridad de volumen

  • service-to-service-policy-missing
  • snapshot-bad-state
  • snapshot-in-pending-state
Estos eventos se crean cuando un trabajo de copia de seguridad no puede eliminar una instantánea de copia de seguridad debido a la falta de autorización, o porque la instantánea estaba en estado pending o bad. Para obtener más información, consulte estados del ciclo de vida de las instantáneas, y autorizaciones de servicio a servicio.

Fallo en la creación del trabajo de copia de seguridad de la instancia

  • 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
Estos eventos se crean cuando un trabajo de copia de seguridad no puede crear las instantáneas de un grupo de consistencia debido a diversas razones. Por ejemplo, falta de autorización, indisponibilidad de la instancia a la que se adjuntan los volúmenes, clave de cifrado inaccesible o se alcanzan los límites de servicio para el tamaño del volumen o el número de instantáneas. Para obtener más información, consulte estados del ciclo de vida de las instantáneas, y autorizaciones de servicio a servicio. Para obtener más información sobre posibles soluciones, consulte Solución de problemas de copia de seguridad.

Fallo de retención del trabajo de copia de seguridad de la instancia

  • service-to-service-policy-missing
  • snapshot_consistency_group-bad-state
  • snapshot-consistency-group-in-pending-state
Estos eventos se crean cuando un trabajo de copia de seguridad no puede eliminar las instantáneas de copia de seguridad que forman parte de un grupo de consistencia debido a la falta de autorización, o las instantáneas están en estado pending. Para obtener más información, consulte estados del ciclo de vida de las instantáneas, y autorizaciones de servicio a servicio. Para obtener más información sobre posibles soluciones, consulte Solución de problemas de copia de seguridad.

Cuando vea estas alertas, puede utilizar la API o la CLI para confirmar el motivo del estado fallido.

Para obtener más información sobre cómo resolver el problema, consulte Solución de problemas de Backup for VPC.

Habilitar notificaciones

Los eventos generados por una instancia del servicio « IBM Cloud Backup for VPC » pueden reenviarse a una instancia del servicio « Event Notifications » disponible en la misma cuenta. Solo se puede configurar una fuente del servicio de copia de seguridad para cada instancia del servicio « Event Notifications ».

Si aún no existe una autorización de IAM entre IBM Cloud Backup for VPC y Event Notifications en su cuenta, cree una con la función Administrador de origen de eventos. Para obtener más información, consulte Establecer autorizaciones de servicio a servicio.

Antes de habilitar las notificaciones para IBM Cloud Backup for VPC, asegúrese de que dispone de una Event Notifications instancia de servicio que se encuentra en la misma cuenta que su IBM Cloud Backup for VPC instancia.

A continuación, puedes utilizar la sección «Acciones > Notificaciones de eventos» de la página de detalles de la política de « IBM Cloud Backup » para conectar los servicios.

A continuación, puedes conectarte a « Event Notifications » mediante programación, llamando a la API de notificación de eventos.

Conexión a Event Notifications en la consola

  1. En la consola IBM Cloud, haga clic en el ícono del menú de navegación > ícono de Infraestructura VPC > Almacenamiento > Políticas de respaldo.

  2. Haga clic en el nombre de una política.

  3. Haz clic en Acciones Icono de acciones y selecciona Notificaciones de eventos.

  4. En el panel lateral Conectar con Event Notifications, revise los detalles de origen de la conexión y proporcione una descripción.

  5. Selecciona el grupo de recursos y la instancia del servicio « Event Notifications » a la que deseas conectarte.

    Si no existe una autorización de IAM entre IBM Cloud Backup for VPC y Event Notifications en su cuenta, siga los pasos de Activación de la autorización de servicio a servicio para Event Notifications para configurarla. Para configurar las autorizaciones se requiere la función de administrador de AIM.

  6. Para confirmar la conexión, haz clic en « Guardar ».

Conexión a Event Notifications desde la CLI

Para conectar su fuente IBM Cloud Backup for VPC a desde la CLI, utilice el 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]

Para obtener más información, consulte la Referencia CLI de notificación de eventos.

Conectar a Event Notifications con la API

El siguiente ejemplo muestra una consulta que puedes utilizar para registrar los datos de tu fuente de IBM Cloud Backup for VPC en Event Notifications. Cuando llames a la API, sustituye las variables de ID y el token de IAM por los valores específicos de tu instancia de IBM Cloud Backup for VPC.

Puedes encontrar el valor « event_notifications_instance_crn » en la consola accediendo a la página «Lista de recursos» y haciendo clic en la fila de la instancia « 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 respuesta correcta devuelve el valor CRN de la instancia del servicio « Event Notifications » a la que estás conectado. Para obtener más información sobre los parámetros de solicitud obligatorios y opcionales, consulte la Documentación de la API de notificación de eventos.

Conexión a Event Notifications con Terraform

Para conectar el servicio IBM Cloud Backup for VPC a Event Notifications, utilice el recurso ibm_en_source. Para obtener más información sobre los argumentos y atributos, consulte la referencia de Terraform para el recurso 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
}

Entregar notificaciones a destinos seleccionados

Una vez que hayas activado las notificaciones en IBM Cloud Backup for VPC, crea temas y suscripciones en Event Notifications para que las alertas puedan reenviarse y enviarse a los destinos que hayas seleccionado.

Para obtener una lista completa de destinos soportados, consulte la Documentación de Event Notifications.

Notificaciones por correo electrónico

Puede utilizar el servicio de correo electrónico IBM Cloud como canal de entrega de notificaciones de eventos IBM Cloud Backup for VPC. Puede crear una suscripción de Event Notifications entre un tema existente y el servicio de correo electrónico de IBM Cloud para reenviar las alertas a varios destinatarios por correo electrónico.

Un correo electrónico de IBM Cloud que contiene información sobre un evento de IBM Cloud Backup for VPC se parece al siguiente ejemplo:

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

Para recibir información detallada sobre una notificación de sucesos en el correo electrónico, seleccione la opción Añadir carga útil de notificación cuando cree una suscripción de Event Notifications. El correo electrónico muestra detalles de la carga útil de notificación que están asociados con el suceso.

Webhooks

Puede configurar un destino de webhook para que una aplicación o servicio pueda consumir una notificación de entrada mediante programación. Para obtener más información sobre cómo configurar los webhooks, consulte la Documentación de Event Notifications.

Detalles de carga útil de notificación

Los eventos correctos generados por IBM Cloud Backup for VPC contienen varios campos que te ayudan a identificar el origen y los detalles de un evento.

Las notificaciones de eventos de IBM Cloud Backup for VPC solo contienen propiedades de metadatos, como nombres o identificadores de recursos. Los datos confidenciales, por ejemplo claves de API o contraseñas, no se incluyen en los sucesos generados.

Las propiedades que se envían a Event Notifications varían en función del tipo de evento. Por ejemplo, si se produce un evento Backup job creation failed, IBM Cloud Backup for VPC envía una carga útil de notificación a Event Notifications que es similar al siguiente ejemplo.

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