万事须己运，他得非我贤。这篇文章主要讲述基于eBPF的云原生可观测性开源项目Kindling之Dubbo2 协议开发流程相关的知识，希望能为你提供帮助。
1 项目概览Kindling collector项目作为Go端分析器，使用类似opentelmetry的pinpeline进行数据分析。其中涉及5个组件：
- UdsReceiver - Unix Domain Socket接收器，接收探针事件并传递给后续的网络分析器。
- NetworkAnalyzer - 网络事件分析器，将接收的Read / Write事件匹配成单次请求后，根据协议解析请求内容生成关键指标，传递给后续的分析器。
- K8sMetadataProcessor - K8S指标处理器，补充K8S指标并传递给后续的聚合处理器
- AggregateProcessor - 数据聚合处理器，将接收的指标数据生成Trace和Metric，传递给给后续的转发器。
- OtelExporter - Opentelmetry转发器，将Trace / Metric数据转发给Prometheus进行展示。
文章图片
1.1 协议解析流程NetworkAnnalyzer.parseProtocols()方法定义了整体解析流程，根据协议解析器分别解析请求和响应，当最终都成功时输出指标。
文章图片
1.2 协议解析设计思路正常的协议解析只负责逐帧解析指标功能。
文章图片
现已支持5种协议解析，当协议越来越多时，遍历引起的解析会越来越耗时，那么需引入fastfail快速识别协议
文章图片
对于复杂的多报文协议，如Kafka有不同的API报文，而相同API也有不同的版本报文。将所有报文解析逻辑都写在一起会使整个类过于臃肿且不易维护。为此引入树形多报文结构用于快速且低耦合地实现开发。
文章图片
1.2.1 报文解析结构体
在树形报文解析过程中，有如下2个场景需要考虑
- 当父协议解析了指标A，子协议解析可能会用到A指标，那么父子协议解析的指标需要透传。
- 父协议已解析了部分报文长度的内容，那么子协议在开始解析时可直接跳过相应长度的内容进行解析，此处引入偏移量用于下一个协议跳过解析。
type PayloadMessage struct
Data[]byte
Offsetint
attributeMap *model.AttributeMap
1.2.2 报文解析API
由于引入协议树，协议解析过程parse() (ok bool)将不再适用。协议树中的个协议的解析成功不表示整个协议解析成功，需解析整颗树的协议是否成功，将API扩展为parse() (ok bool, complete bool)。
- 对于单层协议(HTTP)，返回为(ok, true)
文章图片
基于以上几点需求，设计树形结构的报文解析器PkgParser。PkgParser定义了fastFail(快速识别失败) 和parser(解析单个报文)函数；每个协议只需注册自身的PkgParser即可接入整套流程。
**fastFail(message *PayloadMessage) (fail bool)**
- 声明协议是否识别失败，用于快速识别协议
- 解析协议，将解析出的指标存储到message的Attributes中
- 返回是2个参数：
- 是否解析成功
- 是否解析完成 (默认为true，当为false主要是用于嵌套解析过程，例如先定义一个头解析，再定义不同的消息体解析)。
1.3 请求 / 响应解析ProtocolParser定义了请求和响应的解析器，并提供ParseRequest()和ParseResponse() API用于解析请求和响应
其中response的message携带了request解析出的attributes指标，用于匹配。eg. kafka的correlationId request和response报文需一致，且response报文解析用到了request的key。
文章图片
2 开发流程
文章图片
2.1 添加协议名
const (
HTTP= "http"
...
XX= "xx" // 此处替换具体协议名
...
)
2.2 创建协议【基于eBPF的云原生可观测性开源项目Kindling之Dubbo2 协议开发流程】analyzer/network/protocol目录下创建文件夹xx，xx替换为具体协议，并创建3个文件xx_parser.go、xx_request.go 和 xx_response.go
analyzer/network/protocol/xx
├── xx_parser.go协议解析器
├── xx_request.go实现请求解析流程
└── xx_response.go实现响应解析流程
2.2.1 xx_request.go
实现fastfail()和parser()函数
func fastfailXXRequest() protocol.FastFailFn
return func(message *protocol.PayloadMessage) bool
// 根据报文实现具体的fastFail()函数
return false
func parseXXRequest() protocol.ParsePkgFn
return func(message *protocol.PayloadMessage) (bool, bool)
// 解析报文内容
contentKey := getContentKey(message.Data)
if contentKey == ""
// 第一个参数false 表示解析失败，第二个参数表示报文解析完成
return false, true
// 通过AddStringAttribute() 或 AttIntAttribute() 存储解析出的属性
message.AddStringAttribute(constlabels.ContentKey, contentKey)
// 解析成功
return true, true
2.2.2 xx_response.go
实现fastfail()和parser()函数
func fastfailXXResponse() protocol.FastFailFn
return func(message *protocol.PayloadMessage) bool
// 根据报文实现具体的fastFail()函数
return false
func parseXXResponse() protocol.ParsePkgFn
return func(message *protocol.PayloadMessage) (bool, bool)
// 通过GetStringAttribute() 或 GetIntAttribute() 读取request解析后的参数
contentKey := message.GetStringAttribute(constlabels.ContentKey)
// 解析响应报文
errorCode := getErrorCode(message)
if errorCode > 20
// 有errorCode或errorMsg等常见，需定义IsError为true用于后续processor生成Metric
message.AddBoolAttribute(constlabels.IsError, true)
message.AddIntAttribute(constlabels.ErrorType, int64(constlabels.ProtocolError))
message.AddStringAttribute(constlabels.XXErrorCode, errorCode)
// 解析成功
return true, true
2.2.3 xx_parser.go
定义协议解析器
func NewXXParser() *protocol.ProtocolParser
requestParser := protocol.CreatePkgParser(fastfailXXRequest(), parseXXRequest())
// 当存在嵌套的协议解析 eg. 解析头 + 解析各类不同报文
// 可通过 Add()添加子协议，生成一颗协议树解析，顶部是公共部分解析，分叉是各个不同报文解析
//Header
/// | \\
//API1 API2 API3
///|\\
//v1 v2 v3
responseParser := protocol.CreatePkgParser(fastfailXXResponse(), parseXXResponse())
return protocol.NewProtocolParser(protocol.XX, requestParser, responseParser, nil)
2.2.4 factory.go
注册协议解析器
var (
...
xx_parser*protocol.ProtocolParser = xx.NewXXParser()
)
func GetParser(key string) *protocol.ProtocolParser
switch key
...
case protocol.XX:
return xx_parser
...
default:
return nil
2.2.5 kindling-collector-config.yml
配置新增协议
analyzers:
networkanalyzer:
protocol_parser: [ http, mysql, dns, redis, kafka, xx ]
3 开发案例 - Dubbo2协议3.1 dubbo2协议分析
文章图片
根据官网提供的协议规范，解析网络抓包的数据。
- 前2个byte为魔数，可用于fastfail()方法
- 第3个byte包含Req/Resp、序列化方式等信息，可用于解析协议中判断是否合法报文。
- 第4个byte用于返回报文的错误码
- 第16个byte开始需通过指定的序列化方式解析报文内容，service name + method name可用于contentKey标识该请求的URL
文章图片
3.2 声明协议名
const (
...
DUBBO2= "dubbo2"
...
)
3.3 实现dubbo2解析创建协议相关文件
kindling/collector/analyzer/network/protocol/dubbo2
├── dubbo2_parser.goDubbo2解析器
├── dubbo2_request.go实现请求解析流程
├── dubbo2_response.go实现响应解析流程
└── dubbo2_serialize.goDubbo2反序列化器
3.3.1 dubbo2_request.go
声明request请求的fastFail函数
func fastfailDubbo2Request() protocol.FastFailFn
return func(message *protocol.PayloadMessage) bool
return len(message.Data) < 16 || message.Data[0] != MagicHigh || message.Data[1]
推荐阅读
- POSTGRESQL如何存储树形数据 处理树形数据
- postgresql读书会 一期系统管理的一些script3
- MYSQL默认情况下 MYSQL 是ACID 吗?
- #导入Word文档图片# VM虚拟机网络设置
- TIDB 学习计划--- 什么是分布式数据库和TIDB 整体架构
- MYSQL 8VSMYSQL 5.7 到底ORACLE是怎么想的（）
- Nginx架构篇LNMP动态网站环境部署
- 使用 KubeKey 搭建 Kubernetes/KubeSphere 环境的＂心路(累)历程＂
- 如何清空DNS缓存Windows&linux