Monitorer NGINX auto-hébergé avec OpenTelemetry

Ajoutez cette configuration à votre fichier de configuration NGINX (/etc/nginx/nginx.conf) :

server {
    listen 8080;
    server_name localhost;

    location /nginx_status {
        stub_status;
    }
}

1. Testez votre configuration NGINX :

   bash

   Copier

   $
   sudo nginx -t

2. Si le test réussit, rechargez NGINX :

   bash

   Copier

   $
   sudo nginx -s reload

Testez le point de terminaison :

$
curl http://127.0.0.1:8080/nginx_status

Résultat attendu :

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

Testez la réponse HTTP :

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

Résultat attendu : Doit commencer par HTTP/1.1 200 OK

Le collecteur OpenTelemetry utilise trois composants principaux pour le monitoring NGINX :

• Receivers - Connectez-vous à votre point de terminaison d'état stub NGINX pour collecter des métriques
• Processeurs - Ajouter l'identification du serveur et les métriques par lots pour une transmission efficace
• Exportateurs - Envoyer les métriques traitées à votre compte New Relic via OTLP HTTP

Avant de modifier la configuration, vous aurez besoin de deux informations clés :

1. Votre URL d'état stub - De l'étape 1 (par défaut : http://127.0.0.1:8080/nginx_status)

2. Un nom de déploiement unique - Choisissez un nom qui identifie ce serveur NGINX spécifique (par exemple, production-web-01, staging-api, prod-lb-01)

   Le nom du déploiement apparaîtra dans les dashboards New Relic et vous aidera à identifier des serveurs spécifiques lorsque vous avez plusieurs instances NGINX.

Modifiez votre fichier de configuration du collecteur (généralement /etc/otelcol-contrib/config.yaml) et ajoutez les sections suivantes. Si vous avez déjà des sections de récepteurs, de processeurs ou d'exportateurs, fusionnez-les avec votre configuration existante :

1. Configurez le récepteur 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. Configurez les processeurs pour les métadonnées et le traitement par lots :

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. Configurez l'exportateur 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. Connectez le tout avec un pipeline :

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

Remplacez ces valeurs dans la configuration ci-dessus :

1. URL du point de terminaison: Remplacez http://127.0.0.1:8080/nginx_status pour correspondre à votre configuration d'état factice de l'étape 1

2. Nom du déploiement: Remplacez production-web-01 par un identifiant unique pour ce serveur NGINX

   Choisir un bon nom de déploiement :

• Utilisez des noms descriptifs comme production-web-01, staging-api ou prod-lb-01
• Doit être unique pour tous les serveurs NGINX de votre compte New Relic
• Ce nom apparaîtra dans les dashboards et vous aidera à identifier des serveurs spécifiques
• Gardez-le court mais significatif pour faciliter le filtrage et les alertes

Avant de configurer l'authentification, rassemblez ces deux informations :

1. ** Votre clé de licence :**

   • Accédez à one.newrelic.com → API Keys
   • Recherchez la section "Ingest - License" → Cliquez sur Show key
   • Copiez la clé de licence (commence par "NRAK-...")

2. ** Votre point de terminaison OTLP :** Utilisez le point de terminaison approprié pour votre région New Relic. Consultez Configurer le point de terminaison, le port et le protocole pour la liste complète des points de terminaison et des ports pris en charge pour votre région. Par exemple :

   • Région US: https://otlp.nr-data.net:4318
   • Région UE: https://otlp.eu01.nr-data.net:4318

1. Créer un répertoire de remplacement systemd :

   bash

   Copier

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

2. Créez le fichier de configuration de l'environnement :

   bash

   Copier

   $
   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. Mettez à jour la configuration avec vos informations d'identification :

   • Remplacez https://otlp.nr-data.net:4318 par le point de terminaison de votre région
   • Remplacez YOUR_LICENSE_KEY_HERE par votre clé de licence réelle ci-dessus

1. Appliquer les modifications de configuration :

   bash

   Copier

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

2. Vérifiez que le service est en cours d'exécution :

   bash

   Copier

   $
   sudo systemctl status otelcol-contrib.service

   Sortie attendue : Active: active (running) sans erreurs récentes

3. Vérifiez les logs de démarrage :

   bash

   Copier

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

   Recherchez ces indicateurs de réussite :

   • ✅ "Everything is ready. Begin running and processing data."
   • ✅ "Scraping metrics" - Collecte réussie depuis NGINX
   • ✅ "Exporting metrics" - Envoi réussi à New Relic

4. Générez du trafic de test (pour créer des métriques) :

   bash

   Copier

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

5. Laissez le temps aux données initiales d'apparaître dans New Relic, puis accédez à votre dashboard NGINX pour vérifier la collecte des données.

Tout d'abord, configurez NGINX pour qu'il génère des logs au format JSON, qui sont plus faciles à analyser et à interroger.

Ajoutez ceci à votre configuration 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...
}

