OpenTelemetry를 사용하여 자체 호스팅 NGINX를 모니터링하세요

NGINX 스텁 상태 엔드포인트에서 지표를 스크랩하여 뉴렐릭으로 보내도록 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. 뉴렐릭 익스포터를 구성하세요:

   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 뉴릭 계정으로 데이터를 전송할 수 있도록 보안 인증을 구성하십시오. 이 단계에서는 자격 증명을 안전하게 보호하기 위한 환경 변수를 설정합니다.

1. 뉴렐릭 자격증을 취득하세요:

   • 인스턴스 키: API 키 UI 페이지에서 인스턴스 키를 가져옵니다.
   • OTLP 엔드포인트: 뉴렐릭 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 액세스 및 오류 로그를 뉴렐릭으로 보낼 수 있습니다. 이러한 로그는 핵심 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 시작하고 데이터가 뉴렐릭으로 제대로 전송되는지 확인하십시오.

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

   뉴렐릭에 초기 데이터가 나타날 때까지 기다린 후 NGINX에 접속하여 데이터 수집을 확인하십시오.

이 설정은 NRDOT 및 OTel Collector Contrib 모두에서 작동합니다. 적절한 설정 위치에 배치합니다:

• NRDOT: /etc/nrdot-collector/config.yaml

• OTel Collector Contrib: /etc/otelcol-contrib/config.yaml

  팁

  변경하기 전에 기존 설정을 백업하세요:

  bash

  카피

  $
  # For NRDOT
  $
  sudo cp /etc/nrdot-collector/config.yaml /etc/nrdot-collector/config.yaml.backup
  $
  
  $
  # For OTel Collector Contrib
  $
  sudo cp /etc/otelcol-contrib/config.yaml /etc/otelcol-contrib/config.yaml.backup

  파일 내용을 다음 설정으로 바꿉니다:

  중요

  <YOUR_STUB_STATUS_ENDPOINT> 을 NGINX stub status URL(예: http://127.0.0.1:8080/nginx_status)로 바꾸고 <DEPLOYMENT_NAME> 를 이 NGINX 서버의 고유한 이름으로 바꿉니다.

  receivers:
    prometheus/nginx:
      config:
        scrape_configs:
          - job_name: nginx
            scrape_interval: 30s
            static_configs:
              - targets: ["localhost:9113"]  # Update if exporter runs on a different port
  
  processors:
    resourcedetection/prom:
      detectors: [system]
      system:
        resource_attributes:
          host.name:
            enabled: false
          host.id:
            enabled: true
  
    resource/nginx_prom:
      attributes:
        - key: nginx.server.endpoint
          value: "<YOUR_STUB_STATUS_ENDPOINT>"  # Replace with your stub status URL
          action: upsert
        - key: nginx.deployment.name
          value: "<DEPLOYMENT_NAME>"            # Replace with a unique server name
          action: upsert
        # Strip prometheus receiver auto-labels — absent from nginxreceiver output
        - key: service.name
          action: delete
        - key: service.instance.id
          action: delete
        - key: net.host.name
          action: delete
        - key: net.host.port
          action: delete
        - key: server.address
          action: delete
        - key: server.port
          action: delete
  
    # Rename prometheus metric names to nginxreceiver schema names
    metricstransform/nginx_prom:
      transforms:
        - include: nginx_http_requests_total
          action: update
          new_name: nginx.requests
        - include: nginx_connections_accepted
          action: update
          new_name: nginx.connections_accepted
        - include: nginx_connections_handled
          action: update
          new_name: nginx.connections_handled
        - include: ^nginx_connections_(?P<state>active|reading|writing|waiting)$
          match_type: regexp
          action: combine
          new_name: nginx.connections_current
  
    # Keep only the 4 renamed nginx.* metrics
    filter/nginx_prom_only:
      metrics:
        include:
          match_type: regexp
          metric_names:
            - ^nginx\..*
  
    transform/nginx_metrics_prom:
      metric_statements:
        - context: resource
          statements:
            - set(attributes["nginx.display.name"], Concat(["server", attributes["nginx.deployment.name"]], ":"))
  
    transform/metadata_nullify_prom:
      metric_statements:
        - context: metric
          statements:
            - set(description, "")
            - set(unit, "")
  
    batch/nginx_prom:
      timeout: 30s
      send_batch_size: 1024
  
  exporters:
    otlphttp/nginx_prom:
      endpoint: ${env:OTEL_EXPORTER_OTLP_ENDPOINT}
      headers:
        api-key: ${env:NEW_RELIC_LICENSE_KEY}
  
  service:
    pipelines:
      metrics/nginx_prometheus:
        receivers: [prometheus/nginx]
        processors:
          - resourcedetection/prom
          - resource/nginx_prom
          - metricstransform/nginx_prom
          - filter/nginx_prom_only
          - transform/nginx_metrics_prom
          - transform/metadata_nullify_prom
          - batch/nginx_prom
        exporters: [otlphttp/nginx_prom]

  카피

  구성 매개변수

  매개변수	설명
  <YOUR_STUB_STATUS_ENDPOINT>	NGINX stub status URL(예: http://127.0.0.1:8080/nginx_status ). nginx.server.endpoint 리소스 속성으로 사용됩니다.
  <DEPLOYMENT_NAME>	이 NGINX 서버의 고유한 이름(예: production-web-01 ). 뉴렐릭 대시보드에 표시됩니다.
  targets	nginx-prometheus-exporter의 주소(기본값 localhost:9113 ). 다른 호스트나 포트에서 실행 중인 경우 업데이트하세요.
  scrape_interval	익스포터에서 메트릭을 스크랩하는 빈도입니다. 기본값: 30s .

필요한 환경 변수를 주입하려면 systemd 재정의를 생성하십시오. <collector-service> 을(를) 수집기 서비스 이름(nrdot-collector 또는 otelcol-contrib)(으)로 바꿉니다:

$
sudo mkdir -p /etc/systemd/system/<collector-service>.service.d

/etc/systemd/system/<collector-service>.service.d/environment.conf 파일을 생성합니다:

[Service]
Environment="OTEL_EXPORTER_OTLP_ENDPOINT=https://otlp.nr-data.net:4318"
Environment="NEW_RELIC_LICENSE_KEY=YOUR_NEW_RELIC_LICENSE_KEY"

YOUR_NEW_RELIC_LICENSE_KEY 라이선스 키로 바꾸세요.

설정을 적용하고 수집기를 다시 시작합니다. <collector-service> 을 nrdot-collector 또는 otelcol-contrib로 바꿉니다:

$
sudo systemctl daemon-reload
$
sudo systemctl restart <collector-service>.service

서비스가 실행 중인지 확인하십시오.

$
sudo systemctl status <collector-service>.service
$
sudo journalctl -u <collector-service>.service -n 20

예상 출력: 오류 없는 Active: active (running).

몇 분 후, 이 NRQL 쿼리를 실행하여 데이터가 흐르고 있는지 확인합니다. <DEPLOYMENT_NAME> 을 설정에서 지정한 값으로 바꿉니다:

FROM Metric SELECT *
WHERE metricName LIKE 'nginx.%'
  AND nginx.deployment.name = '<DEPLOYMENT_NAME>'
SINCE 10 minutes ago

뉴렐릭에 초기 데이터가 나타날 때까지 기다린 후 NGINX에 접속하여 데이터 수집을 확인하십시오.