BPA使用手冊分散式跟蹤框架v5.1

• 簡介
  • 齊普金
  • @opentelemetry/api
• 關鍵元件
• 必要條件
  • 網路要求
• Docker合成部署
  • 啟用監控配置檔案
  • 檢驗Zipkin容器
• 在服務中啟用跟蹤
  • 配置載入層次結構
    • Pod特定配置
      • 使用案例
      • 範例案例
    • 全域性配置
      • 使用案例
      • 範例案例
    • 回退配置
      • 使用案例
  • 設定跟蹤配置
    • 配置屬性
  • 應用配置更改
    • Helm升級命令
• Kubernetes和赫爾姆部署
  • 啟用值中的監視
  • 部署Zipkin服務
  • 驗證部署
  • 檢查服務狀態
• 存取和監控
  • 1節點訪問Zipkin控制面板
  • 3節點Kubernetes對Zipkin控制面板的訪問
  • 使用Zipkin UI
• 跟蹤器和跨距

簡介

齊普金

Zipkin是一個分散式跟蹤系統，可幫助收集解決服務架構中的延遲問題所需的定時資料。本指南提供有關部署Zipkin和啟用跨BPA平台服務的跟蹤的說明。

@opentelemetry/api

@opentelemetry/api包是Node.js中OpenTelemetry的核心API。它提供用於建立和管理跟蹤、跨度和上下文傳播的介面和類。此軟體包允許開發人員使用他們的應用程式來收集跟蹤和度量等遙測資料，然後將這些遙測資料匯出到Zipkin等後端進行分析。

關鍵元件

Zipkin的關鍵元件包括：

• Zipkin伺服器:中央跟蹤收集器和使用者介面(UI)
• OpenTelemetry:用於跟蹤的檢測庫
• Elasticsearch:跟蹤資料的儲存後端
• 安全套接字層(SSL)和傳輸層安全(TLS):提供安全通訊

必要條件

網路要求

要部署Zipkin並啟用跟蹤，需要滿足以下網路要求：

• 埠9412:Zipkin超文字傳輸通訊協定安全(HTTPS)API端點
• 埠9411:Zipkin超文本傳輸協定(HTTP)管理終結點
• 埠9200:訪問Elasticsearch群集

Docker合成部署

啟用監控配置檔案

1. 從以下路徑啟動BPA 1節點塢站：

   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」檔案支援靈活的跟蹤配置。該系統實施具有三(3)個優先順序的分級配置載入機制，以適應不同的部署方案。

配置載入層次結構

應用程式根據優先順序按以下順序載入跟蹤配置：

Pod特定配置

路徑：bpa-helm-chart/charts/<service name>/public_conf

使用案例

• 單個特定於Pod的跟蹤配置
• 允許為特定服務或Pod設定不同的跟蹤設定
• 需要手動放置:使用者必須手動將此檔案放在Pod的資料夾路徑中：bpa-helm-chart/charts/<service name>/public_conf

範例案例

• 僅對關鍵服務啟用詳細跟蹤
• 不同微服務的不同取樣率
• 針對故障檢修池的調試特定跟蹤

全域性配置

路徑：bpa-helm-chart/bpa/conf/common/globals/tracingConfig.json

使用案例

• 所有容器和容器的全域性跟蹤配置
• 集中跟蹤管理
• 全球影響:對此檔案的更改會影響部署中的所有Pod

範例案例

• 在整個BPA部署中啟用和禁用跟蹤
• 為生產環境設定統一的跟蹤策略
• 集中化的法規遵從性和監控要求

回退配置

路徑：../conf/tracingConfig.json（後援）

使用案例

• 與應用程式捆綁的預設跟蹤配置
• 開發環境預設值
• 確保應用程式永遠不會由於缺少跟蹤配置而失敗

如果任何配置檔案的格式錯誤或無法讀取，系統：

• 記錄錯誤
• 預設為{enable:false}可防止跟蹤失敗
• 繼續啟動應用程式

設定跟蹤配置

建立或更新「tracingConfig.json」檔案，該檔案在Pod的資料夾路徑中包含以下內容：

bpa-helm-chart/charts/<service name>/public_conf/

範例:

• 啟用跟蹤

  {
  
          "enable": true
  
      }

• 要禁用跟蹤，請執行以下操作：

  {
  
        "enable": false
  
      }

配置屬性

• enable（布林型）（必需）：控制是啟用還是禁用應用程式的跟蹤
• true:啟用分散式跟蹤
  • 應用程式初始化跟蹤幫助程式
  • 將收集跟蹤並將其傳送到已配置的後端
  • 已啟用效能監控和調試功能
• false:禁用分散式跟蹤
  • 應用程式效能無跟蹤開銷
  • 無跟蹤資料收集或傳輸
  • 應用程式在不跟蹤檢測的情況下運行

應用配置更改

Helm升級命令

將「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圖表路徑中，編輯「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

檢查服務狀態

要檢視Pod日誌，請使用以下命令：

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

要檢查服務端點，請使用以下命令：

kubectl describe svc tracers-zipkin -n bpa-ns

存取和監控

1節點訪問Zipkin控制面板

URL：https://<伺服器IP>:9412/zipkin/

3節點Kubernetes對Zipkin控制面板的訪問

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

使用Zipkin UI

Zipkin儀表板提供了一個用於搜尋和視覺化跟蹤的UI。關鍵元件包括：

• 服務名稱下拉列表：按服務名稱過濾跟蹤

服務名稱

• 時間範圍選擇器:定義跟蹤搜尋的時間視窗

• 跟蹤清單:顯示與搜尋條件匹配的跟蹤清單

• 跟蹤時間線:跟蹤內時間間隔（即span）的可視表示

• Span詳細資訊：每個跨度的詳細檢視，包括持續時間、標籤和日誌。

跟蹤器和跨距

跟蹤器負責建立和管理跨區。跟蹤程式與特定的服務或應用元件相關聯。跨度表示跟蹤內的單個工作單位或操作。每個跨包含操作名稱、開始和結束時間、屬性以及與其他跨的父子關係等資訊。