Opentracing Uber Jaeger 全链路灰度调用链，Nepxion Discovery

2024-05-13 00:58
文章标签 调用 链路 灰度 discovery uber jaeger opentracing nepxion

本文主要是介绍Opentracing Uber Jaeger 全链路灰度调用链，Nepxion Discovery，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

当网关和服务在实施全链路分布式灰度发布和路由时候，我们需要一款追踪系统来监控网关和服务走的是哪个灰度组，哪个灰度版本，哪个灰度区域，甚至监控从Http Header头部全程传递的灰度规则和路由策略。这个功能意义在于：

  • 不仅可以监控全链路中基本的调用信息，也可以监控额外的灰度信息，有助于我们判断灰度发布和路由是否执行准确，一旦有问题，也可以快速定位
  • 可以监控流量何时切换到新版本，或者新的区域，或者新的机器上
  • 可以监控灰度规则和路由策略是否配置准确
  • 可以监控网关和服务灰度上下级树状关系
  • 可以监控全链路流量拓扑图

笔者尝试调研了一系列分布式追踪系统和中间件，包括Opentracing、Uber Jaeger、Twitter Zipkin、Apache Skywalking、Pinpoint、CAT等，最后决定采用Opentracing Uber Jaeger方式来实现，重要原因除了易用性和可扩展性外，Opentracing支持WebMvc和WebFlux两种方式，业界的追踪系统能支持WebFlux相对较少

[**OpenTracing**] OpenTracing已进入CNCF，正在为全球的分布式追踪系统提供统一的概念、规范、架构和数据标准。它通过提供平台无关、厂商无关的API，使得开发人员能够方便的添加（或更换）追踪系统的实现。对于存在多样化的技术栈共存的调用链中，Opentracing适配Java、C、Go和.Net等技术栈，实现全链路分布式追踪功能。迄今为止，Uber Jaeger、Twitter Zipkin和Apache Skywalking已经适配了Opentracing规范

笔者以Nepxion社区的Discovery开源框架（对该开源框架感兴趣的同学，请访问如下链接）为例子展开整合

源码主页，请访问https://github.com/Nepxion/Discovery

指南主页，请访问https://github.com/Nepxion/DiscoveryGuide

文档主页，请访问https://pan.baidu.com/s/1i57rXaNKPuhGRqZ2MONZOA#list/path=/Nepxion

整合的效果图

Alt textAlt textAlt textAlt textAlt text

基本概念

灰度调用链主要包括如下11个参数。使用者可以自行定义要传递的调用链参数，例如：traceId, spanId等；也可以自行定义要传递的业务调用链参数，例如：mobile, user等

1. n-d-service-group - 服务所属组或者应用
2. n-d-service-type - 服务类型，分为“网关”和“服务”
3. n-d-service-id - 服务ID
4. n-d-service-address - 服务地址，包括Host和Port
5. n-d-service-version - 服务版本
6. n-d-service-region - 服务所属区域
7. n-d-version - 版本路由值
8. n-d-region - 区域路由值
9. n-d-address - 地址路由值
10. n-d-version-weight - 版本权重路由值
11. n-d-region-weight - 区域权重路由值

核心实现

Opentracing通用模块

源码参考https://github.com/Nepxion/Discovery/tree/master/discovery-plugin-strategy-opentracing

由于OpenTracing扩展需要兼顾到Spring Cloud Gateway、Zuul和服务，它的核心逻辑存在着一定的可封装性，所以笔者抽取出一个公共模块discovery-plugin-strategy-opentracing，包含configuration、operation、context等模块，着重阐述operation模块，其它比较简单，不一一赘述了

在阐述前，笔者需要解释一个配置，该配置将决定核心实现以及终端界面的显示

  1. 如果开启，灰度信息输出到独立的Span节点中，意味着在界面显示中，灰度信息通过独立的GRAY Span节点来显示。优点是信息简洁明了，缺点是Span节点会增长一倍。我们可以称呼它为【模式A】
  2. 如果关闭，灰度信息输出到原生的Span节点中，意味着在界面显示中，灰度信息会和原生Span节点的调用信息、协议信息等混在一起，缺点是信息庞杂混合，优点是Span节点数不会增长。我们可以称呼它为【模式B】 
# 启动和关闭调用链的灰度信息在Opentracing中以独立的Span节点输出，如果关闭，则灰度信息输出到原生的Span节点中。缺失则默认为true
spring.application.strategy.trace.opentracing.separate.span.enabled=true

