Configure um alerta baseado em registos para recursos protegidos

Esta página explica como configurar um alerta baseado em registos para recursos protegidos na página Explorador de registos na Google Cloud consola.

A página Explorador de registos explica os seguintes passos para criar e editar alertas baseados em registos:

  • Indique um nome e uma descrição para o alerta.
  • Escolha os registos para os quais quer receber uma notificação.
  • Defina o intervalo de tempo entre notificações.
  • Defina o tempo para o encerramento automático de incidentes.
  • Especifique quem quer notificar.

Pode configurar alertas para as categorias de empregos: SCHEDULED_BACKUP, ON_DEMAND_BACKUP e RESTORE. Também pode definir alertas para o estado da tarefa: SUCCESSFUL, FAILED, SKIPPED e RUNNING.

Pode configurar um ou mais canais de notificação, como o Google Chat, o email, os SMS ou os canais de programas de chat, para receber notificações quando ocorre um alerta. Para ver instruções, consulte o artigo Crie e faça a gestão de canais de notificação.

Antes de começar

Crie um alerta baseado em registos

Para receber uma notificação de alerta, tem de ter um canal de notificação. Pode criar o canal de notificação antes de criar um alerta ou durante a criação de um alerta.

Use as instruções seguintes para criar um alerta baseado em registos.

  1. Na Google Cloud consola, aceda à página Explorador de registos.

    Aceda ao Explorador de registos

  2. No painel Consulta, defina o alerta sobre o qual quer receber uma notificação.

    A seguinte consulta é um exemplo para receber uma notificação sempre que uma tarefa de cópia de segurança agendada falha.

      logName="projects/PROJECT_ID/logs/backupdr.googleapis.com%2Fbdr_backup_restore_jobs"
  jsonPayload.jobCategory="SCHEDULED_BACKUP"
  jsonPayload.jobStatus="FAILED"

    Substitua o seguinte:

    • PROJECT_ID: o nome do projeto.

  3. No cabeçalho do painel Resultados da consulta, clique em Criar alerta.

  4. Na secção Detalhes do alerta, faça o seguinte:

    1. No campo Nome da política de alertas, introduza um nome para o alerta. Este nome é apresentado no cabeçalho da notificação.
    2. No campo Documentação, introduza a descrição do alerta. Para informações sobre como pode formatar e refinar o conteúdo deste campo, consulte o artigo Usar Markdown e variáveis em modelos de documentação.

  5. Clicar em Seguinte.

  6. Na secção Escolha os registos a incluir no alerta, faça o seguinte:

    1. Clique em Pré-visualizar registos para verificar a consulta e os resultados. Também pode editar a consulta neste painel, se necessário.

    2. Clique em Adicionar uma etiqueta e faça o seguinte. As etiquetas permitem-lhe personalizar as notificações e torná-las mais informativas.

      1. No campo Nome a apresentar, introduza um nome para a etiqueta.
      2. Na lista Nome do campo de registo, selecione um nome do campo de registo. Estes campos são apresentados com base no resultado da consulta selecionado.
      3. No campo Expressão regular, introduza uma expressão para extrair um valor do campo que tem de conter exatamente um grupo de expressões regulares.

  7. Clicar em Seguinte.

  8. Na secção Defina a frequência das notificações e a duração do fecho automático, faça o seguinte:

    1. Na lista Tempo entre notificações, selecione o tempo mínimo entre notificações. Este valor permite-lhe controlar o número de notificações que recebe deste alerta se for acionado várias vezes.
    2. Na lista Duração do encerramento automático de incidentes, selecione uma duração após a qual o incidente é encerrado automaticamente quando não existirem entradas de registo correspondentes.

  9. Clicar em Seguinte.

  10. Na lista Canais de notificação, selecione um ou mais canais de notificação para o seu alerta. Se não tiver um canal de notificação configurado, clique em Gerir canais de notificação para criar um. Para ver instruções, consulte o artigo Crie e faça a gestão de canais de notificação.

  11. Clique em Guardar.

Teste o alerta baseado em registos

Para testar o alerta baseado em registos que criou, pode escrever manualmente uma entrada de registo que corresponda à consulta.

Siga as instruções abaixo para escrever a entrada do registo.

  1. Aceda à página de referência logEntries.write.

    Aceda a logEntries.write

  2. Configure a seguinte entrada do registo alterando a variável PROJECT_ID para o ID do seu projeto.

          {
        "entries": [
          {
            "jsonPayload": {
              "jobCategory": "SCHEDULED_BACKUP",
              "jobStatus": "FAILED"
            }
          }
        ],
        "resource": {
          "type": "backupdr.googleapis.com/BackupDRProject"
        },
        "logName": "projects/PROJECT_ID/logs/backupdr.googleapis.com%2Fbdr_backup_restore_jobs"
      }

    Substitua o seguinte:

    • PROJECT_ID: o nome do projeto.

  3. Copie a entrada de registo que configurou anteriormente.

  4. No painel Experimentar esta API, siga estes passos:

    1. No campo Corpo do pedido, substitua o conteúdo pela entrada do registo que copiou no passo anterior.
    2. Clique em Executar. Se lhe for pedido, siga o fluxo de autenticação.

  5. Se a chamada logEntries.write for bem-sucedida, recebe um código de resposta HTTP 200 e um corpo da resposta vazio, {}. Para mais informações sobre o Explorador de APIs, consulte o artigo Usar o Explorador de APIs.

    A entrada do registo corresponde ao filtro especificado para o alerta das seguintes formas:

    • O valor logName especifica os registos da tarefa de cópia de segurança ou restauro no seu projeto na nuvem.
    • O jsonPayload contém uma categoria de tarefas com falhas, SCHEDULED_BACKUP, que indica que o registo está relacionado com uma cópia de segurança agendada por um plano de cópia de segurança.
    • O jsonPayload contém o campo de estado do trabalho como FAILED, o que significa que o trabalho falhou.

  6. Depois de escrever a entrada do registo, ocorre a seguinte sequência:

    1. A nova entrada do registo aparece no Explorador de registos e aciona o alerta.
    2. É aberto um incidente na página Cloud Monitoring.

    3. Recebe uma notificação sobre o incidente. Se configurou um canal de notificação por email, a notificação é apresentada.

      Pode clicar em Ver incidente no email para ver o incidente na página do Cloud Monitoring. Para mais informações sobre incidentes, incluindo como os confirmar e encerrar, consulte o artigo Faça a gestão de incidentes para alertas baseados em registos.