:Integração com Nginx

Informações básicas

Visualize as métricas do Nginx no Integration Center do console do ARMS. No Integration Center, pesquise pelo componente Nginx, selecione a aba Collect Metrics e alterne para a aba Kubernetes Environment. Visualize as métricas compatíveis com o Nginx, incluindo nginx_connections_accepted, nginx_connections_active, nginx_connections_handled, nginx_connections_reading, nginx_connections_waiting, nginx_connections_writing, nginx_http_requests_total, nginx_up e nginxexporter_build_info. Os tipos de métrica incluem COUNTER e GAUGE, e todas pertencem ao grupo 'common'.

Pré-requisitos

• O service do Nginx deve estar instalado e em execução.

• Para ativar o monitoramento Stub Status no Nginx, instale o módulo ngx_http_stub_status_module.

  Como instalar o módulo ngx_http_stub_status_module

  1. Verifique se o módulo ngx_http_stub_status_module está instalado.

     nginx -V 2>&1 | grep -o with-http_stub_status_module

     • Se a saída abaixo for retornada, o módulo ngx_http_stub_status_module já está instalado.

       [root@xxx ~]# nginx -V 2>&1 | grep -o with-http_stub_status_module
       with-http_stub_status_module
       [root@xxx ~]#

     • Se nenhuma saída for retornada, instale o módulo executando os comandos a seguir:

       wget http://nginx.org/download/nginx-1.13.12.tar.gz
       tar xfz nginx-1.13.12.tar.gz
       cd nginx-1.13.12/
       ./configure --with-http_stub_status_module
       make
       make install

  2. Ative o módulo ngx_http_stub_status_module para consultar o status do Nginx.

     location /nginx_status {
       stub_status on;
       allow 127.0.0.1;  #only allow requests from localhost
       deny all;   #deny all other hosts 
      }

     Nota

     • O nome do caminho da localização deve ser nginx_status.

     • As diretivas allow 127.0.0.1 e deny all restringem o acesso apenas ao ambiente local. Para permitir o acesso do exporter do Nginx, comente essas duas linhas ou substitua 127.0.0.1 pelo endereço IP do exporter do Nginx.

  3. Reinicie o Nginx.

     nginx -t
     nginx -s reload 

  4. Opcional: Verifique se o módulo ngx_http_stub_status_module foi iniciado.

     curl http://127.0.0.1/nginx_status

     Se a saída a seguir for retornada, o módulo ngx_http_stub_status_module está em execução.

     [root@xxx ~]# curl 12xxx/nginx_status
     Active connections: 1
     server accepts handled requests
      177 177 3956
     Reading: 0 Writing: 1 Waiting: 0
     [root@xxx ~]#

• Para habilitar o monitoramento VTS no Nginx, instale o módulo nginx-module-vts.

  Como instalar o módulo nginx-module-vts

  1. Baixe o módulo nginx-module-vts.

     Nota

     https://github.com/vozlt/nginx-module-vts.git

  2. Configure as definições de compilação.

     1. Adicione o módulo nginx-module-vts durante a compilação do Nginx.

        --add-module=/path/to/nginx-module-vts

     2. Baixe o pacote oficial do Nginx e compile o módulo nginx-module-vts junto a ele.

        ./configure --user=www --group=www --prefix=/usr/local/nginx --with-http_sysguard_module  --add-module=nginx-module-vts

  3. Instale o módulo nginx-module-vts.

     make && make install

  4. Configure o Nginx. Modifique o arquivo nginx.conf e adicione o endpoint de monitoramento.

     http {
         vhost_traffic_status_zone;
             vhost_traffic_status_filter_by_host on;
         ...
         server {
             ...
             location /status {
                 vhost_traffic_status_display;
                 vhost_traffic_status_display_format html;
             }
         }
     }

     Ative a filtragem de vhost no arquivo de configuração.

     vhost_traffic_status_filter_by_host on

     Nota

     Quando o Nginx estiver configurado com múltiplas diretivas server_name, esse recurso permite que o sistema colete estatísticas de tráfego para cada nome de servidor. Caso contrário, todo o tráfego será atribuído ao primeiro server_name por padrão.

     Se não for necessário coletar estatísticas de tráfego para um bloco de servidor específico, desative o vhost_traffic_status. As reticências (...) no exemplo indicam conteúdo omitido.

     server {
     ...
     vhost_traffic_status off;
     ...
     }

  5. Verifique se o módulo nginx-module-vts está instalado.

     curl http://127.0.0.1/status

