Ativação de notificações de eventos para o Backup para VPC

Configure o IBM Cloud® Event Notifications para receber alertas quando as tarefas do Backup for VPC falharem. Envie notificações por e-mail, SMS ou webhooks para monitorar a criação de instantâneos de backup, falhas de retenção e problemas relacionados a grupos de consistência.

Para enviar informações para o Event Notifications, você deve conectar sua instância do IBM Cloud Backup for VPC ao Event Notifications. Para obter mais informações sobre como trabalhar com o Event Notifications, consulte Introdução ao Event Notifications.

Como os eventos são coletados e enviados pelo IBM Cloud Backup for VPC

Os trabalhos de backup cumprem dois tipos de tarefas. Uma tarefa é responsável por tirar os instantâneos de backup conforme programado, a outra tarefa gerencia os backups existentes e aplica a regra de retenção nos backups. Se um trabalho de backup falhar, o IBM Cloud Backup for VPC se comunica com uma instância conectada do Event Notifications para encaminhar uma notificação a um destino suportado.

Eventos para IBM Cloud Backup for VPC

A tabela a seguir lista os eventos do IBM Cloud Backup for VPC.

Ações que geram notificações de eventos
Tipo de evento Descrição

Falha na criação da tarefa de backup de 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
Esses eventos são criados quando um trabalho de backup não consegue criar um instantâneo de backup devido à falta de autorização, ao excesso de instantâneos existentes ou quando o volume de origem está ocupado. Para obter mais informações, consulte limite de snapshot, estados do ciclo de vida do snapshot e autorizações de serviço para serviço. Para obter mais informações sobre possíveis correções, consulte Tópicos de solução de problemas de backup.

Falha na retenção da tarefa de backup de volume

  • service-to-service-policy-missing
  • snapshot-bad-state
  • snapshot-in-pending-state
Esses eventos são criados quando um trabalho de backup não pode excluir um instantâneo de backup devido à falta de autorização ou porque o instantâneo estava no estado pending ou bad. Para obter mais informações, consulte estados do ciclo de vida do snapshot e autorizações de serviço para serviço.

Falha na criação da tarefa de backup da instância

  • 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
Esses eventos são criados quando um trabalho de backup não consegue criar os instantâneos de um grupo de consistência devido a vários motivos. Por exemplo, falta de autorização, indisponibilidade da instância à qual os volumes estão anexados, chave de criptografia inacessível ou limites de serviço para o tamanho do volume ou número de instantâneos atingidos. Para obter mais informações, consulte estados do ciclo de vida do snapshot e autorizações de serviço para serviço. Para obter mais informações sobre possíveis correções, consulte Tópicos de solução de problemas de backup.

Falha na retenção do trabalho de backup da instância

  • service-to-service-policy-missing
  • snapshot_consistency_group-bad-state
  • snapshot-consistency-group-in-pending-state
Esses eventos são criados quando uma tarefa de backup não pode excluir os instantâneos de backup que fazem parte de um grupo de consistência devido à falta de autorização ou quando os instantâneos estão no estado pending. Para obter mais informações, consulte estados do ciclo de vida do snapshot e autorizações de serviço para serviço. Para obter mais informações sobre possíveis correções, consulte Tópicos de solução de problemas de backup.

Ao ver esses alertas, você pode usar a API ou CLI para confirmar o motivo do status de falha.

Para obter mais informações sobre como resolver o problema, consulte Solução de problemas do Backup para VPC.

Ativando notificações

Os eventos gerados por uma instância do serviço “ IBM Cloud Backup for VPC ” podem ser encaminhados para uma instância do serviço “ Event Notifications ” disponível na mesma conta. É possível configurar apenas uma fonte do serviço de backup para uma instância do serviço “ Event Notifications ”.

Se uma autorização de IAM entre IBM Cloud Backup for VPC e Event Notifications ainda não existir em sua conta, crie uma com a função Event Source Manager. Para obter mais informações, consulte Estabelecimento de autorizações de serviço para serviço.

Antes de ativar as notificações para o IBM Cloud Backup for VPC, certifique-se de que você tenha uma instância de serviço Event Notifications que esteja na mesma conta que a sua instância do IBM Cloud Backup for VPC.

