Configurar um alerta baseado em consultas usando o MQL

Configurar um alerta baseado em consultas usando o MQL

Neste documento, mostramos como usar a linguagem de consulta do Monitoring (MQL, na sigla em inglês) para explorar métricas, criar gráficos e configurar um alerta baseado em consulta no console do Google Cloud. Se você preferir usar a API Cloud Monitoring, consulte Como criar condições para políticas de alertas.

Neste documento, você vai fazer o seguinte:

1. Criar uma instância do Compute Engine.

2. Navegue até o editor de código.

3. Execute uma consulta e crie um gráfico.

4. Configure um alerta baseado em consultas.

Antes de começar

Para usar o MQL, você precisa criar um projeto do Google Cloud e ativar o faturamento.

1. Faça login na sua conta do Google Cloud. Se você começou a usar o Google Cloud agora, crie uma conta para avaliar o desempenho de nossos produtos em situações reais. Clientes novos também recebem US$ 300 em créditos para executar, testar e implantar cargas de trabalho.

2. No console do Google Cloud, na página do seletor de projetos, selecione ou crie um projeto do Google Cloud.

   Observação: se você não pretende manter os recursos criados neste procedimento, crie um projeto novo em vez de selecionar um que já existe. Depois de concluir essas etapas, é possível excluir o projeto. Para fazer isso, basta remover todos os recursos associados a ele.

   Acessar o seletor de projetos

3. Verifique se a cobrança está ativada para o seu projeto do Google Cloud.

4. No console do Google Cloud, na página do seletor de projetos, selecione ou crie um projeto do Google Cloud.

   Observação: se você não pretende manter os recursos criados neste procedimento, crie um projeto novo em vez de selecionar um que já existe. Depois de concluir essas etapas, é possível excluir o projeto. Para fazer isso, basta remover todos os recursos associados a ele.

   Acessar o seletor de projetos

5. Verifique se a cobrança está ativada para o seu projeto do Google Cloud.

Em seguida, configure as permissões e os canais de notificação.

1. Se quiser ter as permissões necessárias para criar políticas de alertas com uma condição baseada em MQL, peça ao administrador para conceder a você o papel do IAM de Editor do Monitoring (roles/monitoring.editor) no projeto. Para mais informações sobre como conceder papéis, consulte Gerenciar acesso.

   Também é possível conseguir as permissões necessárias por meio de papéis personalizados ou de outros papéis predefinidos.

   Para mais informações sobre os papéis do Cloud Monitoring, consulte Controlar o acesso com o Identity and Access Management.

2. Verifique se você conhece os conceitos gerais de políticas de alertas, MQL e o editor de código. Para mais informações, consulte os tópicos a seguir:

   • Visão geral de alertas
   • Políticas de alertas com MQL
   • Usar o editor de código para MQL

Criar uma instância do Compute Engine

Para ter um recurso do Google Cloud do qual coletar métricas, crie uma instância do Compute Engine concluindo as seguintes etapas:

1. No menu do console do Google Cloud, selecione Compute Engine.

   

2. Selecione Criar instância e clique em Criar.

Observação: se tiver problemas para criar uma instância, consulte o Guia de início rápido sobre como usar uma VM do Linux.

Navegar até o editor de código

Para começar a usar MQL, faça o seguinte:

1. No painel de navegação do console do Google Cloud, selecione Monitoramento e  Metrics Explorer:

   Acesse o Metrics explorer

2. Na barra de ferramentas do painel do criador de consultas, selecione o botão  MQL ou  PromQL.
3. Verifique se MQL está selecionado na opção de ativar/desativar Idioma. A alternância de idiomas está na mesma barra de ferramentas que permite formatar sua consulta.

Use o editor de código para criar, testar e executar consultas MQL.

Executar uma consulta e criar um gráfico

Crie uma consulta que gere um gráfico da utilização da CPU da sua instância:

1. Cole a consulta abaixo no editor de código:

   fetch gce_instance::compute.googleapis.com/instance/cpu/utilization
   | {
       top 1, max(val())
     ;
       bottom 1, min(val())
     }
   | union
   

   Esta consulta seleciona a série temporal com a utilização máxima e mínima da CPU para gráficos. Para mais informações sobre essa consulta, consulte Como combinar seleções com union.

2. Selecione Executar consulta. O gráfico exibe duas linhas mostrando a utilização máxima e mínima da CPU da instância:

   

3. Para salvar o gráfico, clique em Salvar gráfico. Dê um nome ao gráfico e adicione-o a um painel existente ou novo. Clique em Salvar.

