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

この設定を NGINX 設定ファイル (/etc/nginx/nginx.conf) に追加します。

server {
    listen 8080;
    server_name localhost;

    location /nginx_status {
        stub_status;
    }
}

1. NGINX 設定をテストします。

   bash

   コピー

   $
   sudo nginx -t

2. テストに合格したら、NGINX をリロードします。

   bash

   コピー

   $
   sudo nginx -s reload

エンドポイントをテストします。

$
curl http://127.0.0.1:8080/nginx_status

期待される出力:

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

HTTP 応答をテストします。

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

期待される出力: 次のように始まる必要があります HTTP/1.1 200 OK

OpenTelemetry Collector は、NGINX 監視に 3 つの主要コンポーネントを使用します。

• レシーバー- NGINXスタブステータスエンドポイントに接続してメトリクスを収集します
• プロセッサ- 効率的な転送のためにサーバ識別とバッチメトリクスを追加します
• エクスポーター- 処理されたメトリクスを OTLP HTTP 経由で New Relic アカウントに送信します。

設定を編集する前に、次の 2 つの重要な情報が必要です。

1. スタブ ステータス URL - ステップ 1 から (デフォルト: http://127.0.0.1:8080/nginx_status)

2. 一意のデプロイメント名- この特定の NGINX サーバーを識別する名前を選択します (例: production-web-01 、 staging-api 、 prod-lb-01)

   デプロイメント名は New Relic ダッシュボードに表示され、複数の NGINX インスタンスがある場合に特定のサーバーを識別するのに役立ちます。

Collector設定ファイル (通常は/etc/otelcol-contrib/config.yaml) を編集し、次のセクションを追加します。 すでにレシーバー、プロセッサ、またはエクスポーターのセクションがある場合は、これらを既存の設定とマージします。

1. 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. メタデータとバッチ処理用のプロセッサを構成します。

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. 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. すべてをパイプラインで接続します。

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

上記の設定で以下の値を置き換えます。

1. エンドポイント URL : http://127.0.0.1:8080/nginx_statusステップ 1 のスタブステータス設定に合わせて変更します

2. デプロイメント名: production-web-01この NGINX サーバーの一意の識別子に置き換えます

   適切なデプロイメント名の選択:

• production-web-01 、 staging-api 、または prod-lb-01
• New Relic アカウント内のすべての NGINX サーバーで一意である必要があります
• この名前はダッシュボードに表示され、特定のサーバーを識別するのに役立ちます
• フィルタリングやアラートを簡単に行えるよう、短くても意味のあるものにしましょう。

認証を構成する前に、次の 2 つの情報を収集します。

1. ** ライセンスキー:**

   • one.newrelic.com → API Keysにアクセスしてください
   • 「Ingest - License」セクションを見つけます → Show key [キーを表示]をクリックします
   • ライセンスキーをコピーします（「NRAK-...」で始まります）。

2. ** OTLP エンドポイント:** New Relicリージョンに適切なエンドポイントを使用します。 お住まいの地域でエンドポイントとサポートされているポートの完全なリストについては、「エンドポイント、ポート、およびプロトコルの構成」を参照してください。 例えば：

   • 米国地域: https://otlp.nr-data.net:4318
   • EU地域: https://otlp.eu01.nr-data.net:4318

1. systemd オーバーライド ディレクトリを作成します。

   bash

   コピー

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

2. 環境設定ファイルを作成します。

   bash

   コピー

   $
   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. 資格情報を使用して設定を更新します。

   • https://otlp.nr-data.net:4318リージョンのエンドポイントに置き換えます
   • YOUR_LICENSE_KEY_HERE上記の実際のライセンスキーに置き換えます

1. 設定の変更を適用します。

   bash

   コピー

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

2. サービスが実行されていることを確認します。

   bash

   コピー

   $
   sudo systemctl status otelcol-contrib.service

   期待される出力: Active: active (running) (最近のエラーなし)

3. 起動ログを確認します。

   bash

   コピー

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

   次の成功指標に注目してください。

   • ✅ "Everything is ready. Begin running and processing data."
   • ✅ "Scraping metrics" - NGINX からの収集に成功しました
   • ✅ "Exporting metrics" - New Relic への送信に成功しました

4. テスト トラフィックを生成します (メトリクスを作成するため)。

   bash

   コピー

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

5. 初期データが New Relic に表示されるまで待ってから、 NGINX ダッシュボードにアクセスしてデータ収集を確認します。

まず、解析やクエリが簡単に行える JSON 形式のログを出力するように NGINX を構成します。

これを 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...
}

変更を適用するには、NGINX をリロードします。

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

これらのセクションを/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]

Collector 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

Collectorを再起動します:

$
sudo systemctl restart otelcol-contrib.service

404 Not Found が表示される場合:

$
curl http://127.0.0.1:8080/nginx_status

解決策:

• ロケーションパスがリクエストURLと一致していることを確認してください
• 設定が正しいサーバーブロックに追加されたことを確認します
• sudo nginx -T | grep -A5 nginx_statusを実行して設定が読み込まれていることを確認します

403 Forbidden が表示される:

• ローカルホスト（127.0.0.1）からテストしていることを確認してください
• NGINX 設定のallow / denyディレクティブを確認してください
• 他のアクセス制限によってリクエストがブロックされていないことを確認します

接続拒否：

• NGINX が実行されているかどうかを確認します。 sudo systemctl status nginx
• ポート 8080 がブロックされていないことを確認します。 sudo netstat -tlnp | grep :8080
• 該当する場合はファイアウォールルールを確認してください

サービスステータスを確認します:

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

一般的な原因と修正方法:

• YAML 構文エラー- インデントと構文の問題を修正
• 環境変数が見つかりません- 環境ファイルに資格情報が設定されていることを確認してください
• ファイル権限の問題- 実行 sudo chown otelcol-contrib:otelcol-contrib /etc/otelcol-contrib/config.yaml
• 無効なエンドポイント URL - NGINX エンドポイントと New Relic OTLP エンドポイントを確認してください
• 不足しているコンポーネント設定- サービス パイプライン セクションで参照されているすべてのレシーバー、プロセッサ、およびエクスポーターが、上記のそれぞれの設定セクションで実際に定義されていることを確認します。

修正後に再起動します:

$
sudo systemctl restart otelcol-contrib.service

ステップバイステップの診断:

1. NGINX スタブ ステータスが機能していることを確認します。

   bash

   コピー

   $
   curl http://127.0.0.1:8080/nginx_status

   接続統計を返す必要があります。

2. Collectorが実行中であり正常であることを確認します。

   bash

   コピー

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

   ログには、 OpenTelemetry Collectorの設定または実行時の問題がある場合の詳細なコンテキストが提供されます。

3. NRQL でデータを確認します。

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

   コピー

New Relic にログが表示されない:

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

よくある問題:

• ファイル権限エラー- コレクターを adm グループに追加: sudo usermod -a -G adm otelcol-contrib
• ファイルパスが間違っています- 設定内のログファイルの場所を確認してください