Coletar registros do Apache com o Agente de operações

Coletar registros do Apache com o Agente de operações

Saiba como coletar e visualizar registros syslog coletados de um servidor da Web Apache instalado em uma instância de máquina virtual (VM) do Compute Engine usando o Agente de operações. É possível usar um processo semelhante ao deste guia de início rápido para monitorar outros aplicativos de terceiros.

Neste guia de início rápido, você fará as ações a seguir:

1. Criar uma instância de VM do Compute Engine e instalar o Agente de operações.
2. instalar um servidor da Web Apache;
3. Configurar o Agente de operações para o servidor da Web Apache
4. Ver registros no Explorador de registros
5. Criar um alerta baseado em registros
6. Testar o alerta.
7. Fazer a limpeza.

---

Para seguir as instruções passo a passo desta tarefa diretamente no console do Google Cloud, clique em Orientação:

Orientações

---

Antes de começar

1. As restrições de segurança definidas pela sua organização podem impedir que você conclua as etapas a seguir. Para informações sobre solução de problemas, consulte Desenvolver aplicativos em um ambiente restrito do Google Cloud.

2. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

3. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

4. Make sure that billing is enabled for your Google Cloud project.

5. Enable the Compute Engine, Cloud Monitoring, and Cloud Logging APIs.

   Enable the APIs

6. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

7. Make sure that billing is enabled for your Google Cloud project.

8. Enable the Compute Engine, Cloud Monitoring, and Cloud Logging APIs.

   Enable the APIs

Crie uma instância de VM

1. No Console do Google Cloud, acesse a página Instâncias de VM.

   Acessar Instâncias de VM

   Se você usar a barra de pesquisa para encontrar a página, selecione o resultado com o subtítulo Compute Engine.

2. Crie uma instância de VM clicando em Criar instância.

3. No campo Nome, insira um nome descritivo.
4. No campo Tipo de máquina, selecione e2-small.
5. Na seção Disco de inicialização, mantenha a configuração padrão de Debian GNU/Linux.
6. Na seção Firewall,selecione Permitir tráfego HTTP e Permitir tráfego HTTPS.
7. Na seção Observabilidade: Agente de operações, selecione Instalar o Agente de operações para monitoramento e geração de registros.
8. Clique em Criar.

Instalar um servidor da Web Apache

Para instalar um servidor da Web Apache na instância de VM do Compute Engine, faça o seguinte:

1. Na página Instâncias de VM, localize a nova VM, acesse a coluna Conectar e clique em SSH.

   Problemas com a conexão? Consulte Solução de problemas de SSH.

2. Para atualizar as listas de pacotes, copie o comando a seguir na área de transferência, cole-o no terminal SSH e pressione Enter:

   sudo apt-get update
   

3. Depois que aparecer a mensagem "Lendo listas de pacotes... Pronto", no terminal SSH, execute o seguinte comando para instalar um servidor da Web Apache2:

   sudo apt-get install apache2 php7.0
   

   Se você for solicitado a continuar a instalação, insira Y. Se o comando da instalação falhar, use sudo apt-get install apache2 php.

4. Quando o prompt de comando retornar, acesse a página Instâncias de VM e copie o endereço IP externo da VM no seguinte URL:

   http://EXTERNAL_IP
   

5. Para se conectar ao servidor da Web Apache, abra uma nova guia do navegador e insira o URL da etapa anterior.

   Quando o servidor da Web for instalado, a guia do navegador exibirá a página padrão do Apache2 Debian.

   

Coletar registros e métricas do servidor da Web Apache

Nestas etapas, você configura o Agente de operações para coletar registros e métricas do servidor da Web Apache:

1. Acesse o terminal SSH da sua instância de VM. Se você não tiver um terminal aberto, faça o seguinte:

   1. No Console do Google Cloud, acesse a página Instâncias de VM.

      Acessar Instâncias de VM

      Se você usar a barra de pesquisa para encontrar a página, selecione o resultado com o subtítulo Compute Engine.

   2. Localize a nova VM e clique em SSH.

2. Copie o comando a seguir, cole-o no terminal da instância e pressione Enter:

   # Configures Ops Agent to collect telemetry from the app and restart Ops Agent.
   
   set -e
   
   # Create a back up of the existing file so existing configurations are not lost.
   sudo cp /etc/google-cloud-ops-agent/config.yaml /etc/google-cloud-ops-agent/config.yaml.bak
   
   # Configure the Ops Agent.
   sudo tee /etc/google-cloud-ops-agent/config.yaml > /dev/null << EOF
   metrics:
     receivers:
       apache:
         type: apache
     service:
       pipelines:
         apache:
           receivers:
             - apache
   logging:
     receivers:
       apache_access:
         type: apache_access
       apache_error:
         type: apache_error
     service:
       pipelines:
         apache:
           receivers:
             - apache_access
             - apache_error
   EOF
   
   sudo service google-cloud-ops-agent restart
   sleep 60
   

   O comando acima cria a configuração para coletar e ingerir logs e métricas a partir do servidor da Web Apache. Para mais informações, acesse Configurar o Agente de operações para o servidor da Web Apache.

3. Aguarde até que o prompt de comando seja exibido, o que leva pelo menos 60 segundos.

Acessar os registros do servidor da Web Apache

Para conferir seus registros no console do Google Cloud, use o Explorador de registros:

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

   Acessar a Análise de registros

   Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo Geração de registros.

   Os registros mais recentes são exibidos no painel Resultados da consulta.

2. Na barra de ferramentas, verifique se a opção Mostrar consulta está ativada.