O gráfico pode ser acessado na página Visão geral do Monitoring ou, se você o salvou em um painel, na página desse painel.

Configurar um alerta baseado em consulta

É possível criar uma política de alertas que monitore os resultados de uma consulta. Para criar essa política de alertas, conclua as etapas a seguir:

1. No painel de navegação do console do Google Cloud, selecione Monitoramento e  Alertas:

   Acessar Alertas

2. Na página Alertas, clique em Editar Canais de Notificação. Nesta etapa, você configura um endereço de e-mail para receber notificações com alertas.

   1. Na página Canais de notificação, acesse E-mail e clique em Adicionar novo.

   2. Digite o endereço de e-mail para o qual você quer que as notificações de alerta sejam enviadas no campo Endereço de e-mail.

   3. Digite uma breve descrição desse canal, como "Alerta em serviço", no campo Nome de exibição.

   4. Clique em Save.

   5. Volte à página Alerta clicando em Voltar no cabeçalho da página.

3. Na página Alertas, clique em Criar política.

   Esta página mostra as etapas para criar uma política de alertas:

   1. Descrevendo o que você quer alertar.
   2. Fornece informações sobre como resolver esse problema.
   3. Especificando um canal de notificação para o alerta.

4. Para descrever o que você quer alertar, clique em Nova condição. Essa ação abre o editor de condições baseado em formulário.

   1. Em Modo de configuração da política, selecione Editor de código (MQL ou PromQL).

   2. Verifique se MQL está selecionado na opção de ativar/desativar Idioma. A alternância de idiomas está na mesma barra de ferramentas que permite formatar sua consulta.

   3. Insira a consulta que seleciona os dados que você quer monitorar no editor de código. A consulta a seguir aciona um alerta quando o tempo de uso da CPU da instância permanece maior que 20 segundos:

      fetch gce_instance::compute.googleapis.com/instance/cpu/usage_time
      | window 1m
      | condition val() > 20 's'
      

      A operação condition estabelece o limite de desempenho que você quer alertar. Para mais informações sobre condition e outras operações de alerta, consulte Alertas na referência do MQL.

      Se a Execução automática estiver ativada, o gráfico MQL mostrará os dados selecionados e uma linha de limite:

      

   4. Para configurar o gatilho de alerta, clique em Próxima:

      1. No menu Gatilho de alerta, selecione o número de série temporal que precisam atender à operação de alerta para que a política de alertas possa ser acionada. Você pode selecionar entre os seguintes critérios:

         • Uma única série temporal.
         • Um número específico de séries temporais.
         • Uma porcentagem da série temporal.
         • Todas as séries temporais.

      2. Opcional: expanda o menu Opções avançadas e, no campo Acionar quando a condição for atendida por este período de tempo, insira ou selecione um valor.

         Esse campo define por quanto tempo a condição precisa ser satisfeita antes que a política de alertas seja acionada. A janela Retest não é igual à janela de alinhamento usada na consulta MQL. Para mais informações sobre o relacionamento entre esses valores, consulte O período de alinhamento e a duração.

      3. Insira um nome para a condição, como "Condição MQL básica".

5. Para configurar notificações, a documentação e o nome da política de alertas, clique em Próxima.

   1. Selecione o canal de notificação criado anteriormente.

   2. Escolha um nível de gravidade.

   3. Insira algum texto a ser enviado com qualquer notificação de alerta no campo Documentação. Esse texto geralmente fornece aos responsáveis informações para ajudá-los a resolver o problema. Para este exercício, insira "O uso da CPU excedeu 20 segundos".

   4. Insira um nome para a política de alertas no campo Nome da política de alertas. Esse valor permite distinguir entre notificações de diferentes políticas de alertas.

6. Para salvar a política, clique em Criar política.

Limpar

Para evitar cobranças na sua conta do Google Cloud pelos recursos usados nesta página, siga estas etapas.

1. Acesse a página "Identity and Access Management" no console do Google Cloud:

   Acessar as configurações do projeto

2. Clique em Encerrar e siga as instruções.

A seguir

• Saiba mais sobre como usar o editor de código.
• Explore um conjunto de exemplos de MQL.
• Saiba mais sobre as políticas de alertas baseadas em MQL.
• Saiba como invocar consultas MQL pela API Cloud Monitoring.
• Explore os detalhes do MQL na referência do MQL.
• Leia nossos recursos sobre o DevOps e conheça o programa de pesquisa DORA.