1.1 dlv 安装

   1.2 内联和优化的关闭

使用 dlv 进行调试，需要关闭编译器的内联、优化：

• 1.10及以后，编译时需指定-gcflags="all=-N -l"

• 1.10之前，编译时需指定-gcflags="-N -l"

   1.3 dlv 中位置的定义

dlv 中多数命令涉及位置（下文的 locspec），位置的定义支持以下几种方式:

• 通过 Go 文件和行号指定，其格式为 filename:lineNo，如：

• 通过包名和和函数名指定，其格式为 package.function，如：

• 通过当前文件中绝对、相对位置指定，其格式为 lineNo 或者 +offset/-offset，如：

   1.4 dlv 支持的表达式

目前 dlv 中支持表达式（下文中 expr），包括：

• 基本类型的一元、二元操作（不支持++ 、--）、比较运算等，如 p 1+1、p 1<<2、p 1<2 等；

• 类型转换，包括数值类型间转换、string 和 []byte 间转换等，如 p float32(1)、p []byte("aaa")；

• 成员访问，包括结构体、map、数组类型成员的访问，如 p mp["k"]、p arr[1]。需要注意默认对于结构体，只打印2级的数据，如需多级数据访问，需要通过成员访问；

• 指针的相关操作，包括获取访问地址、指针的解引用等，如 p x.i、p *(x.i) 等

• 一些内建的函数，包括 cap、len 等，如 p len("aaa")；

• Interface 类型的断言，如 p iface1.(*struct astruct).B 或者 p iface1.(data).B，需要注意两种表达方式是等价的；

• 一些内建的变量，如 p runtime.curg.sched，具体可以通过 vars 命令查看，常用参数具体参见下表：

需要注意，上述 p 命令为 print 命令简写，具体可参见2.3.1节

如下：

   1.5 使用 dlv 开启 debug 的几种方式

   1.5.1 开启 debug 时的一些可选参数

• 参数传递，debug 时传递参数需要通过--（其主要作用为分割命令和参数)。如下：

• --headless, --listen 启动 debug server、设定 debug server 监听地址，--headless、--listen 通常会与 dlv attach 联合用于远程调试。

目前123的测试环境(测试、pre)与 devCloud 网络是连通的，能够进行远程调试。其操作步骤，参见1.5.3 节

   1.5.2 开启 debug 的方式

需要注意本节中 flags 参数指的是1.5.1中参数。

• #### dlv debug、dlv exec

默认 dlv debug 会查找当前目录中的 main.main，编译、并开启 debug。其格式如下：

需要注意，可以通过 package 指定要 debug 的包

与之对应，dlv exec 需要指定一个可执行程序。如下：

• #### dlv attach

dlv 提供了进程的 attach 支持，使用 dlv 可以对运行中的进程进行调试。考虑到123测试环境和 devCloud 的网络已经打通，使用该机制可以非常方便的进行远程调试，如下：

在123和 devCloud 间进行远程调试步骤：

1. 123开启 debug server：

   dlv attach pid [flags]
2. devCloud 链接到远程服务器进行调试：

需注意，devCloud 只能连接到123的测试、预发布环境，无法连接到正式环境。办公网无法连接到123环境

• #### dlv core

dlv 也对 coredump 调试提供了支持，使用 dlv core 可以方便的对线上 coredump 进行调试、分析，发现相关问题。其使用方法如下：

Go 中使用 dlv 进行 core dump 调试一般步骤：

1.修改操作系统限制， 略。目前相关镜像都已经进行了配置；

2.设置 GOTRACEBACK，123为服务配置环境变量 GOTRACEBACK=crash，如下：

需要注意，如果此时启用了 recovery 相关机制，协程内的 panic 并不会导致 coredump，此时可在 /usr/local/app/serverHistory.log 中查看相关原因

需要注意，默认 coredump 文件会在可执行程序所在目录，如果需改变位置请修改 /proc/sys/kernel/core_pattern

3.通过 bt ，查看调用堆栈，定位可能的问题发生的位置。

4.通过 frame 命令，移动到相关栈帧，通过 args -v、locals -v 等收集问题发生时各种数据。

