Monitoree NGINX autohospedado con OpenTelemetry

Agregue esta configuración a su archivo de configuración de NGINX (/etc/nginx/nginx.conf):

server {
    listen 8080;
    server_name localhost;

    location /nginx_status {
        stub_status on;
        access_log off;        # Don't log monitoring requests
        allow 127.0.0.1;       # Only allow localhost access
        allow ::1;             # Allow IPv6 localhost
        deny all;              # Deny all other access
    }
}

1. Pruebe su configuración de NGINX:

   bash

   Copia

   $
   sudo nginx -t

2. Si la prueba pasa, recargue NGINX:

   bash

   Copia

   $
   sudo nginx -s reload

Pruebe el endpoint:

$
curl http://127.0.0.1:8080/nginx_status

Resultado esperado:

Active connections: 1
server accepts handled requests
 16 16 16
Reading: 0 Writing: 1 Waiting: 0

Probar la respuesta HTTP:

$
curl -I http://127.0.0.1:8080/nginx_status

Salida esperada: Debe comenzar con HTTP/1.1 200 OK

El recopilador de OpenTelemetry utiliza tres componentes principales para la monitorización de NGINX:

• Receptores - Conéctese a su punto final de estado de stub de NGINX para recopilar métricas
• Procesadores - Agregue la identificación del servidor y las métricas por lotes para una transmisión eficiente
• Exportadores - Envíe las métricas procesadas a su cuenta de New Relic a través de OTLP HTTP

Antes de editar la configuración, necesitará dos datos clave:

