BPA 사용 설명서 Distributed Tracing Framework v5.1

• 소개
  • 지프킨
  • @opentelemetry/api
• 주요 구성 요소
• 사전 요구 사항
  • 네트워크 요구 사항
• Docker가 구축 구성
  • 모니터링 프로파일 활성화
  • Zipkin 컨테이너 확인
• 서비스에서 추적 사용
  • 구성 로드 계층
    • Pod 관련 컨피그레이션
      • 사용 사례
      • 예제 시나리오
    • 전역 컨피그레이션
      • 사용 사례
      • 예제 시나리오
    • 폴백 컨피그레이션
      • 사용 사례
  • 추적 구성 설정
    • 구성 속성
  • 구성 변경 사항 적용
    • Helm Upgrade 명령
• Kubernetes 및 Helm 구축
  • 값에서 모니터링 활성화
  • Zipkin 서비스 구축
  • 구축 확인
  • 서비스 상태 확인
• 액세스 및 모니터링
  • Zipkin 대시보드에 대한 1노드 액세스
  • Zipkin Dashboard에 대한 3노드 Kubernetes 액세스
  • Zipkin UI 사용
• 트레이서 및 스팬

소개

지프킨

Zipkin은 서비스 아키텍처의 지연 시간 문제를 해결하는 데 필요한 타이밍 데이터를 수집하는 데 도움이 되는 분산 추적 시스템입니다. 이 가이드에서는 BPA 플랫폼 서비스 전반에 걸쳐 Zipkin을 구축하고 추적을 활성화하는 방법을 제공합니다.

@opentelemetry/api

@opentelemetry/api 패키지는 Node.js에서 OpenTelemetry를 위한 핵심 API입니다. 추적, 스팬 및 컨텍스트 전파를 생성하고 관리하기 위한 인터페이스와 클래스를 제공합니다. 개발자는 이 패키지를 사용하여 추적 및 메트릭과 같은 텔레메트리 데이터를 수집한 다음 분석을 위해 Zipcin과 같은 백엔드로 내보낼 수 있는 애플리케이션을 개발할 수 있습니다.

주요 구성 요소

Zipkin의 주요 구성 요소는 다음과 같습니다.

• Zipcin 서버: 중앙 추적 컬렉터 및 사용자 인터페이스(UI)
• OpenTelemetry: 추적을 위한 계측 라이브러리
• Elasticsearch: 추적 데이터를 위한 저장소 백 엔드
• SSL(Secure Sockets Layer) 및 TLS(Transport Layer Security): 안전한 통신 제공

사전 요구 사항

네트워크 요구 사항

Zipkin을 구축하고 추적을 활성화하려면 다음 네트워크 요구 사항이 필요합니다.

• 포트 9412: HTTPS(Hypertext Transfer Protocol Secure) API 엔드포인트
• 포트 9411: HTTP(Hypertext Transfer Protocol) 관리 엔드포인트
• 포트 9200: Elasticsearch 클러스터에 액세스

Docker가 구축 구성

모니터링 프로파일 활성화

1. 다음 경로에서 BPA 1-node docker를 시작합니다.

   cd /opt/bpa/bpa-{build_version}/scripts

2. 다음 명령을 사용하여 모니터링 옵션으로 bash 스크립트를 실행합니다.

   ./startbpa.1node.sh monitoring

Zipkin 컨테이너 확인

1. 컨테이너 상태를 확인하려면 다음 명령을 실행합니다.

   docker ps | grep tracers-zipkin

2. Zipkin 컨테이너의 로그를 봅니다. 다음 명령을 실행합니다.

   docker logs tracers-zipkin -f

서비스에서 추적 사용

BPA 애플리케이션은 "tracingConfig.json" 파일을 통해 유연한 추적 컨피그레이션을 지원합니다. 시스템은 서로 다른 구축 시나리오를 수용하기 위해 세 가지 우선 순위 레벨의 계층적 컨피그레이션 로딩 메커니즘을 구현합니다.

구성 로드 계층

우선 순위에 따라 다음 순서로 추적 컨피그레이션이 로드됩니다.

Pod 관련 컨피그레이션

경로: bpa-helm-chart/charts/<서비스 이름>/public_conf

사용 사례

• 포드별 개별 추적 컨피그레이션
• 특정 서비스 또는 포드에 대해 서로 다른 추적 설정을 허용합니다.
• 수동 배치 필요: 사용자는 Pod의 폴더 경로에 이 파일을 수동으로 배치해야 합니다. bpa-helm-chart/charts/<서비스 이름>/public_conf

예제 시나리오

• 중요 서비스에 대해서만 자세한 추적 사용
• 마이크로서비스마다 다른 샘플링 속도
• 트러블슈팅 포드에 대한 디버그 전용 추적

전역 컨피그레이션

경로: bpa-helm-chart/bpa/conf/common/globals/tracingConfig.json을 참조하십시오.

사용 사례