Opentracing公共操作类 - StrategyOpentracingOperation.java

  • 装配注入Opentracing的Tracer对象
  • opentracingInitialize方法，提供给网关和服务的Span节点初始化
    • 【模式A】下，tracer.buildSpan(...).start()实现新建一个Span，并把它放置到存储上下文的StrategyOpentracingContext的ThreadLocal里
    • 【模式B】下，不需要做任何工作
  • opentracingHeader方法，提供给网关的灰度调用链输出
    • 【模式A】下，首先从StrategyOpentracingContext的ThreadLocal里获取Span对象，其次把customizationMap（自定义的调用链参数）的元素都放入到Tag中，最后把灰度调用链主11个参数（通过strategyContextHolder.getHeader(...)获取）和更多上下文信息放入到Tag中
    • 【模式B】下，跟【模式A】类似，唯一区别的是Tags.COMPONENT的处理，由于原生的Span节点已经带有该信息，所以不需要放入到Tag中
  • opentracingLocal方法，提供给服务的灰度调用链输出
    • 【模式A】下，首先从StrategyOpentracingContext的ThreadLocal里获取Span对象，其次把customizationMap（自定义的调用链参数）的元素都放入到Tag中，最后把灰度调用链主11个参数（通过pluginAdapter.getXXX()获取）和更多上下文信息放入到Tag中
    • 【模式B】下，跟【模式A】类似，唯一区别的是Tags.COMPONENT的处理，由于原生的Span节点已经带有该信息，所以不需要放入到Tag中
  • opentracingError方法，提供给服务的灰度调用链异常输出
    • 【模式A】下，首先从StrategyOpentracingContext的ThreadLocal里获取Span对象，其次span.log(...)方法实现异常输出
    • 【模式B】下，不需要做任何工作
  • opentracingClear方法，灰度调用链的Span上报和清除
    • 【模式A】下，首先从StrategyOpentracingContext的ThreadLocal里获取Span对象，其次span.finish()方法实现Span上报，最后StrategyOpentracingContext.clearCurrentContext()方法实现Span清除
    • 【模式B】下，不需要做任何工作
  • getCurrentSpan方法
    • 【模式A】下，返回StrategyOpentracingContext.getCurrentContext().getSpan()，即opentracingInitialize新建的Span对象
    • 【模式B】下，返回tracer.activeSpan()，即原生的Span对象 
