Configurar um alerta baseado em registros para recursos armazenados

Esta página explica como configurar um alerta baseado em registros para recursos do cofre na página Análise de registros no console do Google Cloud .

A página Explorador de registros orienta você nas seguintes etapas para criar e editar alertas com base em registros:

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

É possível configurar alertas para as categorias de vagas: SCHEDULED_BACKUP, ON_DEMAND_BACKUP e RESTORE. Também é possível definir alertas para o status do job: SUCCESSFUL, FAILED, SKIPPED e RUNNING.

É possível configurar um ou mais canais de notificação, como o chat do Google, e-mail, SMS ou canais de chat do programa, para receber notificações quando um alerta ocorrer. Para instruções, consulte Criar e gerenciar canais de notificação.

Antes de começar

criar um alerta baseado em registros;

Para receber 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.

Use as instruções a seguir para criar um alerta com base em registro.

  1. No console do Google Cloud , acesse a página Análise de registros.

    Acessar o Explorador de registros

  2. No painel Query, defina o alerta para o qual você quer receber notificações.

    A consulta a seguir é um exemplo para receber notificações sempre que um job de backup programado falhar.

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

    Substitua:

    • PROJECT_ID: o nome do projeto.
  3. No cabeçalho do painel Resultados da consulta, clique em Criar alerta.

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

    1. No campo Nome da política de alertas, digite um nome para o alerta. Esse nome é exibido 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 o Markdown e variáveis em modelos de documentação.
  5. Clique em Próxima.

  6. Na seção Escolha os registros a serem incluídos no alerta, faça o seguinte:

    1. Clique em Mostrar registros para verificar a consulta e os resultados. Também é possível editar a consulta neste painel, se necessário.
    2. Clique em Adicionar um rótulo e faça o seguinte: Os rótulos permitem personalizar as notificações e torná-las mais informativas.

      1. No campo Nome de exibição,insira um nome para o rótulo.
      2. Na lista Nome do campo de registro, selecione um nome de campo de registro. Esses campos são mostrados com base no resultado da consulta selecionado.
      3. No campo Expressão regular, insira uma expressão para extrair um valor do campo que precisa conter exatamente um grupo de expressão regular.
  7. Clique em Próxima.

  8. Na seção Definir a frequência da notificação e a duração do fechamento automático, faça o seguinte:

    1. Na lista Tempo entre as notificações, 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.
    2. Na lista Duração do fechamento automático de incidentes, selecione um período após o qual o incidente será fechado automaticamente quando as entradas de registro correspondentes estiverem ausentes.
  9. Clique em Próxima.

  10. Na lista Canais de notificação, selecione um ou mais canais de notificação para seu alerta. Se você não tiver um canal de notificação configurado, clique em Gerenciar canais de notificação para criar um. Para ver instruções, consulte Criar e gerenciar canais de notificação.

  11. Clique em Salvar.

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.

Use as instruções a seguir para gravar a entrada de registro.

  1. Acesse a página de referência de logEntries.write.

    Acessar logEntries.write

  2. Configure a entrada de registro a seguir mudando a variável PROJECT_ID para o ID do 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:

    • PROJECT_ID: o nome do projeto.
  3. Copie a entrada de registro configurada anteriormente.

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

    1. No campo Corpo da solicitação, substitua o conteúdo pela entrada de registro que você copiou na etapa anterior.
    2. Clique em Executar. Se solicitado, siga o fluxo de autenticação.
  5. Se a chamada logEntries.write for bem-sucedida, você receberá um código de resposta HTTP 200 e um corpo de resposta vazio, {}. Para mais informações sobre o APIs Explorer, consulte Como usar o APIs Explorer.

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

    • O valor logName especifica os registros de jobs de backup ou restauração no seu projeto do Cloud.
    • O jsonPayload contém uma categoria de job com falha, SCHEDULED_BACKUP, que indica que o registro está relacionado a um backup programado por um plano de backup.
    • O jsonPayload contém o status do job do campo como FAILED, o que significa que o job falhou.
  6. Depois que você grava a entrada de registro, ocorre a seguinte sequência:

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

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