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 모니터링을 위해 세 가지 주요 구성 요소를 사용합니다.

• 수신기 - NGINX 스텁 상태 엔드포인트에 연결하여 메트릭을 수집합니다.
• 프로세서 - 효율적인 전송을 위해 서버 식별 및 배치 메트릭을 추가합니다.
• 수출업체 - 처리된 제품을 OTLP HTTP를 통해 뉴렐릭 계정으로 전송하세요

설정을 수정하기 전에 두 가지 핵심 정보가 필요합니다.

1. 스텁 상태 URL - 1단계에서 가져온 URL (기본값: http://127.0.0.1:8080/nginx_status)

2. 고유한 구현, 배포 이름 - 이 특정 NGINX 서버를 식별하는 이름을 선택하십시오(예: production-web-01, staging-api, prod-lb-01).

   구현, 배포 이름은 뉴렐릭 대시보드에 표시되며 여러 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. 뉴렐릭 익스포터를 구성합니다.

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: 1단계의 스텁 상태 설정과 일치하도록 http://127.0.0.1:8080/nginx_status 변경합니다.

2. 구현, 배포 이름: production-web-01 이 NGINX 서버에 대한 고유한 개체로 대체합니다.

   좋은 구현, 배포 이름 선택:

• production-web-01, staging-api 또는 같은 기술 이름을 사용하세요. prod-lb-01
• 뉴렐릭 계정 내의 모든 NGINX 서버에서 고유해야 합니다.
• 이 이름은 대시보드에 표시되어 특정 서버를 식별하는 데 도움이 됩니다.
• 필터링 및 알림 기능을 쉽게 활용하려면 간결하면서도 의미 있는 내용을 작성하세요.

인증을 구성하기 전에 다음 두 가지 정보를 수집하십시오.

1. **라이선스 키:**

   • one.newrelic.com → API Keys이동하세요.
   • "Ingest - License " [수집 - 라이선스] 섹션을 찾은 다음 Show key [키 표시]를클릭합니다.
   • 라이선스 키("NRAK-..."로 시작)를 복사하세요.

2. ** OTLP 엔드포인트:** 귀하의 뉴렐릭 지역에 적합한 엔드포인트를 사용하세요. 해당 지역에 대해 지원되는 엔드포인트 및 포트의 전체 목록은 엔드포인트, 포트 및 프로토콜 구성을 참조하세요. 예를 들어:

   • 미국 지역: 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" - 뉴렐릭에게 성공적으로 전송되었습니다

4. 테스트 트래픽 생성(생성하기 위해):

   bash

   카피

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

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

먼저, 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...
}

변경 사항을 적용하려면 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 조각포인트 및 뉴렐릭 OTLP 조각포인트를 확인하세요.
• 누락된 구성 요소 설정 - 서비스 파이프라인 섹션에 참조된 모든 수신자, 처리자 및 수출자가 위의 각 설정 섹션에 실제로 정의되어 있는지 확인하십시오.

수정 후 재시작:

$
sudo systemctl restart otelcol-contrib.service

단계별 진단:

1. NGINX 스텁 상태가 제대로 작동하는지 확인하십시오.

   bash

   카피

   $
   curl http://127.0.0.1:8080/nginx_status

   연결 통계를 반환해야 합니다.

2. Check 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

   카피

뉴렐릭에 로그인이 표시되지 않습니다:

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

일반적인 문제점:

• 파일 권한 오류 - 수집기를 adm 그룹에 추가하세요: sudo usermod -a -G adm otelcol-contrib
• 잘못된 파일 경로 - 구성 파일에서 로그 파일 위치를 확인하세요