public class StrategyOpentracingOperation {private static final Logger LOG = LoggerFactory.getLogger(StrategyOpentracingOperation.class);@Autowiredprotected PluginAdapter pluginAdapter;@Autowiredprotected StrategyContextHolder strategyContextHolder;@Autowiredprivate Tracer tracer;@Value("${"   StrategyOpentracingConstant.SPRING_APPLICATION_STRATEGY_TRACE_OPENTRACING_ENABLED   ":false}")protected Boolean traceOpentracingEnabled;@Value("${"   StrategyOpentracingConstant.SPRING_APPLICATION_STRATEGY_TRACE_OPENTRACING_SEPARATE_SPAN_ENABLED   ":true}")protected Boolean traceOpentracingSeparateSpanEnabled;public void opentracingInitialize() {if (!traceOpentracingEnabled) {return;}if (!traceOpentracingSeparateSpanEnabled) {return;}Span span = tracer.buildSpan(DiscoveryConstant.SPAN_VALUE).start();StrategyOpentracingContext.getCurrentContext().setSpan(span);LOG.debug("Trace chain for Opentracing initialized...");}public void opentracingHeader(Map<String, String> customizationMap) {if (!traceOpentracingEnabled) {return;}Span span = getCurrentSpan();if (span == null) {LOG.error("Span not found in context to opentracing header");return;}if (MapUtils.isNotEmpty(customizationMap)) {for (Map.Entry<String, String> entry : customizationMap.entrySet()) {span.setTag(entry.getKey(), entry.getValue());}}if (traceOpentracingSeparateSpanEnabled) {span.setTag(Tags.COMPONENT.getKey(), DiscoveryConstant.TAG_COMPONENT_VALUE);}span.setTag(DiscoveryConstant.PLUGIN, DiscoveryConstant.PLUGIN_VALUE);span.setTag(DiscoveryConstant.TRACE_ID, span.context().toTraceId());span.setTag(DiscoveryConstant.SPAN_ID, span.context().toSpanId());span.setTag(DiscoveryConstant.N_D_SERVICE_GROUP, strategyContextHolder.getHeader(DiscoveryConstant.N_D_SERVICE_GROUP));...String routeVersion = strategyContextHolder.getHeader(DiscoveryConstant.N_D_VERSION);if (StringUtils.isNotEmpty(routeVersion)) {span.setTag(DiscoveryConstant.N_D_VERSION, routeVersion);}...LOG.debug("Trace chain information outputs to Opentracing...");}public void opentracingLocal(String className, String methodName, Map<String, String> customizationMap) {if (!traceOpentracingEnabled) {return;}Span span = getCurrentSpan();if (span == null) {LOG.error("Span not found in context to opentracing local");return;}if (MapUtils.isNotEmpty(customizationMap)) {for (Map.Entry<String, String> entry : customizationMap.entrySet()) {span.setTag(entry.getKey(), entry.getValue());}}if (traceOpentracingSeparateSpanEnabled) {span.setTag(Tags.COMPONENT.getKey(), DiscoveryConstant.TAG_COMPONENT_VALUE);}span.setTag(DiscoveryConstant.PLUGIN, DiscoveryConstant.PLUGIN_VALUE);span.setTag(DiscoveryConstant.CLASS, className);span.setTag(DiscoveryConstant.METHOD, methodName);span.setTag(DiscoveryConstant.TRACE_ID, span.context().toTraceId());span.setTag(DiscoveryConstant.SPAN_ID, span.context().toSpanId());span.setTag(DiscoveryConstant.N_D_SERVICE_GROUP, pluginAdapter.getGroup());...String routeVersion = strategyContextHolder.getHeader(DiscoveryConstant.N_D_VERSION);if (StringUtils.isNotEmpty(routeVersion)) {span.setTag(DiscoveryConstant.N_D_VERSION, routeVersion);}...LOG.debug("Trace chain information outputs to Opentracing...");}public void opentracingError(String className, String methodName, Throwable e) {if (!traceOpentracingEnabled) {return;}if (!traceOpentracingSeparateSpanEnabled) {return;}Span span = getCurrentSpan();if (span == null) {LOG.error("Span not found in context to opentracing error");return;}span.log(new ImmutableMap.Builder<String, Object>().put(DiscoveryConstant.CLASS, className).put(DiscoveryConstant.METHOD, methodName).put(DiscoveryConstant.EVENT, Tags.ERROR.getKey()).put(DiscoveryConstant.ERROR_OBJECT, e).build());LOG.debug("Trace chain error outputs to Opentracing...");}public void opentracingClear() {if (!traceOpentracingEnabled) {return;}if (!traceOpentracingSeparateSpanEnabled) {return;}Span span = getCurrentSpan();if (span != null) {span.finish();} else {LOG.error("Span not found in context to opentracing clear");}StrategyOpentracingContext.clearCurrentContext();LOG.debug("Trace chain context of Opentracing cleared...");}public Span getCurrentSpan() {return traceOpentracingSeparateSpanEnabled ? StrategyOpentracingContext.getCurrentContext().getSpan() : tracer.activeSpan();}public String getTraceId() {if (!traceOpentracingEnabled) {return null;}Span span = getCurrentSpan();if (span != null) {return span.context().toTraceId();}return null;}public String getSpanId() {if (!traceOpentracingEnabled) {return null;}Span span = getCurrentSpan();if (span != null) {return span.context().toSpanId();}return null;}
}

Opentracing Service模块

源码参考https://github.com/Nepxion/Discovery/tree/master/discovery-plugin-strategy-starter-service-opentracing

实现OpenTracing对服务的扩展，包含configuration、tracer等模块，着重阐述tracer模块，其它比较简单，不一一赘述了

Opentracing的服务追踪类 - DefaultServiceStrategyOpentracingTracer.java

  • 继承DefaultServiceStrategyTracer，并注入StrategyOpentracingOperation
  • trace方法里先执行opentracingInitialize初始化Span，这样可以让后面的逻辑都可以从Span中拿到traceId和spanId，执行opentracingLocal实现服务的灰度调用链输出
  • error方法里执行opentracingError实现服务的灰度调用链异常输出
  • release方法里执行opentracingClear实现灰度调用链的Span上报和清除 
public class DefaultServiceStrategyOpentracingTracer extends DefaultServiceStrategyTracer {@Autowiredprivate StrategyOpentracingOperation strategyOpentracingOperation;@Overridepublic void trace(ServiceStrategyTracerInterceptor interceptor, MethodInvocation invocation) {strategyOpentracingOperation.opentracingInitialize();super.trace(interceptor, invocation);strategyOpentracingOperation.opentracingLocal(interceptor.getMethod(invocation).getDeclaringClass().getName(), interceptor.getMethodName(invocation), getCustomizationMap());}@Overridepublic void error(ServiceStrategyTracerInterceptor interceptor, MethodInvocation invocation, Throwable e) {super.error(interceptor, invocation, e);strategyOpentracingOperation.opentracingError(interceptor.getMethod(invocation).getDeclaringClass().getName(), interceptor.getMethodName(invocation), e);}@Overridepublic void release(ServiceStrategyTracerInterceptor interceptor, MethodInvocation invocation) {super.release(interceptor, invocation);strategyOpentracingOperation.opentracingClear();}@Overridepublic String getTraceId() {return strategyOpentracingOperation.getTraceId();}@Overridepublic String getSpanId() {return strategyOpentracingOperation.getSpanId();}
}

