金仓数据库KingbaseES接口协议解析工具使用指南（2. 概述）

本章节包含以下内容：

• 什么是接口协议解析

• 解析工具的构成

• 解析工具的适用场景

• 解析工具的运行环境

• 解析工具不支持的场景

接口协议解析工具，用于特殊场景下的调试工作，通过探测网络中传输的接口协议，快速地抓取并展示接口通讯协议。

解析工具从理论上确定了不会对数据库系统的正常运行和任何协议消息交互造成影响。

2.1. 什么是接口协议解析 ¶

接口协议指的是KingbaseES数据库实例中的前端、后端在网络之间传递的TCP报文；

接口协议解析指的是通过相应的TCP报文，获知正在传递的信息类型和信息内容。

解析工具通过网络协议栈抓取TCP报文，如果是数据库相关协议，就尝试进行解释，将解析后的内容，转换为可以直接阅读的格式打印在屏幕上。

2.2. 解析工具的构成 ¶

解析工具由一个二进制文件构成，包含在KingbaseES安装包中。

解析工具位于安装目录./bin/kes_protocol_tool。

2.3. 解析工具的适用场景 ¶

在以下场景中可以使用：

• 调试服务器某模块的工作状态；

• 调试服务器协议的处理过程；

• 调试某语言的驱动问题；

• 调试某应用的使用方法；

• 调试集群的工作流程；

• 调试网络问题引起的系统异常；

适用人群：

• 功能模块研发人员；

• 功能模块测试人员；

• 客户现场实施人员；

2.4. 解析工具的运行环境 ¶

使用工具前，需要确认数据库实例提供服务的物理网卡和TCP端口。

工具从物理网卡直接获取TCP报文，需要root权限，必须使用root用户来启动此工具。

2.5. 解析工具不支持的场景 ¶

任何信息安全相关的协议均不支持：包含SSL会话、SAL认证等加密相关的协议。