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

NGINX スタブ ステータス エンドポイントからメトリクスを取得し、 New Relicに送信するようにOpenTelemetry Collector設定します。

コレクター設定ファイル（通常は/etc/otelcol-contrib/config.yaml ）を編集し、以下のセクションを追加してください。既にレシーバー、プロセッサー、またはエクスポーターのセクションがある場合は、これらを既存の設定に統合してください。

1. NGINXレシーバーの設定：

   receivers:
     nginx:
       endpoint: <YOUR_STUB_STATUS_ENDPOINT>  # 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
     resourcedetection:
       detectors: [system]
       system:
         resource_attributes:
           host.name:
             enabled: false
           host.id:
             enabled: true
   
     # Add NGINX-specific identification
     resource/nginx:
       attributes:
         - key: nginx.server.endpoint
           value: "<YOUR_STUB_STATUS_ENDPOINT>"  # Replace with your endpoint
           action: upsert
         - key: nginx.deployment.name
           value: "<DEPLOYMENT_NAME>"                    # Replace with your deployment 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"]], ":"))
     
     transform/metadata_nullify:
       metric_statements:
         - context: metric
           statements:
             - set(description, "")
             - set(unit, "")

   コピー

3. New Relicエクスポーターの設定：

   exporters:
     # Send metrics to New Relic via OTLP
     otlp_http:
       endpoint: ${env:YOUR_NEWRELIC_OTLP_ENDPOINT}
       headers:
         api-key: ${env:YOUR_NEW_RELIC_LICENSE_KEY}

   コピー

4. すべてをパイプラインで接続する：

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

   コピー

   設定パラメーター

   次の表では、キー設定について説明します。

   パラメータ	説明
   <YOUR_STUB_STATUS_ENDPOINT>	NGINXスタブのステータスエンドポイント（例： http://127.0.0.1/basic_status ）に置き換えてください。
   <DEPLOYMENT_NAME>	このNGINXサーバーの一意のデプロイメント名に置き換えてください（例： production-web-01 、 staging-api 、 prod-lb-01 ）。
   collection_interval	メトリクスを収集する間隔 (秒単位)。 デフォルト値は 30s
   timeout	バッチ処理されたメトリクスを送信する前に待機するタイムアウト時間（秒）。デフォルト値は 30s
   send_batch_size	送信前にバッチ処理するメトリクスの数。デフォルト値は 1024

OpenTelemetry Collector が New Relic アカウントにデータを送信できるように、安全な認証を構成します。この手順では、資格情報を安全に保つために環境変数を設定します。

1. New Relicの認証情報を取得してください：

   • ライセンスキー: APIキーUIページからライセンスキーを取得します。
   • OTLP エンドポイント: New Relic OTLP エンドポイントから地域のエンドポイントを使用します

2. 認証情報を設定します。

   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=<YOUR_NEWRELIC_OTLP_ENDPOINT>"  # Replace with your region's endpoint
   $
   Environment="NEWRELIC_LICENSE_KEY=YOUR_NEW_RELIC_LICENSE_KEY"
   $
   EOF

メトリクスに加えて、NGINXのアクセスログとエラーログをNew Relicに送信することで、包括的な監視とトラブルシューティングを行うことができます。これらのログはコア NGINX メトリクスを補完し、詳細なリクエスト レベルのインサイトを提供します。

1. NGINXでJSON形式のログを出力するように設定するには、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...
   }

   コピー

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

   bash

   コピー

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

3. ログ転送用にコレクターを設定するには、 /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...
   
       # Add log pipelines
       logs/nginx-access:
         receivers: [filelog/nginx_access]
         processors: [resource/nginx, batch, transform/nginx_access_logs]
         exporters: [otlp_http]
   
       logs/nginx-error:
         receivers: [filelog/nginx_error]
         processors: [resource/nginx, batch, transform/nginx_error_logs]
         exporters: [otlp_http]

   コピー

4. 権限を設定し、設定を適用します。コレクターが NGINX ログ ファイルを読み取ることを許可します。

   bash

   コピー

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

すべての設定が完了したら、OpenTelemetry Collector を起動し、データが New Relic に流れていることを確認します。

1. コレクターを起動します。

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

   コピー

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

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

   コピー

   $
   sudo systemctl status otelcol-contrib.service

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

2. データ収集を確認する：

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

   コピー

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

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

   コピー

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

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