Esta página explica como configurar um alerta baseado em registros no Log Explorer para o serviço de backup e DR no console do Google Cloud .
A interface do Explorador 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 de encerramento automático de incidentes.
- Especifique quem você quer notificar.
Permissões e papéis
Para criar e gerenciar alertas com base em registros, seu papel de gerenciamento de identidade e acesso (IAM) precisa incluir as permissões descritas 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. É possível criar o canal de notificação antes ou durante a criação de um alerta.
Para criar um alerta com base em registro, siga estas etapas:
- No console do Google Cloud , selecione Logging e Logs Explorer.
Use o painel Consulta para definir o evento em que você quer receber notificações. Use os exemplos de consulta mostrados em exemplos de consulta no painel de consulta para configurar alertas.
Confira a seguir um exemplo de consulta para receber notificações sobre um evento com um ID específico.
logName="projects/PROJECT_ID/logs/backupdr.googleapis.com%2Fbackup_recovery_appliance_events" jsonPayload.eventId=10046
No cabeçalho do painel Resultados da consulta, clique em Criar alerta. Se a janela for muito estreita, a opção Criar alerta vai aparecer no menu Ações.
No painel Detalhes do alerta, forneça um nome e uma descrição para o alerta:
- Digite um nome para o alerta no campo Nome da política de alertas. Esse nome é exibido no cabeçalho da notificação.
- 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. Sugerimos que você inclua o URL do console de gerenciamento no campo de documentação. Também é possível adicionar a solução alternativa para resolver o evento.
Clique em Próxima.
No painel Escolher registros a serem incluídos no alerta, faça o seguinte:
- Verifique a consulta e os resultados clicando em Visualizar registros. Também é possível editar a consulta neste painel, se necessário.
É 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:
- Insira um Nome de exibição para o rótulo.
- Selecione Nome do campo de registro na lista. Esses campos são mostrados com base no resultado da consulta selecionado.
- Insira Expressão regular para extrair um valor do campo que precisa conter exatamente um grupo de expressão regular.
Clique em Próxima.
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, você pode selecionar 5 minutos nas opções para limitar as notificações a cada cinco minutos. É possível ajustar a duração do fechamento automático do incidente selecionando uma opção no menu, se aplicável.
Clique em Próxima.
Selecione um ou mais canais de notificação para o 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 mais sobre como criar canais de notificação, consulte Gerenciar canais de notificação.
Clique em Salvar.
Recomendamos que você configure 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 gravar a entrada de registro, siga estas etapas:
Acesse a página de referência
logEntries.write
ou clique no botão a seguir:Configure a entrada de registro a seguir mudando a variável PROJECT_ID para o ID do projeto. Se a política de alerta incluir ou excluir IDs de evento específicos, você também vai 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", } ]
Copie a entrada de registro configurada anteriormente.
No painel Testar esta API, siga estas etapas:
- Substitua o conteúdo do campo Corpo da solicitação no APIs Explorer pela entrada de registro que você copiou na etapa anterior.
- Clique em Executar. Se solicitado, siga o fluxo de autenticação.
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. O APIs Explorer funciona da mesma maneira com a API Logging.
A entrada de registro corresponde ao filtro especificado para o alerta das seguintes maneiras:
- O valor logName especifica a assinatura de evento do appliance de backup/recuperação para seu projeto do Cloud.
- O valor de gravidade dessa entrada de registro é ERROR.
- O jsonPayload contém um evento de pool completo 10046.
Depois que você grava a entrada de registro, ocorre a seguinte sequência:
- A nova entrada de registro aparece no "Explorador de registros e aciona o alerta.
- Um incidente é aberto no Cloud Monitoring.
- 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 no Cloud Monitoring. Para mais informações sobre incidentes, incluindo como confirmar e fechar, consulte Gerenciar incidentes para alertas com base em registros.
Criar várias políticas de alerta
Você pode criar políticas de alerta com base na prioridade e urgência dos eventos. Do ponto de vista de alertas, os eventos podem ser divididos em:
Eventos que precisam ser atendidos com urgência e, portanto, exigem notificações mais frequentes. Por exemplo, o ID de 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
Eventos menos urgentes e que, portanto, exigem notificações menos frequentes. Por exemplo, o ID de 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
Eventos que não têm impacto e podem ser ignorados. Por exemplo, os IDs de evento 10229 (erros de armazenamento excedido) e 42356 (mudanças no arquivo foram detectadas) podem ser ignorados, porque o suporte do Google declarou 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)