3. Para acessar os registros do servidor da Web Apache, crie e execute uma consulta:

   1. Expanda a lista de projetos do Google Cloud no seletor de projetos do Google Cloud e copie o ID do projeto do Google Cloud para a área de transferência.

   2. Na expressão a seguir, cole o ID copiado no campo PROJECT_ID e copie a expressão no editor de consultas:

      resource.type="gce_instance"
      logName=("projects/PROJECT_ID/logs/apache_access" OR "projects/PROJECT_ID/logs/apache_error")
      

      Quando a consulta anterior é executada, apenas as entradas de registro apache_access e apache_error são mostradas.

   3. Clique em Executar consulta.

      Os resultados da consulta são exibidos no painel Resultados da consulta.

Você configurou o Agente de operações para coletar registros e métricas do servidor da Web Apache e visualizou esses registros. A próxima etapa é criar uma política de alertas para que você seja notificado quando um padrão específico aparecer em um registro.

Criar um canal de notificação por e-mail

Antes de criar uma política de alertas, configure os canais de notificação que você quer que ela use. O Cloud Monitoring oferece suporte a muitos tipos diferentes de canais de notificação, incluindo e-mail, Slack, PagerDuty e Pub/Sub. Para saber mais, consulte Criar e gerenciar canais de notificação. Para receber notificações por e-mail, faça o seguinte:

1. No console do Google Cloud, acesse a página  Alertas:

   Acessar Alertas

   Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo Monitoring.

2. Na barra de ferramentas, clique em Editar canais de notificação.
3. Na página Canais de notificação, role até E-mail e clique em Adicionar novo.
4. Insira seu endereço de e-mail, um nome de exibição, como My email, e clique em Salvar.

criar um alerta baseado em registros;

Para receber notificações quando uma mensagem específica aparecer nas entradas de registro, crie um alerta baseado em registro. Nesta seção, você vai criar um alerta baseado em registros para receber notificações quando uma mensagem 404 Not Found aparecer nas entradas de registro.

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

   Acessar a Análise de registros

   Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo Geração de registros.

2. Na barra de ferramentas Resultados da consulta, clique em Criar alerta. O painel da política de alertas com base em registros é aberto.

3. Em Detalhes do alerta, no campo Nome da política de alertas, insira 404 Not Found.

4. Em Escolha os registros a serem incluídos neste alerta, faça o seguinte:

   1. Remova todo o conteúdo que estiver na caixa de texto do filtro de registro.

   2. Copie a consulta a seguir e cole na caixa de texto do filtro de registro:

      severity>=DEFAULT /help httpRequest.status=404
      

      O filtro de registro anterior procura entradas de registro com um nível de severity de pelo menos DEFAULT, que contenham o texto /help e que contenham um status httpRequest de 404.

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

   1. Defina o campo Tempo entre as notificações como 5 min.
   2. Defina o campo Duração do fechamento automático de incidentes como 30 min.

6. Em Quem precisa receber uma notificação?, selecione seu e-mail no menu Canais de notificação e clique em Salvar.

Teste a política de alertas

Para testar a política de alertas, faça o seguinte:

1. Acesse o terminal SSH da sua instância de VM. Se nenhum terminal estiver aberto, faça o seguinte:

   1. No Console do Google Cloud, acesse a página Instâncias de VM.

      Acessar Instâncias de VM

      Se você usar a barra de pesquisa para encontrar a página, selecione o resultado com o subtítulo Compute Engine.

   2. Localize a nova VM e clique em SSH.

2. Para pesquisar a página falsa localhost/help no servidor, execute este comando:

   curl localhost/help
   

   Quando você vê uma mensagem 404 Not Found no terminal, uma notificação por e-mail é enviada. É preciso esperar alguns minutos até que esse processo seja concluído.

   Você vai receber uma notificação por e-mail semelhante a esta:

   

3. Para visualizar as novas entradas de registro, faça o seguinte:

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

      Acessar a Análise de registros

      Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo Geração de registros.

   2. Na barra de ferramentas, clique em Ir para momento atual.

Você configurou o Agente de operações para coletar registros e métricas do servidor da Web Apache, mas só visualizou os registros. Para saber como conferir as métricas do servidor da Web Apache, consulte Coletar métricas do servidor da Web Apache com o Agente de operações: gerar tráfego.

Limpar

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

Se você criou um projeto e não precisa mais dele, exclua o projeto.

Se você usou um projeto atual, faça o seguinte:

1. Se você criou uma VM, exclua-a:

   1. In the Google Cloud console, go to the VM instances page.

      Go to VM instances

   2. Select the checkbox for the instance that you want to delete.
   3. To delete the instance, click More actions, click Delete, and then follow the instructions.

2. Exclua a política de alertas que você criou:

   1. No console do Google Cloud, acesse a página  Alertas:

      Acessar Alertas

      Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo Monitoring.

   2. Selecione a política de alertas que você criou e clique em Excluir.

A seguir

• Para saber mais sobre o Agente de operações e as integrações compatíveis, consulte:

  • Visão geral do agente de operações.
  • Monitorar aplicativos de terceiros

• Para saber como visualizar registros no Explorador de registros, consulte Conferir registros usando o Explorador de registros.

• Para informações sobre como consultar no Explorador de registros, consulte Criar consultas no Explorador de registros.

• Para saber como coletar e visualizar métricas do servidor da Web Apache, consulte o guia de início rápido Coletar métricas do servidor da Web Apache com o Agente de operações.

• Para mais informações sobre o Monitoring e a relação dele com o Cloud Logging, consulte Monitoring.