写在前面
文章基于SkyWalking-oap-9.7.0版本,agent版本为9.1.0。
官方方案
通过SkyWalking文档及官方询问得知,SkyWalking中目前不支持自定义TraceId,但是在我们的业务中,有一些场景又需要统一生成固定格式的TraceId用来查询链路数据,基于搜索的一些资料和源码查询,最终基于下面的方案进行实现。
设计方案
在SkyWalking中,有一个跨进程传播的头部协议(简称SW8),它被用于在被测服务进程中进行上下文传递,我们可以自定义一个sdk-plugin,在插件中捕捉http协议的请求,并在请求头中插入模拟头部节点的SW8协议,在协议中插入自己想要生成的业务数据。该方案得到了多个实际运行系统的验证,但是是否符合SkyWalking的安全规范及代码规范还需要考证。
SW8协议
基础概念
sw8是一个在header中传递的数据项,它的key为【sw8】,value为8个字段组成,由【-】分割的一个字符串。
sw8值详解
sw8的值由8个部分组成
1. 采样(Sample):0 / 1,0表示上下文存在,但是可以忽略,1表示此追踪需要采样并发送到后端。
2. 追踪标识(Trace Id):字符串(BASE64 编码),这里是主要自定义的部分。
3. 父追踪段 ID(Parent Segment Id):全局唯一的字符串(BASE64 编码),可以使用traceId。
4. 父 Span 标识:int类型,从0开始,此 Span ID 指向了父追踪段中的 Span,我们这里模拟的是头服务,所以设置为0即可。
5. 父服务:字符串(BASE64 编码),这里可以设置成你要模拟的头服务的名字。
6. 父服务实例标识:字符串(BASE64 编码),这里可以设置成同上。
7. 父服务的端点:字符串(BASE64 编码):父追踪段中第一个入口span的操作名。
8. 本请求的目标地址:字符串(BASE64 编码),可以简单设置为本机IP地址。
插件代码
在skywalking-java仓库中,找到apm-sniffer下的apm-sdk-plugin目录,在plugin目录中仿照其他插件新建一个插件目录,这里比较简单,文章跳过此部分。
在插件代码中,获取http的header,在header中插入sw8的key。
在这部分生成协议头,traceId通过部分业务数据+雪花ID组成。
最终效果
图中为自己生成的TraceId