AI 助理
备案控制台
开发者社区 Golang语言社区 文章 正文

gops —— Go 程序诊断分析工具

2018-10-25 2259
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： GitHub: https://github.com/google/gops 一个用于列出和诊断分析系统中正在运行的 Go 程序的命令行工具 安装 1 go get -u github.

GitHub: https://github.com/google/gops

一个用于列出和诊断分析系统中正在运行的 Go 程序的命令行工具

安装

go get -u github.com/google/gops

命令帮助

执行 gops help 查看帮助文档：

gops is a tool to list and diagnose Go processes.


	gops <cmd> <pid|addr> ...


	gops <pid> # displays process info


Commands:


stack       	Prints the stack trace.


gc          	Runs the garbage collector and blocks until successful.


setgc	        Sets the garbage collection target percentage.


memstats    	Prints the allocation and garbage collection stats.


version     	Prints the Go version used to build the program.


stats       	Prints the vital runtime stats.


help        	Prints this help text.


Profiling commands:


trace       	Runs the runtime tracer for 5 secs and launches "go tool trace".


pprof-heap  	Reads the heap profile and launches "go tool pprof".


pprof-cpu   	Reads the CPU profile and launches "go tool pprof".


All commands require the agent running on the Go process.


Symbol "*" indicates the process runs the agent.

使用详解

为了能更好的分析程序，需要在我们的项目中加一行 agent 诊断分析代码，用于统计分析程序问题。

package main


import (


	"log"


	"time"


	"github.com/google/gops/agent"


)


func main() {


	if err := agent.Listen(agent.Options{}); err != nil {


		log.Fatal(err)


	}


	time.Sleep(time.Hour)


}

其中，agent. 支持更多的参数：

// Code reference: github.com/google/gops/agent/agent.go:42


// Options allows configuring the started agent.


type Options struct {


	// Addr is the host:port the agent will be listening at.


	// Optional.


	Addr string


	// ConfigDir is the directory to store the configuration file,


	// PID of the gops process, filename, port as well as content.


	// Optional.


	ConfigDir string


	// ShutdownCleanup automatically cleans up resources if the


	// running process receives an interrupt. Otherwise, users


	// can call Close before shutting down.


	// Optional.


	ShutdownCleanup bool


}

●  Addr

可选。为远程分析服务提供监听地址，例如: :9119。配置了该项，那我们可以在本机查看分析远程服务器上的 Go 程序，非常有帮助。

 ●  ConfigDir

可选。用于存放统计数据和配置的目录，默认为当前用户的主目录。也可以通过环境变量GOPS_CONFIG_DIR设置。具体参考代码：

const gopsConfigDirEnvKey = "GOPS_CONFIG_DIR"


func ConfigDir() (string, error) {


	if configDir := os.Getenv(gopsConfigDirEnvKey); configDir != "" {


		return configDir, nil


	}


	if runtime.GOOS == "windows" {


		return filepath.Join(os.Getenv("APPDATA"), "gops"), nil


	}


	homeDir := guessUnixHomeDir()


	if homeDir == "" {


		return "", errors.New("unable to get current user home directory: os/user lookup failed; $HOME is empty")


	}


	return filepath.Join(homeDir, ".config", "gops"), nil


}


func guessUnixHomeDir() string {


	usr, err := user.Current()


	if err == nil {


		return usr.HomeDir


	}


	return os.Getenv("HOME")


}

 ●  ShutdownCleanup

可选。设置为 true，则在程序关闭时会自动清理数据。

NOTE: 如果不加 agent 代码，那我们无法更深入的诊断程序，也就是说无法执行gops memstats、gops pprof-heap等所有类似于 gops <cmd> <pid|addr> ... 的子命令。

gops

直接执行 gops 命令会列出本机所有正在运行的 Go 程序。

$ gops


99288 47636 go    go1.10.1 /usr/local/Cellar/go/1.10.1/libexec/bin/go


99300 99288 main* go1.10.1 /private/var/folders/cs/mfl4k8t54_g1thdzvzkdxbbr0000gn/T/go-build375822490/b001/exe/main


99570 2899  gops  go1.10.1 /Users/shocker/gowork/bin/gops


99154 14655 hugo  go1.11.1 /usr/local/Cellar/hugo/0.49.1/bin/hugo

该命令会显示以下内容：

 ●  PID
 ●  PPID
 ●  程序名称
 ●  构建该程序的 Go 版本号
 ●  程序所在绝对路径

注意，列表中有个程序名称后面带了个 *，表示该程序加入了 gops 的诊断分析代码。

gops <pid>

用法: gops <pid> 查看本机指定 PID Go 程序的基本信息

$ gops 99300


parent PID:	99288


threads:	11


memory usage:	0.157%


cpu usage:	0.013%


username:	shocker


