Monitoree NGINX Plus autohospedado con OpenTelemetry

Supervise sus servidores NGINX Plus que se ejecutan en un host utilizando el OpenTelemetry Collector para enviar métricas y datos de telemetría a New Relic.

Esta integración aprovecha el prometheusreceiver de OpenTelemetry y el nginx-prometheus-exporter para supervisar las métricas de rendimiento, las estadísticas de conexión y el estado del servidor de NGINX Plus. La rica API HTTP en NGINX Plus proporciona métricas significativamente más detalladas en comparación con el módulo de estado básico stub en NGINX estándar.

Antes de que empieces

Antes de comenzar, cerciorar de tener:

• Una cuenta de New Relic con unclave de licencia

• Versión de NGINX Plus R13 o superior

• NGINX Plus con el módulo API HTTP habilitado

• Expositor de Prometheus de NGINX NGINX Prometheus exporter instalado y en ejecución junto con tu instancia de NGINX Plus para exponer métricas de la API HTTP en formato Prometheus

• OpenTelemetry Collector Contrib instalado y en ejecución en un host Linux

• Acceso a la red desde el host de Linux a:

  • Punto final de la API HTTP de NGINX Plus
  • Cualquiera de los puntos finales de New Relic OTLP

Verifique su configuración

Verifica la versión de NGINX Plus:

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

Salida esperada: nginx/1.25.0 o superior (R13+)

Verifique OpenTelemetry Collector:

$
otelcol-contrib --version

Salida esperada: Información de la versión (se requiere un mínimo de v0.88.0)

Pruebe la conectividad de red:

$
# 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

Salida esperada: HTTP/2 405 (se espera que el método no esté permitido)

Paso 1: Configure NGINX Plus

Configure y habilite el módulo de API HTTP para exponer las métricas de su 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

Paso 2: Configura el OpenTelemetry Collector

Configure el OpenTelemetry Collector para extraer métricas de su exportador Prometheus de NGINX Plus y enviarlas a 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

Paso 3: Establezca variables de entorno para el recopilador

Inyecte su clave de licenciade New Relic y el punto final OTLP en el servicio del recopilador para que el exportador pueda autenticarse.

$
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

Paso 4: Verifique la recopilación de datos

Confirme que el recopilador de OpenTelemetry está recopilando correctamente las métricas de NGINX Plus y enviándolas a New Relic.

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

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

Paso 5: (Opcional) Reenviar los logs de NGINX

Extienda la configuración de su recopilador para incluir logs de acceso y errores si desea eventos de log junto con las métricas.

Configurar el formato de log de NGINX Plus

Antes de reenviar los logs, configure NGINX Plus para usar un formato de log estructurado. Consulte la documentación de log de NGINX para obtener orientación sobre la configuración de los logs de acceso y error.

Configure el recopilador de OpenTelemetry para el reenvío de logs

1. Tenga en cuenta las rutas completas a sus archivos de log de acceso y error de NGINX. Los valores predeterminados suelen ser /var/log/nginx/access.log y /var/log/nginx/error.log.

2. Actualice /etc/otelcol-contrib/config.yaml para agregar un receptor filelog y una canalización 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]

   Copia

3. Otorgue al usuario otelcol-contrib acceso de lectura a los archivos de log:

   bash

   Copia

   $
   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 el recopilador para aplicar los cambios:

   bash

   Copia

   $
   sudo systemctl restart otelcol-contrib

Buscar y utilizar datos

1. Vaya a one.newrelic.com > Integrations & Agents.
2. Seleccione Dashboards y haga clic en el dashboard NGINX OTel overview.
3. En la ventana emergente, seleccione su cuenta.
4. Haga clic en [View dashboard] y vea sus datos de NGINX Plus en New Relic.

Las métricas de NGINX Plus se adjuntan al tipo de evento Metric. Puede consultar estos datos con fines de solución de problemas o para crear gráficos y dashboards personalizados.

Métricas recopiladas

El recopilador de OpenTelemetry extrae métricas del exportador de NGINX Prometheus, que expone las métricas de la API HTTP de NGINX Plus en formato Prometheus.

A continuación se muestran las métricas de NGINX Plus disponibles:

Próximos pasos

Obtén más información sobre tus datos:

• Encuentre y consulte sus datos de NGINX: acceda a los dashboards, cree consultas personalizadas y configure alertas
• Introducción a NRQL: aprenda el lenguaje de consulta de New Relic para el análisis avanzado de datos
• Crear condiciones de alerta NRQL - Configure alertas personalizadas basadas en sus métricas de NGINX Plus

Explore la supervisión relacionada:

• Supervisa NGINX autohospedado con OpenTelemetry - Para implementaciones estándar de NGINX
• Monitoree NGINX en Kubernetes con OpenTelemetry - Para entornos en contenedores
• Descripción general de NGINX OpenTelemetry - Comprenda las métricas, los atributos y los casos de uso recopilados
• Mejores prácticas de OpenTelemetry - Optimice su configuración de OpenTelemetry

Recursos de NGINX Plus:

• Documentación del expositor de Prometheus de NGINX - Detalles técnicos y configuración avanzada
• Documentación de la API de NGINX Plus: referencia completa de la API y características