BPA用户指南分布式跟踪框架v5.1

• 简介
  • 齐普金
  • @opentelemetry/api
• 关键组件
• 先决条件
  • 网络要求
• Docker完成部署
  • 启用监控配置文件
  • 检验Zipkin容器
• 在服务中启用跟踪
  • 配置加载层次结构
    • Pod特定配置
      • 使用案例
      • 示例 情景
    • 全局配置
      • 使用案例
      • 示例 情景
    • 回退配置
      • 使用案例
  • 设置跟踪配置
    • 配置属性
  • 应用配置更改
    • Helm升级命令
• Kubernetes和Helm部署
  • 在值中启用监控
  • 部署Zipkin服务
  • 验证部署
  • 检查服务状态
• 访问和监控
  • 1节点访问ZipKin控制面板
  • 3节点Kubernetes访问Zipkin控制面板
  • 使用Zipkin UI
• Tracers和Span

简介

齐普金

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节点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”文件支持灵活的跟踪配置。系统实施具有三(3)个优先级的分层配置加载机制，以适应不同的部署方案。

配置加载层次结构

应用程序根据优先级按以下顺序加载跟踪配置：

Pod特定配置

路径:bpa-helm-chart/charts/<service name>/public_conf

使用案例

• 单个特定于Pod的跟踪配置
• 允许为特定服务或Pod设置不同的跟踪设置
• 需要手动放置:用户必须手动将此文件放在Pod的文件夹路径中：bpa-helm-chart/charts/<service name>/public_conf

示例 情景

• 仅对关键服务启用详细跟踪
• 不同微服务的不同采样率
• 用于故障排除Pod的调试特定跟踪

全局配置

路径:bpa-helm-chart/bpa/conf/common/globals/tracingConfig.json

使用案例

• 所有容器和Pod的全局跟踪配置
• 集中跟踪管理
• 全球影响:对此文件的更改会影响部署中的所有Pod

示例 情景

• 在整个BPA部署中启用和禁用跟踪
• 为生产环境设置统一的跟踪策略
• 集中式合规性和监控要求

回退配置

路径：../conf/tracingConfig.json（回退）

使用案例

• 与应用程序捆绑的默认跟踪配置
• 开发环境默认值
• 确保应用程序不会因缺少跟踪配置而失败

如果任何配置文件的格式不正确或不可读，系统：

• 记录错误
• 默认为{enable:false}以防止跟踪失败
• 继续启动应用程序

设置跟踪配置

创建或更新“tracingConfig.json”文件，在Pod的文件夹路径中包含以下内容：

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

示例：

• 要启用跟踪

  {
  
          "enable": true
  
      }

• 要禁用跟踪，请执行以下操作：

  {
  
        "enable": false
  
      }

配置属性

• enable（布尔值）（必需）：控制是启用还是禁用应用程序的跟踪
• 正确:启用分布式跟踪
  • 应用程序初始化跟踪帮助程序
  • 跟踪被收集并发送到已配置后端
  • 性能监控和调试功能已激活
• 假:禁用分布式跟踪
  • 应用程序性能无跟踪开销
  • 无跟踪数据收集或传输
  • 应用程序在不跟踪检测的情况下运行

应用配置更改

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部署

在值中启用监控

在以下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://<SERVER IP>:9412/zipkin/

3节点Kubernetes访问Zipkin控制面板

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

使用Zipkin UI

Zipkin控制面板提供用于搜索和直观显示跟踪的UI。关键组件包括：

• 服务名称下拉列表：按服务名称过滤跟踪

服务名称

• 时间范围选择器:定义跟踪搜索的时间窗口

• 跟踪列表:显示与搜索条件匹配的跟踪列表

• 跟踪时间线:跟踪内时间间隔（即，跨度）的可视表示

• Span详细信息:每个跨段的详细视图，包括持续时间、标记和日志。

Tracers和Span

跟踪器负责创建和管理跨区。跟踪器与特定的服务或应用组件相关联。跨度表示跟踪中的单个工作单位或操作。每个跨包含操作名称、开始和结束时间、属性以及与其他跨的父子关系等信息。