cmd+args:	/var/folders/cs/mfl4k8t54_g1thdzvzkdxbbr0000gn/T/go-build375822490/b001/exe/main


local/remote:	*:9105 <-> :0 (LISTEN)


local/remote:	127.0.0.1:57109 <-> 127.0.0.1:3306 (ESTABLISHED)


local/remote:	*:8000 <-> :0 (LISTEN)

local/remote 表示本机建立的监听(LISTEN)，或者与远程服务器建立的链接(ESTABLISHED)

local/remote: *:9105 <-> :0 (LISTEN) 中的 *:9105 是 gops/agent 提供的服务，

gops tree

用法: gops tree 以目录树的形式展示所有 Go 程序。

$ gops tree


...


├── 2899


│   └── 99996 (gops) {go1.10.1}


├── 47636


│   └── 99288 (go) {go1.10.1}


│       └── [*]  99300 (main) {go1.10.1}


└── 14655


└── 99154 (hugo) {go1.11.1}

gops stack (<pid>|<addr>)

用法: gops stack (<pid>|<addr>) 用于显示程序所有堆栈信息，包括每个 goroutine 的堆栈信息、运行状态、运行时长等。

$ gops stack 99300


goroutine 7 [running]:


runtime/pprof.writeGoroutineStacks(0x1882720, 0xc4202b8010, 0xd0, 0xd0)


	/usr/local/Cellar/go/1.10.1/libexec/src/runtime/pprof/pprof.go:650 +0xa7


runtime/pprof.writeGoroutine(0x1882720, 0xc4202b8010, 0x2, 0x30, 0xc420068248)


	/usr/local/Cellar/go/1.10.1/libexec/src/runtime/pprof/pprof.go:639 +0x44


goroutine 1 [IO wait, 9 minutes]:


internal/poll.runtime_pollWait(0x1db4da0, 0x72, 0x0)


	/usr/local/Cellar/go/1.10.1/libexec/src/runtime/netpoll.go:173 +0x57


internal/poll.(*pollDesc).wait(0xc4201e7318, 0x72, 0x0, 0x0, 0x0)


# more ...

gops memstats (<pid>|<addr>)

用法: gops memstats (<pid>|<addr>) 查看程序的内存统计信息

$ gops memstats 127.0.0.1:9105


alloc: 1.36MB (1428632 bytes)


total-alloc: 10.21MB (10709376 bytes)


sys: 9.07MB (9509112 bytes)


lookups: 91


mallocs: 102818


frees: 91896


heap-alloc: 1.36MB (1428632 bytes)


heap-sys: 5.22MB (5472256 bytes)


heap-idle: 2.34MB (2457600 bytes)


heap-in-use: 2.88MB (3014656 bytes)


heap-released: 0 bytes


heap-objects: 10922


stack-in-use: 704.00KB (720896 bytes)


stack-sys: 704.00KB (720896 bytes)


stack-mspan-inuse: 47.95KB (49096 bytes)


stack-mspan-sys: 80.00KB (81920 bytes)


stack-mcache-inuse: 6.78KB (6944 bytes)


stack-mcache-sys: 16.00KB (16384 bytes)


other-sys: 1.21MB (1266624 bytes)


gc-sys: 492.00KB (503808 bytes)


next-gc: when heap-alloc >= 4.00MB (4194304 bytes)


last-gc: 2018-10-18 13:37:04.37511973 +0800 CST


gc-pause-total: 9.209158ms


gc-pause: 52831


num-gc: 60


enable-gc: true


debug-gc: false

gops gc (<pid>|<addr>)

用法: gops gc (<pid>|<addr>) 查看指定程序的垃圾回收(GC)信息

gops setgc (<pid>|<addr>)

用法: gops setgc (<pid>|<addr>) 设定指定程序的 GC 目标百分比

gops version (<pid>|<addr>)

用法: gops version (<pid>|<addr>) 查看指定程序构建时的 Go 版本号

gops stats (<pid>|<addr>)

用法: gops stats (<pid>|<addr>) 查看指定程序的 goroutine 数量、GOMAXPROCS 值等信息

$ gops stats 127.0.0.1:9105


goroutines: 11


OS threads: 14


GOMAXPROCS: 4


num CPU: 4

gops pprof-cpu (<pid>|<addr>)

用法: gops pprof-cpu (<pid>|<addr>) 调用并展示 go tool pprof 工具中关于 CPU 的性能分析数据，操作与 pprof 一致。

$ gops pprof-cpu 99300


Profiling CPU now, will take 30 secs...


Profile dump saved to: /var/folders/cs/mfl4k8t54_g1thdzvzkdxbbr0000gn/T/profile881383738


Profiling dump saved to: /var/folders/cs/mfl4k8t54_g1thdzvzkdxbbr0000gn/T/profile881383738


Binary file saved to: /var/folders/cs/mfl4k8t54_g1thdzvzkdxbbr0000gn/T/binary970030929