Rechargez NGINX pour appliquer les modifications :

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

Ajoutez ces sections à votre /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]

Autoriser le collecteur à lire les fichiers logs 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

Redémarrer le collecteur :

$
sudo systemctl restart otelcol-contrib.service

Obtention de 404 Not Found :

$
curl http://127.0.0.1:8080/nginx_status

Solutions :

• Vérifiez que le chemin d'accès correspond à l'URL de votre requête
• Vérifiez que la configuration a été ajoutée au bloc serveur correct
• Exécutez sudo nginx -T | grep -A5 nginx_status pour confirmer que la configuration est chargée

Obtention d'une erreur 403 Interdit :

• Assurez-vous que vous testez depuis localhost (127.0.0.1)
• Vérifiez vos directives allow/deny dans la configuration NGINX
• Vérifiez qu'aucune autre restriction d'accès ne bloque la requête

Connexion refusée :

• Vérifiez si NGINX est en cours d'exécution : sudo systemctl status nginx
• Vérifiez que le port 8080 n'est pas bloqué : sudo netstat -tlnp | grep :8080
• Vérifiez les règles de pare-feu, le cas échéant

Vérifiez l'état du service :

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

Causes et corrections courantes :

• Erreurs de syntaxe YAML - Corrigez les problèmes d'indentation et de syntaxe
• Variables d'environnement manquantes - Vérifiez que les informations d'identification sont définies dans le fichier d'environnement
• Problèmes de permissions de fichiers - Exécuter sudo chown otelcol-contrib:otelcol-contrib /etc/otelcol-contrib/config.yaml
• URL de point de terminaison non valides - Vérifiez le point de terminaison NGINX et le point de terminaison OTLP New Relic
• Configurations de composants manquantes - Assurez-vous que tous les récepteurs, processeurs et exportateurs référencés dans la section des pipelines de service sont réellement définis dans leurs sections de configuration respectives ci-dessus

Redémarrer après les corrections :

$
sudo systemctl restart otelcol-contrib.service

Diagnostic étape par étape :

1. Vérifiez que le statut stub NGINX fonctionne :

   bash

   Copier

   $
   curl http://127.0.0.1:8080/nginx_status

   Doit renvoyer les statistiques de connexion.

2. Vérifiez que le collecteur est en cours d'exécution et en bonne santé :

   bash

   Copier

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

   Les logs fourniront un contexte détaillé en cas de problèmes de configuration ou d'exécution avec OpenTelemetry Collector.

3. Vérifiez les données avec NRQL :

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

   Copier

Aucun log n'apparaît dans New Relic :

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

Problèmes courants :

• Erreurs d'autorisation de fichier - Ajouter le collecteur au groupe adm : sudo usermod -a -G adm otelcol-contrib
• Chemins de fichiers incorrects - Vérifiez les emplacements des fichiers logs dans votre configuration