5.根据已有相关数据，对问题进行定位、分析。

   2.1 dlv 的配置

dlv 配置默认包含2种方式，基于命令、基于配置文件。需要注意，基于命令的修改是 session 级的，重启 debug 相关配置会丢失。

linux 下 dlv 配置文件默认位于$HOME/.config/dlv/config.yml，其常用配置项包含：

以 substitute-path 为例(mac 编译发布、devCloud 调试，二者路径不同)，配置前后对比如下：

配置前：

   2.2 运行相关命令

   2.2.1 restart、exit

restart、exit 分别用于重启进程、退出调试，其命令格式分别如下：

需注意，restart 只会重启进程，并不会真正开始调试。启动调试需要用 continue

其相关别名（简写）如下：

   2.2.2 continue

continue 会持续运行直到断点、位置或者程序结束，其命令格式如下：

需要注意，continue 命令支持直接运行到文件中某行、或者某个函数

continue 命令的别名为: c。

其用法如下：

   2.2.3 next、step、step out

   2.3 断点相关命令

   2.3.1 dlv 中断点

dlv 中断点包含以下几种:

• trace 断点

trace 断点用于在命中断点时，打印相关提示信息。在查看实现、或者调用路径时比较有用。

trace 断点命令格式如下：

需要注意，trace断点只会打印相关信息，不会暂停程序的运行

• break 断点

需要注意，无论是 trace 断点、break 断点，都可在添加断点时候，为断点命名

• watch 断点

   2.3.2 断点相关命令

• condition 命令

condition（其简写为 cond）命令用于只在条件满足后暂停程序执行，比如要调试的 slice 或者 map 含有较多元素，我们只关心其中某个。其命令如下:

需要注意，cond 命令必须作用于已存在的断点上

如下：

• on 命令

on 命令用于在命中断点时执行一些操作，目前支持的操作包括：print、stack、goroutine、trace、cond。

其命令格式如下：

需要注意，on 命令也只能作用于已经存在的断点

需要注意，on 命令是可以用于 trace 断点的

以命中断点，打印某些变量值为例，其具体操作如下：

• 其他

其他断点相关命令如下：

   2.4 变量、内存查看相关

   2.4.1 print

print 用于打印变量或表达式的值，其用法如下：

需要注意 print 支持 fmt 系列的选项，常用包含:%f %x %v %T 等

其执行效果参见1.4

   2.4.2 args、locals、vars

args 命令用于打印函数的入参，其用法如下

locals 用于打印局部变量，其用法如下:

vars 用于打印包级变量，其用法如下：

需要注意，vars 不只能打印自定义的包级别变量，也可以打印内置的包级变量，如 runtime.curg 等

以 args 为例，其输出如下:

需要注意，args、locals、vars 等通常与 dlv core 一起用于问题的定位与分析

以 args 为例，其输出如下:

   2.4.3 display

display 相关机制类似于 on 命令的 print，但 on 命令比 print 支持更多功能

   2.4.4 set

需要注意，如果相关变量的 set 是可以影响函数的执行路径的，但 set 命令需要提前执行

   2.4.5 whatis

   2.4.6 examinemem

   2.5 堆栈相关

   2.5.1 stack

   2.5.2 frame、up、down

   2.6 查询相关命令

   2.6.1 常用查询命令

   2.6.2 groutine

   2.6.3 list

Goland 对 dlv 相关机制提供了支持。

Goland 中 debug 相关机制都位于 debug 面板，可通过 view->tool windows->debug 打开。debug 面板默认包含2部分，分别用于展示协程信息、堆栈信息、数据信息，如下:

   3.1 断点相关

Goland 中断点相关支持，主要是 evaluate and log、condition 相关机制，具体如下：

• evaluate and log，调试过程中 console 打印相关表达式或变量的值；

• condition，只有在命中断点 && 相关条件成立时才会暂停程序运行。

在 Goland 中添加断点后，只需要在相关断点右键并单击 More，在弹出对话框中既可使用相关机制：

   3.2 变量、内存查看相关

   3.3 协程、堆栈相关