Monitorer NGINX Plus auto-hébergé avec OpenTelemetry

Monitorez vos serveurs NGINX Plus fonctionnant sur un hôte en utilisant le Collecteur OpenTelemetry pour envoyer des métriques et des données de télémétrie à New Relic.

Cette intégration exploite le prometheusreceiver et le nginx-prometheus-exporter OpenTelemetry pour monitorer les métriques de performance, les statistiques de connexion et l'état du serveur de votre NGINX Plus. La riche API HTTP de NGINX Plus fournit des métriques beaucoup plus détaillées que le module d'état stub de base dans NGINX standard.

Avant de commencer

Avant de commencer, assurez-vous d’avoir :

• Un compte New Relic avec unclé de licence

• Version NGINX Plus R13 ou supérieure

• NGINX Plus avec le module HTTP API activé

• Exportateur Prometheus NGINX installé et fonctionnant aux côtés de votre instance NGINX Plus pour exposer les métriques de l'API HTTP au format Prometheus

• OpenTelemetry Collector Contrib installé et en cours d'exécution sur un hôte Linux

• Accès réseau de l'hôte Linux vers :

  • Point de terminaison de l'API HTTP NGINX Plus
  • N'importe lequel des points de terminaison New Relic OTLP

Vérifiez votre configuration

Vérifiez la version de NGINX Plus :

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

Sortie attendue : nginx/1.25.0 ou supérieure (R13+)

Vérifier OpenTelemetry Collector :

$
otelcol-contrib --version

Sortie attendue : Informations de version (minimum v0.88.0 requis)

Testez la connectivité réseau :

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

Résultat attendu : HTTP/2 405 (méthode non autorisée est attendue)

Étape 1 : Configurer NGINX Plus

Configurez et activez le module API HTTP pour exposer les métriques de votre serveur 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

Étape 2 : Configurer le collecteur OpenTelemetry

Configurez le collecteur OpenTelemetry pour extraire les métriques de votre exportateur Prometheus NGINX Plus et les envoyer à 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

Étape 3 : Définir les variables d'environnement pour le collecteur

Injectez votre clé de licenceNew Relic et le point de terminaison OTLP dans le service du collecteur afin que l'exportateur puisse s'authentifier.

$
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

Étape 4 : Vérifier la collecte de données

Vérifiez que le collecteur OpenTelemetry collecte avec succès les métriques NGINX Plus et les envoie à New Relic.

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

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

Étape 5 : (Facultatif) Transférer les logs NGINX

Étendez votre configuration du collecteur pour inclure les logs d'accès et d'erreurs si vous souhaitez des événements de log en plus des métriques.

Configurer le format de log NGINX Plus

Avant de transférer les logs, configurez NGINX Plus pour utiliser un format de log structuré. Reportez-vous à la documentation de logging NGINX pour obtenir des conseils sur la configuration des logs d'accès et d'erreurs.

Configurer le collecteur OpenTelemetry pour le transfert des logs

1. Notez les chemins complets de vos fichiers logs d'accès et d'erreurs NGINX. Les valeurs par défaut sont généralement /var/log/nginx/access.log et /var/log/nginx/error.log.

2. Mettez à jour /etc/otelcol-contrib/config.yaml pour ajouter un récepteur filelog et un pipeline de logs :

   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]

   Copier

3. Accorder l'accès en lecture au fichier log à l'utilisateur otelcol-contrib :

   bash

   Copier

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

4. Redémarrez le collecteur pour appliquer les modifications :

   bash

   Copier

   $
   sudo systemctl restart otelcol-contrib

Rechercher et utiliser des données

1. Accédez à one.newrelic.com > Integrations & Agents.
2. Sélectionnez Dashboards, puis cliquez sur le dashboard NGINX OTel overview.
3. Dans la fenêtre contextuelle, sélectionnez votre compte.
4. Cliquez sur [View dashboard] et consultez vos données NGINX Plus dans New Relic.

Les métriques NGINX Plus sont attachées au type d'événement Metric. Vous pouvez interroger ces données à des fins de dépannage ou pour créer des graphiques et des dashboards personnalisés.

Métriques collectées

Le collecteur OpenTelemetry collecte les métriques à partir de l'exportateur NGINX Prometheus, qui expose les métriques de l'API HTTP NGINX Plus au format Prometheus.

Vous trouverez ci-dessous les métriques NGINX Plus disponibles :

Prochaines étapes

En savoir plus sur vos données :

• Trouvez et interrogez vos données NGINX - Accédez aux dashboards, créez des requêtes personnalisées et configurez des alertes
• Introduction à NRQL - Apprenez le langage de requête de New Relic pour l'analyse avancée des données
• Créer des conditions d'alerte NRQL - Configurer des alertes personnalisées basées sur vos métriques NGINX Plus

Explorer le monitoring connexe :

• Monitorer NGINX auto-hébergé avec OpenTelemetry - Pour les déploiements NGINX standard
• Monitorer NGINX sur Kubernetes avec OpenTelemetry - Pour les environnements conteneurisés
• Présentation d'NGINX OpenTelemetry - Comprendre les métriques, les attributs et les cas d'utilisation collectés
• Meilleures pratiques OpenTelemetry - Optimisez votre configuration OpenTelemetry

Ressources NGINX Plus :

• Documentation de l'exportateur NGINX Prometheus - Détails techniques et configuration avancée
• Documentation de l'API NGINX Plus - Référence complète de l'API et fonctionnalités