Monitore o NGINX Plus auto-hospedado com OpenTelemetry

Monitore seus servidores NGINX Plus em execução em um host usando o OpenTelemetry Collector para enviar métricas e dados de telemetria para o New Relic.

Esta integração utiliza o prometheusreceiver do OpenTelemetry e o nginx-prometheus-exporter para monitorar as métricas de desempenho, estatísticas de conexão e integridade do servidor do NGINX Plus. A rica API HTTP no NGINX Plus fornece métricas significativamente mais detalhadas em comparação com o módulo de status stub básico no NGINX padrão.

Antes de você começar

Antes de começar, certifique-se de ter:

• Uma conta New Relic com umachave de licença

• Versão NGINX Plus R13 ou superior

• NGINX Plus com o módulo HTTP API habilitado

• Exportador NGINX Prometheus instalado e em execução junto com sua instância NGINX Plus para expor métricas da API HTTP no formato Prometheus

• OpenTelemetry Collector Contrib instalado e em execução em um host Linux

• Acesso à rede do host Linux para:

  • Endpoint da API HTTP do NGINX Plus
  • Qualquer um dos endpoints New Relic OTLP

Verifique sua configuração

Verifique a versão do NGINX Plus:

$
nginx -V 2>&1 | grep -o "nginx/[0-9.]*"

Saída esperada: nginx/1.25.0 ou superior (R13+)

Verifique o OpenTelemetry Collector:

$
otelcol-contrib --version

Saída esperada: Informações da versão (mínimo v0.88.0 requerido)

Teste a conectividade de rede:

$
# For US region
$
curl -I https://otlp.nr-data.net:4318/v1/metrics
$
# For EU region
$
curl -I https://otlp.eu01.nr-data.net:4318/v1/metrics

Saída esperada: HTTP/2 405 (método não permitido é esperado)

Etapa 1: Configurar o NGINX Plus

Configure e habilite o módulo HTTP API para expor métricas do seu servidor NGINX Plus.

server {
    listen 8080;
    server_name localhost;

    location /api {
        api write=on;
        # Restrict access as needed
        allow 127.0.0.1;
        deny all;
    }
}

$
sudo nginx -t && sudo nginx -s reload

$
curl -I http://127.0.0.1:8080/api/9 2>/dev/null | head -n 1 | cut -d$' ' -f1,2

HTTP/1.1 200

Etapa 2: Configurar o OpenTelemetry Collector

Configure o OpenTelemetry Collector para coletar métricas do seu exportador Prometheus do NGINX Plus e enviá-las para o New Relic.

$
# Download and install the exporter
$
wget https://github.com/nginx/nginx-prometheus-exporter/releases/latest/download/nginx-prometheus-exporter_linux_amd64.tar.gz
$
tar -xzf nginx-prometheus-exporter_linux_amd64.tar.gz
$
sudo mv nginx-prometheus-exporter /usr/local/bin/
$

$
# Run the exporter (customize the -nginx.scrape-uri as needed)
$
nginx-prometheus-exporter -nginx.scrape-uri=http://127.0.0.1:8080/api

Etapa 3: Defina as variáveis de ambiente para o coletor

Injete seu endpoint New Relic chave de licençae OTLP no serviço do coletor para que o exportador possa autenticar.

$
sudo mkdir -p /etc/systemd/system/otelcol-contrib.service.d

$
cat <<EOF | sudo tee /etc/systemd/system/otelcol-contrib.service.d/environment.conf
$
[Service]
$
Environment="NEWRELIC_OTLP_ENDPOINT=YOUR_OTLP_ENDPOINT"
$
Environment="NEWRELIC_LICENSE_KEY=YOUR_LICENSE_KEY"
$
EOF

$
sudo systemctl daemon-reload
$
sudo systemctl restart otelcol-contrib.service

Etapa 4: Verifique a coleta de dados

Confirme se o OpenTelemetry Collector está coletando com sucesso as métricas do NGINX Plus e enviando-as para o New Relic.

$
sudo journalctl -u otelcol-contrib.service -n 20

$
# Make a few requests to your NGINX Plus server
$
curl http://localhost

Etapa 5: (Opcional) Encaminhar logs do NGINX

Estenda a configuração do seu coletor para incluir logs de acesso e erros se você quiser eventos de log junto com as métricas.

Configurar o formato de log do NGINX Plus