1. Su URL de estado de stub - Del Paso 1 (predeterminado: http://127.0.0.1:8080/nginx_status)

2. Un nombre de implementación único: elija un nombre que identifique este servidor NGINX específico (por ejemplo, production-web-01, staging-api, prod-lb-01)

   El nombre de la implementación aparecerá en los dashboards de New Relic y le ayudará a identificar servidores específicos cuando tenga múltiples instancias de NGINX.

Edite su archivo de configuración del Collector (normalmente /etc/otelcol-contrib/config.yaml) y agregue las siguientes secciones. Si ya tiene secciones de receptores, procesadores o exportadores, combínelas con su configuración existente:

1. Configurar el receptor NGINX:

receivers:
  nginx:
    endpoint: http://127.0.0.1:8080/nginx_status  # Replace with your stub status URL
    collection_interval: 30s                      # How often to collect metrics
    metrics:
      nginx.requests:
        enabled: true
      nginx.connections_accepted:
        enabled: true
      nginx.connections_handled:
        enabled: true
      nginx.connections_current:
        enabled: true

2. Configure los procesadores para metadatos y agrupación por lotes:

processors:
  # Detect system information (hostname, etc.)
  resourcedetection:
    detectors: [system]
    system:
      resource_attributes:
        host.name:
          enabled: true
        host.id:
          enabled: true

  # Add NGINX-specific identification
  resource:
    attributes:
      - key: nginx.server.endpoint
        value: "http://127.0.0.1:8080/nginx_status"  # Replace with your endpoint
        action: upsert
      - key: nginx.deployment.name
        value: "production-web-01"                    # Replace with your server name
        action: upsert

  # Batch metrics for efficient sending
  batch:
    timeout: 30s
    send_batch_size: 1024

  # Transform metrics for better display in New Relic
  transform/nginx_metrics:
    metric_statements:
      - context: resource
        statements:
          # Customize the display name as needed for your New Relic dashboard
          - set(attributes["nginx.display.name"], Concat(["server", attributes["nginx.deployment.name"]], ":"))

3. Configure el exportador de New Relic:

exporters:
  # Send metrics to New Relic via OTLP
  otlphttp/newrelic:
    endpoint: ${env:NEWRELIC_OTLP_ENDPOINT}
    headers:
      api-key: ${env:NEWRELIC_LICENSE_KEY}

4. Conecte todo con una canalización:

service:
  pipelines:
    metrics:
      receivers: [nginx]
      processors: [resourcedetection, resource, batch, transform/nginx_metrics]
      exporters: [otlphttp/newrelic]

Reemplace estos valores en la configuración anterior:

1. URL del endpoint: Cambie http://127.0.0.1:8080/nginx_status para que coincida con su configuración de estado de stub del Paso 1

2. Nombre de implementación: Reemplace production-web-01 con un identificador único para este servidor NGINX

   Elegir un buen nombre de implementación:

• Use nombres descriptivos como production-web-01, staging-api, o prod-lb-01
• Debe ser único en todos los servidores NGINX dentro de su cuenta de New Relic
• Este nombre aparecerá en los dashboards y le ayudará a identificar servidores específicos
• Sea breve pero significativo para facilitar el filtrado y las alertas

Antes de configurar la autenticación, recopile estas dos piezas de información:

1. ** Su clave de licencia:**

   • Vaya a one.newrelic.com → API Keys
   • Busque la sección "Ingest - License" → Haga clic en Show key
   • Copie la clave de licencia (comienza con "NRAK-...")

2. ** Su punto final OTLP:** Use el punto final apropiado para su región de New Relic. Consulte Configurar el punto final, el puerto y el protocolo para obtener la lista completa de puntos finales y puertos admitidos para su región. Por ejemplo:

   • Región de EE. UU.: https://otlp.nr-data.net:4318
   • Región de la UE: https://otlp.eu01.nr-data.net:4318

1. Crea un directorio de anulación de systemd:

   bash

   Copia

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

2. Cree el archivo de configuración del entorno:

   bash

   Copia

   $
   cat <<EOF | sudo tee /etc/systemd/system/otelcol-contrib.service.d/environment.conf
   $
   [Service]
   $
   Environment="NEWRELIC_OTLP_ENDPOINT=https://otlp.nr-data.net:4318"
   $
   Environment="NEWRELIC_LICENSE_KEY=YOUR_LICENSE_KEY_HERE"
   $
   EOF

3. Actualice la configuración con sus credenciales:

   • Reemplace https://otlp.nr-data.net:4318 con el punto final de su región
   • Reemplace YOUR_LICENSE_KEY_HERE con su clave de licencia real de arriba

1. Aplique los cambios de configuración:

   bash

   Copia

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

2. Verifique que el servicio se esté ejecutando:

   bash

   Copia

   $
   sudo systemctl status otelcol-contrib.service

   Salida esperada: Active: active (running) sin errores recientes

3. Verifique los logs de inicio:

   bash

   Copia

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

   Busque estos indicadores de éxito:

   • ✅ "Everything is ready. Begin running and processing data."
   • ✅ "Scraping metrics" - Recopilación exitosa de NGINX
   • ✅ "Exporting metrics" - Enviando correctamente a New Relic

4. Generar tráfico de prueba (para crear métricas):

   bash

   Copia

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

5. Espere a que los datos iniciales aparezcan en New Relic, luego acceda a su dashboard de NGINX para verificar la recopilación de datos.

Primero, configure NGINX para generar logs con formato JSON que sean más fáciles de analizar y consultar.

Agregue esto a su configuración de NGINX (/etc/nginx/nginx.conf):

http {
    # JSON log format for better parsing
    log_format json_combined escape=json
    '{'
      '"time":"$time_local",'
      '"remote_addr":"$remote_addr",'
      '"request":"$request",'
      '"status":$status,'
      '"bytes_sent":$body_bytes_sent,'
      '"request_time":$request_time,'
      '"referer":"$http_referer",'
      '"user_agent":"$http_user_agent"'
    '}';

    # Use the JSON format for access logs
    access_log /var/log/nginx/access.log json_combined;
    error_log /var/log/nginx/error.log warn;

    # Your existing configuration...
}

Recargue NGINX para aplicar los cambios:

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

Agregue estas secciones a su /etc/otelcol-contrib/config.yaml:

receivers:
  # Your existing nginx receiver...
  nginx:
    # existing configuration...

  # Add log receivers
  filelog/nginx_access:
    include:
      - /var/log/nginx/access.log

  filelog/nginx_error:
    include:
      - /var/log/nginx/error.log

processors:
  # Your existing processors...

  # Add log processor
  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")

service:
  pipelines:
    # Your existing metrics pipeline...
    metrics:
      receivers: [nginx]
      processors: [resourcedetection, resource, batch, transform/nginx_metrics]
      exporters: [otlphttp/newrelic]

    # Add log pipelines
    logs/nginx-access:
      receivers: [filelog/nginx_access]
      processors: [resource, batch, transform/nginx_access_logs]
      exporters: [otlphttp/newrelic]

    logs/nginx-error:
      receivers: [filelog/nginx_error]
      processors: [resource, batch, transform/nginx_error_logs]
      exporters: [otlphttp/newrelic]

Permita que el Collector lea los archivos de log de NGINX:

$
# Add collector user to adm group (has read access to logs)
$
sudo usermod -a -G adm otelcol-contrib
$

$
# Ensure log files are readable
$
sudo chmod 644 /var/log/nginx/access.log
$
sudo chmod 644 /var/log/nginx/error.log

Reiniciar el recopilador:

$
sudo systemctl restart otelcol-contrib.service

Obteniendo 404 No encontrado:

$
curl http://127.0.0.1:8080/nginx_status

Soluciones:

• Verifique que la ruta de la ubicación coincida con la URL de su solicitud
• Verifique que la configuración se haya agregado al bloque de servidor correcto
• Ejecute sudo nginx -T | grep -A5 nginx_status para confirmar que la configuración está cargada

Obteniendo 403 Prohibido:

• Asegúrese de que está probando desde localhost (127.0.0.1)
• Verifique sus directivas allow/deny en la configuración de NGINX
• Verifique que no haya otras restricciones de acceso que bloqueen la solicitud

Conexión rechazada:

• Verifique si NGINX se está ejecutando: sudo systemctl status nginx
• Verifique que el puerto 8080 no esté bloqueado: sudo netstat -tlnp | grep :8080
• Verifique las reglas del firewall si corresponde

Verifique el estado del servicio:

$
sudo systemctl status otelcol-contrib.service
$
sudo journalctl -u otelcol-contrib.service -n 50

Causas y soluciones comunes:

• Errores de sintaxis YAML - Corrija la sangría y los problemas de sintaxis
• Variables de entorno faltantes - Verifique que las credenciales estén configuradas en el archivo de entorno
• Problemas de permisos de archivos - Ejecutar sudo chown otelcol-contrib:otelcol-contrib /etc/otelcol-contrib/config.yaml
• URLs de punto final no válidas - Verifique el punto final de NGINX y el punto final OTLP de New Relic
• Configuraciones de componentes faltantes - Asegúrese de que todos los receptores, procesadores y exportadores a los que se hace referencia en la sección de canalizaciones de servicio estén realmente definidos en sus respectivas secciones de configuración anteriores

Reinicie después de las correcciones:

$
sudo systemctl restart otelcol-contrib.service

Diagnóstico paso a paso:

1. Verifique que el estado de la stub de NGINX funcione:

   bash

   Copia

   $
   curl http://127.0.0.1:8080/nginx_status

   Debería devolver las estadísticas de conexión.

2. Verifique que Collector se esté ejecutando y esté en buen estado:

   bash

   Copia

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

   Los logs proporcionarán contexto detallado si hay algún problema de configuración o tiempo de ejecución con el OpenTelemetry Collector.

3. Compruebe los datos con NRQL:

   FROM Metric SELECT * WHERE nginx.deployment.name LIKE '%production%' LIMIT 1

   Copia

No aparecen logs en New Relic:

$
# Check Collector logs for file errors
$
sudo journalctl -u otelcol-contrib -f | grep -i "filelog\|error"

Problemas comunes:

• Errores de permisos de archivo - Agregar el recolector al grupo adm: sudo usermod -a -G adm otelcol-contrib
• Rutas de archivo incorrectas - Verifique las ubicaciones de los archivos de log en su configuración