• 모든 컨테이너 및 포드에 대한 전역 추적 컨피그레이션
• 중앙 추적 관리
• 글로벌 영향: 이 파일의 변경 사항은 구축의 모든 포드에 영향을 미침

예제 시나리오

• 전체 BPA 구축 전반에 걸쳐 추적 활성화 및 비활성화
• 프로덕션 환경에 대한 균일한 추적 정책 설정
• 중앙 집중식 규정 준수 및 모니터링 요구 사항

폴백 컨피그레이션

경로: ../conf/tracingConfig.json(대체)

사용 사례

• 응용 프로그램과 함께 번들로 제공되는 기본 추적 구성
• 개발 환경 기본값
• 추적 컨피그레이션이 누락되어 응용 프로그램이 실패하지 않도록 합니다.

컨피그레이션 파일의 형식이 잘못되었거나 읽을 수 없는 경우, 시스템은 다음을 수행합니다.

• 오류를 기록합니다.
• 기본값은 {enable: false} - 추적 실패 방지
• 응용 프로그램 시작 계속

추적 구성 설정

Pod의 폴더 경로에 다음 콘텐츠가 포함된 "tracingConfig.json" 파일을 만들거나 업데이트합니다.

bpa-helm-chart/charts/<서비스 이름>/public_conf/

예:

• 추적을 사용하려면

  {
  
          "enable": true
  
      }

• 추적을 비활성화하려면

  {
  
        "enable": false
  
      }

구성 속성

• enable(부울)(필수): 응용 프로그램에 대해 추적을 사용할지 여부를 제어합니다.
• 참: 분산 추적 사용
  • 응용 프로그램이 추적 도우미를 초기화합니다.
  • 추적이 수집되어 구성된 백엔드로 전송됩니다.
  • 성능 모니터링 및 디버깅 기능 활성화
• 거짓: 분산 추적 비활성화
  • 애플리케이션 성능에 대한 추적 오버헤드 없음
  • 추적 데이터 수집 또는 전송 없음
  • 추적 계측 없이 응용 프로그램 실행

구성 변경 사항 적용

Helm Upgrade 명령

"tracingConfig.json" 파일을 적절한 위치에 배치한 후 Helm upgrade 명령을 사용하여 변경 사항을 적용합니다.

helm upgrade bpa-rel --namespace bpa-ns /opt/bpa-helm-chart

명령 분석:

• helm 업그레이드: 기존 Helm 릴리스 업데이트
• bpa-rel: BPA Helm 릴리스의 이름
• —네임스페이스 bpa-ns: BPA가 배포되는 Kubernetes 네임스페이스를 지정합니다
• /opt/bpa-helm-chart: BPA Helm 차트 디렉토리 경로

Kubernetes 및 Helm 구축

값에서 모니터링 활성화

다음 Helm 차트 경로에서 모니터링을 활성화하려면 "values.yaml" 파일의 Helm 값을 편집합니다.

yaml
  global:
  enableMonitoring: true

Zipkin 서비스 구축

다음 Helm 명령을 사용하여 Zipkin 서비스를 구축합니다.

helm install bpa-rel --create-namespace --namespace bpa-ns 

구축 확인

다음 명령을 사용하여 구축을 확인합니다.

kubectl get pods -n bpa-ns | grep tracers-zipkin
kubectl get svc -n bpa-ns | grep tracers-zipkin

서비스 상태 확인

포드 로그를 보려면 다음 명령을 사용합니다.

kubectl logs -n bpa-ns deployment/tracers-zipkin -f

서비스 엔드포인트를 확인하려면 다음 명령을 사용합니다.

kubectl describe svc tracers-zipkin -n bpa-ns

액세스 및 모니터링

Zipkin 대시보드에 대한 1노드 액세스

URL: https://<서버 IP>:9412/zipkin/

Zipkin Dashboard에 대한 3노드 Kubernetes 액세스

URL: https://<cluster-ip>:30900/zipkin/

Zipkin UI 사용

Zipkin 대시보드에서는 추적을 검색하고 시각화할 수 있는 UI를 제공합니다. 주요 구성 요소는 다음과 같습니다.

• 서비스 이름 드롭다운: 서비스 이름으로 추적 필터링

서비스 이름

• 시간 범위 선택기: 추적 검색의 시간 창을 정의합니다.

• 추적 목록: 검색 조건과 일치하는 추적 목록을 표시합니다.

• 추적 타임라인: 추적 내의 시간 간격(예: 범위)을 시각적으로 표시

• 범위 세부사항: 기간, 태그 및 로그를 포함하여 각 범위에 대한 자세한 보기

트레이서 및 스팬

트레이서는 스팬을 만들고 관리하는 업무를 담당합니다. 추적기는 특정 서비스 또는 애플리케이션 구성 요소와 연결됩니다. 스팬은 추적 내에서 작업 또는 작업의 단일 단위를 나타냅니다. 각 스팬에는 작업 이름, 시작 및 종료 시간, 속성, 다른 스팬과의 상위-하위 관계 등의 정보가 포함됩니다.