Antes de encaminhar os logs, configure o NGINX Plus para usar um formato de log estruturado. Consulte a documentação de logging do NGINX para obter orientação sobre como configurar logs de acesso e erro.

Configure o OpenTelemetry Collector para encaminhamento de logs

1. Observe os caminhos completos para seus arquivos de log de acesso e erro do NGINX. Os padrões são geralmente /var/log/nginx/access.log e /var/log/nginx/error.log.

2. Atualize /etc/otelcol-contrib/config.yaml para adicionar um receptor filelog e pipeline de log:

   receivers:
     prometheus:
       # existing Prometheus receiver configuration
     filelog/nginx_access_logs:
       include:
         - /var/log/nginx/access.log
     filelog/nginx_error_logs:
       include:
         - /var/log/nginx/error.log
   
   processors:
     batch:
       # existing settings
     filter/nginx_metrics:
       # existing settings
     resourcedetection:
       # existing settings
     resource/nginx:
       # existing settings
     transform/nginx_metrics:
       # existing settings
     transform/nginx_access_logs:
       log_statements:
         - context: resource
           statements:
             - set(attributes["nginx.display.name"], Concat(["server", attributes["nginx.deployment.name"]], ":"))
             - set(attributes["logtype"], "nginx")
     transform/nginx_error_logs:
       log_statements:
         - context: resource
           statements:
             - set(attributes["nginx.display.name"], Concat(["server", attributes["nginx.deployment.name"]], ":"))
             - set(attributes["logtype"], "nginx-error")
   
   exporters:
     # existing exporter setup
   
   service:
     pipelines:
       metrics/nginx:
         receivers: [prometheus]
         processors: [batch, filter/nginx_metrics, resourcedetection, resource/nginx, transform/nginx_metrics]
         exporters: [otlphttp/newrelic]
       logs/nginx-access:
         receivers: [filelog/nginx_access_logs]
         processors: [batch, resource/nginx, transform/nginx_access_logs]
         exporters: [otlphttp/newrelic]
       logs/nginx-error:
         receivers: [filelog/nginx_error_logs]
         processors: [batch, resource/nginx, transform/nginx_error_logs]
         exporters: [otlphttp/newrelic]

   Copiar

3. Conceda ao usuário otelcol-contrib acesso de leitura aos arquivos de log:

   bash

   Copiar

   $
   sudo usermod -a -G adm otelcol-contrib
   $
   sudo chmod 644 /var/log/nginx/access.log
   $
   sudo chmod 644 /var/log/nginx/error.log

4. Reinicie o coletor para aplicar as alterações:

   bash

   Copiar

   $
   sudo systemctl restart otelcol-contrib

Encontre e use dados

1. Acesse one.newrelic.com > Integrations & Agents.
2. Selecione Dashboards e clique no dashboard NGINX OTel overview.
3. Na janela pop-up, selecione sua conta.
4. Clique em [View dashboard] e veja seus dados do NGINX Plus no New Relic.

As métricas do NGINX Plus são anexadas ao Metric tipo de evento. Você pode consultar esses dados para fins de solução de problemas ou para criar gráficos e dashboards personalizados.

Métricas coletadas

O OpenTelemetry Collector coleta métricas do NGINX Prometheus exporter, que expõe métricas da API HTTP do NGINX Plus no formato Prometheus.

Abaixo estão as métricas do NGINX Plus disponíveis:

Próximos passos

Saiba mais sobre seus dados:

• Encontre e consulte seus dados do NGINX - Acesse dashboards, crie consultas personalizadas e configure alertas
• Introdução ao NRQL - Aprenda a linguagem de consulta do New Relic para análise avançada de dados
• Crie condições de alerta NRQL - Configure alertas personalizados com base em suas métricas do NGINX Plus

Explore o monitoramento relacionado:

• Monitore o NGINX auto-hospedado com OpenTelemetry - Para implantações NGINX padrão
• Monitore o NGINX no Kubernetes com OpenTelemetry - Para ambientes em contêiner
• Visão geral do NGINX OpenTelemetry - Entenda as métricas, atributos e casos de uso coletados
• Melhores práticas do OpenTelemetry - Otimize sua configuração do OpenTelemetry

Recursos do NGINX Plus:

• Documentação do exportador NGINX Prometheus - Detalhes técnicos e configuração avançada
• Documentação da API do NGINX Plus - Referência completa da API e recursos