Integrar o Nginx

1. Faça login no console do ARMS. No painel de navegação à esquerda, acesse o Integration Center e clique em no cartão Nginx.

2. Configure os parâmetros de integração.

   1. Selecione o tipo de ambiente.

      • Kubernetes Environment: o alvo de monitoramento executa em um cluster ACK.

      • ECS (VPC): o alvo de monitoramento executa em uma instância ECS.

   2. Selecione um cluster ACK ou uma instância ECS.

   3. Configure a integração.

      Kubernetes environment

      Parâmetro	Descrição	Exemplo
      Integration name (optional)	Nome personalizado para a integração.	nginxtest123
      Enable Nginx for stub status monitoring	Ativa ou desativa este recurso de monitoramento. Fornece estatísticas sobre requisições e conexões do Nginx. Nota Antes de ativar esta opção, certifique-se de que o módulo ngx_http_stub_status_module esteja instalado.	N/A
      Enable Nginx for VTS monitoring	Ativa ou desativa este recurso de monitoramento. Esta opção utiliza o módulo nginx-module-vts, que geralmente exige compilação manual, para coletar dados. Fornece métricas como contagem de requisições do Nginx, volume de bytes e tempos de resposta. Nota Antes de ativar esta opção, certifique-se de que o módulo nginx-module-vts esteja instalado.	N/A
      Nginx host	Os seguintes tipos são compatíveis: Endereço de acesso interno ao cluster do service do Nginx Endereço IP interno do cluster onde o service reside Endereço IPv4 público do service	nginx-server.namespace
      Nginx port	Porta do service do Nginx.	80
      Metric collection interval (seconds)	Intervalo de coleta de métricas. O padrão é 15 segundos.	15

      ECS (VPC)

      Parâmetro	Descrição	Exemplo
      Integration name (optional)	Nome personalizado para a integração.	nginxtest321
      Enable Nginx for stub status monitoring	Ativa ou desativa este recurso de monitoramento. Fornece estatísticas sobre requisições e conexões do Nginx.	N/A
      Enable Nginx for VTS monitoring	Ativa ou desativa este recurso de monitoramento. Esta opção utiliza o módulo nginx-module-vts, que geralmente exige compilação manual, para coletar dados. Fornece métricas como contagem de requisições do Nginx, volume de bytes e tempos de resposta. Nota Antes de ativar esta opção, certifique-se de que o módulo nginx-module-vts esteja instalado.	N/A
      Nginx host	Os seguintes tipos são compatíveis: Endereço de acesso interno ao cluster do service do Nginx Endereço IP interno do cluster onde o service reside Endereço IPv4 público do service	nginx-server.namespace
      Nginx port	Porta do service do Nginx.	80
      Metric collection interval (seconds)	Intervalo de coleta de métricas. O padrão é 15 segundos.	15
      Custom Tags	Adiciona tags personalizadas de pares chave-valor às métricas coletadas pelo Prometheus, permitindo organização, consulta, monitoramento e análise mais granulares em ferramentas como o Grafana. Para mais informações, consulte Inject a custom tag into metrics for an instance in a VPC environment. Nota Chaves de tag não podem conter caracteres especiais como hífens (-), pontos (.) ou sinais de porcentagem (%), pois esses caracteres possuem significados especiais no Prometheus. As tags injetadas devem estar em um formato chave-valor válido permitido pelo Prometheus.	test1:aaa

Visualizar informações de monitoramento

Para visualizar os componentes integrados, clique em Integration Management no painel de navegação à esquerda. Clique em um cartão de integração para ver seus detalhes, incluindo alvos, métricas, painéis, alertas, configurações de descoberta de service e exporters. Na página Self-monitoring para o ambiente Kubernetes, selecione a aba Prometheus Agent. Filtre os dados utilizando as listas suspensas job, instance e agent. A página exibe os seguintes painéis de monitoramento: Agent running status (réplicas esperadas, réplicas em execução, número de alvos e total de séries coletadas); Agent discovery/scraping exceptions (quantidade de exceções na descoberta de service do job, exceções de coleta do job e exceções de coleta do alvo; as exceções são destacadas em vermelho); Agent configuration delivery exceptions (exceções de sendConfig e exceções de sendTargets; o status normal é indicado em verde); Agent collection and processing exceptions; e Agent running version. Na parte inferior, a tabela Agent status overview lista métricas para cada agent, como heartbeat, targets, series, writeArms, pod_name, memoryLimit e cpuLim.