File: binary970030929


Type: cpu


Time: Oct 18, 2018 at 2:43pm (CST)


Duration: 30s, Total samples = 0


Entering interactive mode (type "help" for commands, "o" for options)


(pprof)

gops pprof-heap (<pid>|<addr>)

用法: gops pprof-heap (<pid>|<addr>) 调用并展示 go tool pprof 工具中关于 heap 的性能分析数据，操作与 pprof 一致。

$ gops pprof-heap 99300


Profile dump saved to: /var/folders/cs/mfl4k8t54_g1thdzvzkdxbbr0000gn/T/profile045800436


Profiling dump saved to: /var/folders/cs/mfl4k8t54_g1thdzvzkdxbbr0000gn/T/profile045800436


Binary file saved to: /var/folders/cs/mfl4k8t54_g1thdzvzkdxbbr0000gn/T/binary315133123


File: binary315133123


Type: inuse_space


Time: Oct 18, 2018 at 2:46pm (CST)


Entering interactive mode (type "help" for commands, "o" for options)


(pprof)

gops trace (<pid>|<addr>)

用法: gops trace (<pid>|<addr>) 追踪程序运行5秒，生成可视化报告，并可在浏览器中查看: http://127.0.0.1:61380

$ gops trace 99300


Tracing now, will take 5 secs...


Trace dump saved to: /var/folders/cs/mfl4k8t54_g1thdzvzkdxbbr0000gn/T/trace136310737


2018/10/18 14:49:06 Parsing trace...


2018/10/18 14:49:06 Serializing trace...


2018/10/18 14:49:06 Splitting trace...


2018/10/18 14:49:06 Opening browser. Trace viewer is listening on http://127.0.0.1:61380


原文发布时间为：2018-10-24

本文作者：Shocker

本文来自云栖社区合作伙伴“Golang语言社区”，了解相关信息可以关注“Golang语言社区”。

文章标签：
Go
Java
关键词：
Go工具
Go程序
Go诊断
技术小能手
目录
相关文章
兀码
|
4月前
|
Linux 测试技术 编译器
在go程序中的交叉编译
【7月更文挑战第9天】本文介绍Go 交叉编译允许在一种平台上构建适用于多平台的二进制文件。`go build -cover`用于覆盖率分析，`-coverpkg`控制分析的包范围，生成的二进制文件运行后，覆盖率数据会写入`GOCOVERDIR`指定的目录。
兀码
189 14
在go程序中的交叉编译
听风de歌
|
11天前
|
JSON 监控 安全
go语言选择合适的工具和库
【10月更文挑战第17天】
听风de歌
11 2
rbvb2ms5saimy
|
2月前
|
Kubernetes Go 持续交付
一个基于Go程序的持续集成/持续部署（CI/CD）
本教程通过一个简单的Go程序示例，展示了如何使用GitHub Actions实现从代码提交到Kubernetes部署的CI/CD流程。首先创建并版本控制Go项目，接着编写Dockerfile构建镜像，再配置CI/CD流程自动化构建、推送Docker镜像及部署应用。此流程基于GitHub仓库，适用于快速迭代开发。
rbvb2ms5saimy
47 3
游客j4mujezz7vm7y
|
2月前
|
Kubernetes 持续交付 Go
创建一个基于Go程序的持续集成/持续部署（CI/CD）流水线
创建一个基于Go程序的持续集成/持续部署（CI/CD）流水线
游客j4mujezz7vm7y
45 3
希望_睿智
|
2月前
|
IDE Go 数据处理
Go to Learn Go之第一个Go程序
Go to Learn Go之第一个Go程序
希望_睿智
24 0
白如意i
|
3月前
|
Linux Shell Go
如何构建和安装 Go 程序
如何构建和安装 Go 程序
白如意i
41 1
2G冲浪词条
|
3月前
|
Shell Go
Go 语言Air 工具使用入门
在Go开发中，频繁的手动重启应用以加载新代码既耗时又低效。为此，我们引入了Air——一款专为Go项目设计的自动重载工具。Air通过监听文件变化，实现代码更改后的自动编译与运行，极大提升了开发效率。本文将指导你完成Air的安装与配置，包括如何启动Air、忽略临时文件以及理解其工作原理，让Go项目开发更加流畅高效。
2G冲浪词条
50 3
爱发白日梦的后端
|
3月前
|
Go
在Go中如何停止程序
在Go中如何停止程序
爱发白日梦的后端
37 1
爱发白日梦的后端
|
3月前
|
Kubernetes 数据可视化 Java
Go 性能工具
Go 性能工具
爱发白日梦的后端
24 1
爱发白日梦的后端
|
3月前
|
Go 数据库 UED
[go 面试] 同步与异步：程序执行方式的不同之处
[go 面试] 同步与异步：程序执行方式的不同之处
爱发白日梦的后端
56 1