Opentracing Spring Cloud Gateway模块

源码参考https://github.com/Nepxion/Discovery/tree/master/discovery-plugin-strategy-starter-gateway-opentracing

实现OpenTracing对Spring Cloud Gateway的扩展，跟discovery-plugin-strategy-starter-service-opentracing模块类似，不一一赘述了

Opentracing Zuul模块

源码参考https://github.com/Nepxion/Discovery/tree/master/discovery-plugin-strategy-starter-zuul-opentracing

实现OpenTracing对Zuul的扩展，跟discovery-plugin-strategy-starter-service-opentracing模块类似，不一一赘述了

使用说明

示例参考https://github.com/Nepxion/DiscoveryGuide

使用方式

Opentracing输出方式以Uber Jaeger为例来说明，步骤非常简单

  1. 从https://pan.baidu.com/s/1i57rXaNKPuhGRqZ2MONZOA#list/path=/Nepxion获取Jaeger-1.14.0.zip，Windows操作系统下解压后运行jaeger.bat，Mac和Lunix操作系统请自行研究
  2. 执行Postman调用后，访问http://localhost:16686查看灰度调用链
  3. 灰度调用链支持WebMvc和WebFlux两种方式，以GRAY字样的标记来标识

开关控制

对于Opentracing调用链功能的开启和关闭，需要通过如下开关做控制：

# 启动和关闭调用链。缺失则默认为false
spring.application.strategy.trace.enabled=true
# 启动和关闭调用链的Opentracing输出，支持F版或更高版本的配置，其它版本不需要该行配置。缺失则默认为false
spring.application.strategy.trace.opentracing.enabled=true
# 启动和关闭调用链的灰度信息在Opentracing中以独立的Span节点输出，如果关闭，则灰度信息输出到原生的Span节点中。缺失则默认为true
spring.application.strategy.trace.opentracing.separate.span.enabled=true

可选功能

自定义调用链上下文参数的创建（该类不是必须的），继承DefaultStrategyTracerAdapter

// 自定义调用链上下文参数的创建
// 对于getTraceId和getSpanId方法，在Opentracing等调用链中间件引入的情况下，由调用链中间件决定，在这里定义不会起作用；在Opentracing等调用链中间件未引入的情况下，在这里定义才有效，下面代码中表示从Http Header中获取，并全链路传递
// 对于getCustomizationMap方法，表示输出到调用链中的定制化业务参数，可以同时输出到日志和Opentracing等调用链中间件，下面代码中表示从Http Header中获取，并全链路传递
public class MyStrategyTracerAdapter extends DefaultStrategyTracerAdapter {@Overridepublic String getTraceId() {return StringUtils.isNotEmpty(strategyContextHolder.getHeader(DiscoveryConstant.TRACE_ID)) ? strategyContextHolder.getHeader(DiscoveryConstant.TRACE_ID) : StringUtils.EMPTY;}@Overridepublic String getSpanId() {return StringUtils.isNotEmpty(strategyContextHolder.getHeader(DiscoveryConstant.SPAN_ID)) ? strategyContextHolder.getHeader(DiscoveryConstant.SPAN_ID) : StringUtils.EMPTY;}@Overridepublic Map<String, String> getCustomizationMap() {return new ImmutableMap.Builder<String, String>().put("mobile", StringUtils.isNotEmpty(strategyContextHolder.getHeader("mobile")) ? strategyContextHolder.getHeader("mobile") : StringUtils.EMPTY).put("user", StringUtils.isNotEmpty(strategyContextHolder.getHeader("user")) ? strategyContextHolder.getHeader("user") : StringUtils.EMPTY).build();}
}

在配置类里@Bean方式进行调用链类创建，覆盖框架内置的调用链类

@Bean
public StrategyTracerAdapter strategyTracerAdapter() {return new MyStrategyTracerAdapter();
}

本文作者

任浩军， 10 多年开源经历，Github ID：@HaojunRen，Nepxion 开源社区创始人，Nacos Group Member，Spring Cloud Alibaba & Nacos & Sentinel Committer

