Configurar alertas baseados em registros

Nesta página, explicamos como configurar um alerta com base em registros para o serviço de Backup e DR usando a Análise de registros no console do Google Cloud .

A interface da Análise de registros para criar e editar alertas com base em registros orienta você nas seguintes etapas:

  • Forneça um nome e uma descrição para o alerta.
  • Escolha os registros para receber uma notificação.
  • Definir o tempo entre as notificações.
  • Defina o horário para o encerramento automático de incidentes.

  • Especifique quem você quer notificar.

    Saiba mais sobre a Análise de registros em Ver e analisar registros.

Permissões e papéis

Para criar e gerenciar alertas com base em registros na Análise de registros, seu papel do Identity and Access Management (IAM) precisa incluir o conjunto de permissões descrito em Permissões para alertas com base em registros.

criar um alerta baseado em registros;

Para notificar um alerta, você precisa ter um canal de notificação. Você pode criar o canal de notificação antes ou durante a criação de um alerta.

Para criar um alerta com base em registros, siga estas etapas:

  1. No console do Google Cloud , selecione Logging e depois Análise de registros.

  2. Use o painel Consulta para definir o evento sobre o qual você quer receber notificações. Use os exemplos de consultas mostrados em consultas de exemplo no painel de consultas para configurar alertas.

    Esta é a consulta de exemplo para receber uma notificação sobre um evento com um ID específico.

    logName="projects/PROJECT_ID/logs/backupdr.googleapis.com%2Fbackup_recovery_appliance_events"
jsonPayload.eventId=10046

  3. No cabeçalho do painel Resultados da consulta, clique em Criar alerta. Se a janela estiver muito estreita, a opção Criar alerta vai aparecer no menu Ações.

  4. No painel Detalhes do alerta, forneça um nome e uma descrição para o alerta:

    1. Digite um nome para o alerta no campo Nome da política de alertas. Esse nome aparece no cabeçalho da notificação.
    2. No campo Documentação, insira a descrição do alerta. Para informações sobre como formatar e refinar o conteúdo desse campo, consulte Como usar Markdown e variáveis em modelos de documentação. Inclua o URL do console de gerenciamento no campo de documentação. Você também pode adicionar a solução alternativa para resolver o evento.

  5. Clique em Próxima.

  6. No painel Escolher registros a serem incluídos no alerta, faça o seguinte:

    1. Clique em Visualizar registros para verificar a consulta e os resultados. É possível editar a consulta neste painel, se necessário.

    2. É possível adicionar rótulos para personalizar as notificações e torná-las mais informativas. Clique em Adicionar um rótulo e faça o seguinte:

      1. Insira um Nome de exibição para o rótulo.
      2. Selecione Nome do campo de registro na lista. Esses campos são mostrados com base no resultado da consulta selecionado.
      3. Insira Expressão regular para extrair um valor do campo que precisa conter exatamente um grupo de expressão regular.

  7. Clique em Próxima.

  8. Selecione o tempo mínimo entre as notificações. Esse valor permite controlar o número de notificações recebidas desse alerta, se ele for acionado várias vezes. Por exemplo, selecione 5 min nas opções para limitar as notificações a cada cinco minutos. É possível ajustar a duração do fechamento automático de incidentes selecionando uma opção no menu, se aplicável.

  9. Clique em Próxima.

  10. Selecione um ou mais canais de notificação para seu alerta, por exemplo, um canal de notificação por e-mail. Se você já tiver um canal de notificação por e-mail configurado, selecione-o na lista. Caso contrário, clique em Gerenciar canais de notificação e adicione um canal de e-mail. Para saber como criar canais de notificação, consulte Criar e gerenciar canais de notificação.

  11. Clique em Salvar.

    É uma boa prática configurar alertas para IDs de eventos importantes.

Testar o alerta com base em registros

