OpenTelemetryを使用したセルフホスト型 NGINX Plus の監視

OpenTelemetry Collectorを使用してホスト上で実行されている NGINX Plus サーバーを監視し、メトリクスとテレメトリーデータをNew Relicに送信します。

この統合では、 OpenTelemetry prometheusreceiverとnginx-prometheus-exporterを利用して、NGINX Plus のパフォーマンス メトリクス、接続統計、サーバーの健全性を監視します。 NGINX Plus の豊富な HTTP API 、標準の NGINX の基本的なスタブ ステータス モジュールと比較して、はるかに詳細なメトリックを提供します。

あなたが始める前に

始める前に、次のものを用意してください。

• New Relicアカウントライセンスキー

• NGINX Plus バージョンR13以上

• HTTP APIモジュールを有効にしたNGINX Plus

• NGINX Prometheus エクスポータがインストールされ、NGINX Plus インスタンスと一緒に実行され、HTTP APIメトリクスを Prometheus 形式で公開します

• OpenTelemetry Collector Contrib がLinux ホストにインストールされ、実行されている

• Linux ホストから次のネットワーク アクセス:

  • NGINX Plus HTTP APIエンドポイント
  • New Relic OTLPエンドポイントのいずれか

設定を確認する

NGINX Plusのバージョンを確認します。

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

期待される出力: nginx/1.25.0以上 (R13+)

OpenTelemetry Collector を確認します。

$
otelcol-contrib --version

期待される出力: バージョン情報 (最低 v0.88.0 が必要)

ネットワーク接続をテストします。

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

期待される出力: HTTP/2 405 (許可されていないメソッドが期待されます)

ステップ1: NGINX Plusを構成する

NGINX Plus サーバーからメトリクスを公開するようにHTTP APIモジュールを構成して有効にします。

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

ステップ2: OpenTelemetry Collectorを構成する

NGINX Plus Prometheus エクスポーターからメトリクスを取得し、 New Relicに送信するようにOpenTelemetry Collector構成します。

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

ステップ3: コレクターの環境変数を設定する

エクスポーターが認証できるように、New Relic ライセンスキーと OTLP エンドポイントをコレクター サービスに挿入します。

$
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

ステップ4: データ収集を確認する

OpenTelemetry Collector NGINX Plus メトリックを正常に収集し、 New Relicに送信していることを確認します。

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

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

ステップ 5: (オプション) NGINX ログを転送する

メトリクスと一緒にログイベントが必要な場合は、コレクター設定を拡張してアクセスとエラーログを含めます。

NGINX Plusのログ形式を設定する

ログを転送する前に、構造化されたログ形式を使用するように NGINX Plus を構成します。 アクセス ログとエラー ログの構成に関するガイダンスについては、 NGINX ログのドキュメントを参照してください。

ログ転送用に OpenTelemetry Collector を構成する

1. NGINX アクセスとエラーログファイルへのフルパスをメモします。 デフォルトは通常/var/log/nginx/access.logと/var/log/nginx/error.logです。

2. /etc/otelcol-contrib/config.yamlを更新して、 filelogレシーバーとログ パイプラインを追加します。

   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]

   コピー

3. otelcol-contribユーザーにログファイルへの読み取りアクセスを許可します。

   bash

   コピー

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

4. 変更を適用するには、コレクターを再起動します。

   bash

   コピー

   $
   sudo systemctl restart otelcol-contrib

データを見つけて使用する

1. one.newrelic.com > Integrations & Agentsに移動します。
2. Dashboardsを選択し、 NGINX OTel overview [NGINX OTel 概要]ダッシュボード をクリックします。
3. ポップアップウィンドウでアカウントを選択します。
4. 「ダッシュボードの表示」をクリックし、New Relic で NGINX Plus データを表示します。

NGINX Plus メトリクスは、 Metricイベント タイプに関連付けられています。 このデータは、トラブルシューティングの目的で、またはカスタム チャートやダッシュボードを作成するために書き込むことができます。

メトリクスが収集されました

OpenTelemetry Collector 、 NGINX Prometheus エクスポーターからメトリクスを取得し、NGINX Plus HTTP APIメトリクスを Prometheus 形式で公開します。

以下は、利用可能な NGINX Plus メトリクスです。

次のステップ

データについて詳しくはこちらをご覧ください:

• NGINX データを見つけて書きます- ダッシュボードにアクセスし、カスタム書き込みを作成し、アラートを設定します
• NRQL入門- 高度なデータ分析のためのNew Relicのクエリ言語を学ぶ
• NRQLアラート条件の作成- NGINX Plus メトリクスに基づいてカスタム アラートを設定します

関連する監視を調べます:

• OpenTelemetryを使用したセルフホスト型 NGINX のモニター- 標準 NGINX デプロイメント用
• モニター NGINX on Kubernetes with OpenTelemetry - コンテナ環境向け
• NGINX OpenTelemetry概要- 収集されたメトリクス、プロパティ、ユースケースを理解する
• OpenTelemetryのベストプラクティス- OpenTelemetryの設定を最適化する

NGINX Plus リソース:

• NGINX Prometheus エクスポーターのドキュメント- 技術的な詳細と高度な設定
• NGINX Plus APIドキュメント- 完全なAPIリファレンスと機能