请联系我

微信、公众号和文档

Alt textAlt textAlt text

本文由博客一文多发平台 OpenWrite 发布！

这篇关于Opentracing Uber Jaeger 全链路灰度调用链，Nepxion Discovery的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/984240。

相关文章

如何在页面调用utility bar并传递参数至lwc组件

如何在页面调用utility bar并传递参数至lwc组件

1.在app的utility item中添加lwc组件： 2.调用utility bar api的方式有两种： 方法一，通过lwc调用： import {LightningElement,api ,wire } from 'lwc';import { publish, MessageContext } from 'lightning/messageService';import Ca
阅读更多...
【LabVIEW学习篇 - 21】：DLL与API的调用

【LabVIEW学习篇 - 21】：DLL与API的调用

文章目录 DLL与API调用DLLAPIDLL的调用 DLL与API调用 LabVIEW虽然已经足够强大，但不同的语言在不同领域都有着自己的优势，为了强强联合，LabVIEW提供了强大的外部程序接口能力，包括DLL、CIN(C语言接口)、ActiveX、.NET、MATLAB等等。通过DLL可以使用户很方便地调用C、C++、C#、VB等编程语言写的程序以及windows自带的大
阅读更多...
string字符会调用new分配堆内存吗

string字符会调用new分配堆内存吗

gcc的string默认大小是32个字节，字符串小于等于15直接保存在栈上，超过之后才会使用new分配。
阅读更多...
京东物流查询｜开发者调用API接口实现

京东物流查询｜开发者调用API接口实现

快递聚合查询的优势 1、高效整合多种快递信息。2、实时动态更新。3、自动化管理流程。 聚合国内外1500家快递公司的物流信息查询服务，使用API接口查询京东物流的便捷步骤，首先选择专业的数据平台的快递API接口：物流快递查询API接口-单号查询API - 探数数据 以下示例是参考的示例代码： import requestsurl = "http://api.tanshuapi.com/a
阅读更多...
vue 父组件调用子组件的方法报错，“TypeError: Cannot read property ‘subDialogRef‘ of undefined“

vue 父组件调用子组件的方法报错，“TypeError: Cannot read property ‘subDialogRef‘ of undefined“

vue 父组件调用子组件的方法报错，“TypeError: Cannot read property ‘subDialogRef’ of undefined” 最近用vue做的一个界面，引入了一个子组件，在父组件中调用子组件的方法时，报错提示： [Vue warn]: Error in v-on handler: “TypeError: Cannot read property ‘methods
阅读更多...
【微服务】Ribbon（负载均衡，服务调用）+ OpenFeign（服务发现，远程调用）【详解】

【微服务】Ribbon（负载均衡，服务调用）+ OpenFeign（服务发现，远程调用）【详解】

文章目录 1.Ribbon（负载均衡，服务调用）1.1问题引出1.2 Ribbon负载均衡1.3 RestTemplate整合Ribbon1.4 指定Ribbon负载均衡策略1.4.1 配置文件1.4.2 配置类1.4.3 定义Ribbon客户端配置1.4.4 自定义负载均衡策略 2.OpenFeign面向接口的服务调用（服务发现，远程调用）2.1 OpenFeign的使用2.1 .1创建
阅读更多...
类和对象的定义和调用演示(C++)

类和对象的定义和调用演示(C++)

我习惯把类的定义放在头文件中 Student.h #define _CRT_SECURE_NO_WARNINGS#include <string>using namespace std;class student{public:char m_name[25];int m_age;int m_score;char* get_name(){return m_name;}int set_name
阅读更多...
如何生成DLL以及如何调用DLL？

如何生成DLL以及如何调用DLL？

Pass
阅读更多...
React 笔记 父子组件传值 | 父组件调用子组件数据 | defaultProps | propsType合法性验证

React 笔记 父子组件传值 | 父组件调用子组件数据 | defaultProps | propsType合法性验证

1.通过props实现父组件像子组件传值 、方法、甚至整个父组件 传递整个父组件则   [变量名]={this} import Header from "./Header"render(){return(<Header msg={"我是props传递的数据"}/>)} import React,{Component} from "react";class Header extends
阅读更多...
java的一些简单调用！

java的一些简单调用！

四、context:component-scan     <!-- 对包中的所有类进行扫描，以完成Bean创建和自动依赖注入的功能 -->     <context:component-scan base-package="com.haso.bscsserver">     <!-- 允许定义过滤器将基包下的某些类纳入或排除     <context:include-filter
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2