gstrace

功能介绍

gstrace是openGauss提供的用来跟踪内核代码执行路径，记录内核数据结构，分析代码性能的工具。Trace的有限点位和数据在版本中被固化，无法动态添加和删除。

gstrace - 图1 警告：

  1. 对内核dump指定内存变量的数据用于诊断分析，不存在直接指定任意寄存器或者内存地址的行为。读取的内存地址均是在开发阶段硬编码，没有任意地读取或者修改寄存器或内存的操作。
  2. Trace点可能涉及敏感数据，收集trace信息前需要同用户协商，授权和许可后方可收集。
  3. openGauss不会在敏感信息上打点，不会TRACE和用户相关的数据。
  4. Trace仅用于诊断目的，开启trace将对性能产生一定影响，影响的大小视负载的高低，trace的模块而不同。
  5. Trace工具的权限为0700，仅限于数据库用户读、写和执行。

gstrace - 图2 说明： 如果进程异常终止，/dev/shm/ 目录下将会有gstrace_trace_cfg_*残留，可以手动清除。

语法

1. gstrace [start|stop|config|dump|detailcodepath|analyze] [-p <port>][-s <BUFFER_SIZE>] [-f <DUMP_FILE>] [-o <OUTPUT_FILE>] [-t <STEP_SIZE>]

参数说明

表 1 gstrace参数说明

参数 说明
start 开始记录trace。
stop 停止trace，释放存储信息的共享内存trace buffer。注意：trace buffer中已捕获trace信息会丢失。
config 显示trace的配置信息。
dump 将共享内存中的trace信息写入指定文件。若没有启动trace将报错。
detail 将dump出来的二进制文件解析成文本文件，显示trace点的线程、时间信息。
codepath 提取dump文件中的函数调用信息，按照调用栈的方式显示。
analyze 统计各个函数的执行次数、总耗时、平均耗时、最长耗时、最短耗时。
-p PORT 指定启动trace功能的实例侦听的端口号。
-f DUMP_FILE 指定dump导出的trace文件。
-o OUTPUT_FILE 指定写入的文件。
-t STEP_SIZE 指定分片分析的时间跨度（秒）,可选。将生成单独的{OUTPUT_FILE}.step文件。
-m MASK 指定哪些模块、函数需要追踪，如果参数为空，则追踪添加trace接口的所有模块的所有函数。 格式:：[comp…][ALL].[func…][ALL] 描述： 1. comp是模块列表，使用‘,’分隔，例如：executer,kernel。也可以使用序号，例如：executer,2。 2. func是function列表，使用‘,’分隔。例如：sql_execute_ddl, sql_execute_dcl。也可以使用序号指代模块中第几个function，例如：2。 3. 设置成ALL表示所有模块或所有function被trace。 示例： 1. executer,kernel.ALL：所有定义定义在executer和kernel模块下的function被trace。 2. executer,kernel.sql_execute_ddl：定义在executer 下的Function sql_execute_ddl被trace. kernel模块被忽略，因为下面没有该function。 3. executer,kernel.1：定义在模块executer和 kernel 下的第一个function被trace。 ALL.1,2：定义在所有模块下的第一，二个function被trace。
-s BUFFER_SIZE 指定用于trace功能的共享内存大小，默认为1G。如果指定的BUFFER_SIZE小于最小值2048，系统将自动调整为最小值。如果指定的BUFFER_SIZE不是2^N（二的N次方），则向下对齐2^N；例如：指定BUFFER_SIZE=3072，由于2^11<3072<2^12，系统将调整为2048。

示例

  1. 启动trace

1. gstrace start -p 8000 2. 停止trace

1. gstrace stop -p 8000 3. 查看trace配置

1. gstrace config -p 8000 4. dump trace

1. gstrace dump -p 8000 -o /data/8000.dump 5. 解析dump detail信息

1. gstrace detail -f /data/8000.dump -o /data/8000.detail 6. 解析dump codepath

1. gstrace codepath -f /data/8000.dump -o /data/8000.codepath 7. 分析全局性能

1. gstrace analyze -f /data/8000.dump -o /data/8000.perf 8. 分析分片性能

1. gstrace analyze -f /data/8000.dump -o /data/8000.perf -t 1