Em seguida, você pode usar a seção Ações > Notificações de eventos na página de detalhes da política “ IBM Cloud Backup ” para conectar os serviços.

Então, você pode se conectar ao Event Notifications programaticamente, chamando a API de Notificação de Eventos.

Conectando-se ao Event Notifications no console

  1. No console IBM Cloud, clique no ícone do menu Navegação > ícone VPC de infraestrutura > Armazenamento > Políticas de backup.

  2. Clique em um nome de política.

  3. Clique em Actions Actions icon e selecione Event notifications.

  4. No painel lateral Connect to Event Notifications, revise os detalhes da origem da conexão e forneça uma descrição.

  5. Selecione o grupo de recursos e a instância do serviço “ Event Notifications ” à qual deseja se conectar.

    Se não houver uma autorização de IAM entre IBM Cloud Backup for VPC e Event Notifications em sua conta, siga as etapas em Como habilitar a autorização de serviço a serviço para Event Notifications para configurá-la. A função de administrador do AIM é necessária para configurar as autorizações.

  6. Para confirmar a conexão, clique em Salvar.

Conectando-se a Event Notifications a partir da CLI

Para conectar sua origem do IBM Cloud Backup for VPC à CLI, use o 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 obter mais informações, consulte a Referência da CLI de notificação de eventos.

Conectando-se ao Event Notifications com a API

O exemplo a seguir mostra uma consulta que você pode usar para registrar os detalhes da sua fonte do IBM Cloud Backup for VPC no site Event Notifications. Ao chamar a API, substitua as variáveis de ID e o token do IAM pelos valores específicos da sua instância do IBM Cloud Backup for VPC.

Você pode encontrar o valor de “ event_notifications_instance_crn ” no console acessando a página “Lista de recursos” e clicando na linha da instância “ 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>::"
      }'

Uma resposta bem-sucedida retorna o valor do CRN da sua instância conectada do serviço “ Event Notifications ”. Para obter mais informações sobre os parâmetros de solicitação obrigatórios e opcionais, consulte os documentos da API de notificação de eventos.

Conectando-se ao Event Notifications com o Terraform

Para conectar o serviço IBM Cloud Backup for VPC ao Event Notifications, use o recurso ibm_en_source. Para obter mais informações sobre os argumentos e atributos, consulte a referência do Terraform para o 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
}

Entregando notificações para destinos selecionados

Depois de ativar as notificações no IBM Cloud Backup for VPC, crie tópicos e assinaturas no Event Notifications para que os alertas possam ser encaminhados e entregues aos destinos selecionados.

Para obter uma lista completa de destinos suportados, consulte a Documentação do Event Notifications.

Notificações por e-mail

Você pode usar o IBM Cloud serviço de e-mail como um canal de entrega para notificações de eventos IBM Cloud Backup for VPC. Crie uma assinatura do Event Notifications entre um tópico existente e o serviço de e-mail do IBM Cloud para encaminhar seus alertas para vários destinatários por e-mail.

Um e-mail do IBM Cloud que contém informações sobre um evento do IBM Cloud Backup for VPC é semelhante ao exemplo a seguir:

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 receber informações detalhadas sobre uma notificação de eventos em seu e-mail, selecione a opção Incluir carga útil de notificação ao criar uma assinatura do Event Notifications. Seu e-mail exibe os detalhes da carga útil de notificação que estão associados ao evento.

Webhooks

É possível configurar um destino de webhook para que uma notificação recebida possa ser consumida programaticamente por um app ou serviço. Para obter mais informações sobre a configuração de webhooks, confira a Documentação do Event Notifications.

Detalhes da carga útil de notificação

Os eventos bem-sucedidos gerados pelo IBM Cloud Backup for VPC contêm vários campos que ajudam a identificar a origem e os detalhes de um evento.

As notificações de eventos do IBM Cloud Backup for VPC contêm apenas propriedades de metadados, como nomes ou identificadores de recursos. Os dados sensíveis, por exemplo, chaves de API ou senhas, não são incluídos nos eventos gerados.

As propriedades enviadas para Event Notifications variam de acordo com o tipo de evento. Por exemplo, se um evento Backup job creation failed ocorrer, o IBM Cloud Backup for VPC enviará uma carga de notificação para Event Notifications semelhante ao exemplo a seguir.

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