Para testar o alerta com base em registro que você criou, grave manualmente uma entrada de registro que corresponda à consulta. Para escrever a entrada de registro, siga estas etapas:

  1. Acesse a página de referência logEntries.write ou clique no botão a seguir:

    Acessar logEntries.write

  2. Configure a entrada de registro a seguir mudando a variável PROJECT_ID para o ID do projeto. Se a política de alertas incluir ou excluir IDs de eventos específicos, você também precisará modificar o ID do evento:

      "entries": [
  {
    "jsonPayload": {
      "eventId": 10046,
      "errorMessage": "this is a manually generated error message created for testing"
    },
    "resource": {
      "type": "backupdr.googleapis.com/BackupRecoveryAppliance",
    },
    "severity": "ERROR",
    "logName": "projects/PROJECT_ID/logs/backupdr.googleapis.com%2Fbackup_recovery_appliance_events",
  }
  ]

  3. Copie a entrada de registro configurada anteriormente.

  4. No painel Testar esta API, siga estas etapas:

    1. Substitua o conteúdo do campo Corpo da solicitação no APIs Explorer pela entrada de registro que você copiou na etapa anterior.
    2. Clique em Executar. Se solicitado, siga o fluxo de autenticação.

    Se a chamada logEntries.write for bem-sucedida, você vai receber um código de resposta HTTP 200 e um corpo de resposta vazio, {}. Para mais informações sobre o APIs Explorer, consulte Usar o APIs Explorer. O APIs Explorer funciona da mesma maneira com a API Cloud Logging.

    A entrada de registro corresponde ao filtro especificado para o alerta das seguintes maneiras:

    • O valor "logName" especifica o evento de login do appliance de backup/recuperação para seu projeto na nuvem.
    • O valor de gravidade dessa entrada de registro é ERROR.
    • O jsonPayload contém um evento de pool cheio 10046.

    Depois que você grava a entrada de registro, ocorre a seguinte sequência:

    1. A nova entrada de registro aparece na Análise de registros e aciona o alerta.
    2. Um incidente é aberto no Cloud Monitoring.
    3. Você recebe uma notificação sobre o incidente. Se você tiver configurado um canal de notificação de e-mail, a notificação vai aparecer.

Clique em Ver incidente no e-mail para conferir o incidente no Cloud Monitoring. Para mais informações sobre incidentes, incluindo como confirmá-los e encerrá-los, consulte Gerenciar incidentes para alertas com base em registros.

Criar várias políticas de alertas

É possível criar políticas de alertas com base na prioridade e urgência dos eventos. Do ponto de vista dos alertas, os eventos podem ser categorizados da seguinte forma:

  1. Eventos que precisam de atenção urgente e, portanto, exigem notificações mais frequentes. Por exemplo, o ID do evento 43901 (job de snapshot com falha) precisa ser informado a cada 30 minutos. Use a consulta a seguir para criar o alerta.

        Policyname = 'Snapshot job has failed'
    Notification rate limit = 30 min
    logName="projects/PROJECT_ID/logs/backupdr.googleapis.com%2Fbackup_recovery_appliance_events" AND jsonPayload.eventId=43901

  2. Eventos menos urgentes e que exigem notificações menos frequentes. Por exemplo, o ID do evento 10085 (violações do plano de backup) precisa ser informado apenas uma vez por dia. Use a consulta a seguir para criar o alerta.

        Policyname = 'Backup Plan Violation has occurred'
    Notification rate limit = 1 day
    logName="projects/PROJECT_ID/logs/backupdr.googleapis.com%2Fbackup_recovery_appliance_events" AND jsonPayload.eventId=10085

  3. Eventos que não causam impacto e podem ser ignorados. Por exemplo, os IDs de evento 10229 (erros de armazenamento excedido) e 42356 (foram detectadas mudanças no arquivo) podem ser ignorados, já que são falsos positivos. Use a consulta a seguir para criar o alerta.

        Policyname = 'Backup/DR event has occurred'
    Notification rate limit = 6 hr
    logName="projects/PROJECT_ID/logs/backupdr.googleapis.com%2Fbackup_recovery_appliance_events" AND NOT jsonPayload.eventId=(10085 OR 10229 OR 42356 OR 43901)