http/pprof

原文：https://pkg.go.dev/net/http/pprof@go1.23.0

Package pprof serves via its HTTP server runtime profiling data in the format expected by the pprof visualization tool.

​ pprof 包通过其 HTTP 服务器以 pprof 可工具所期望的格式提供运行时分析数据。

The package is typically only imported for the side effect of registering its HTTP handlers. The handled paths all begin with /debug/pprof/.

​ 通常，该包仅用于注册其 HTTP 处理程序的副作用。所有处理的路径都以 /debug/pprof/ 开头。

The package is typically only imported for the side effect of registering its HTTP handlers. The handled paths all begin with /debug/pprof/. As of Go 1.22, all the paths must be requested with GET.

​ 通常，导入该包仅仅是为了其注册的 HTTP 处理器的副作用。这些处理路径都以 /debug/pprof/ 开头。自 Go 1.22 起，所有路径都必须通过 GET 请求。

To use pprof, link this package into your program:

​ 要使用 pprof，请将此包链接到您的程序中：

1

import _ "net/http/pprof"

If your application is not already running an http server, you need to start one. Add “net/http” and “log” to your imports and the following code to your main function:

​ 如果您的应用程序尚未运行 HTTP 服务器，则需要启动一个。将 “net/http” 和 “log” 添加到您的导入项中，并将以下代码添加到您的主函数中：

1
2
3

go func() {
	log.Println(http.ListenAndServe("localhost:6060", nil))
}()

By default, all the profiles listed in runtime/pprof.Profile are available (via Handler), in addition to the Cmdline, Profile, Symbol, and Trace profiles defined in this package. If you are not using DefaultServeMux, you will have to register handlers with the mux you are using.

​ 默认情况下，所有在 runtime/pprof.Profile 中列出的分析都可用（通过 Handler），还有此包中定义的 Cmdline、Profile、Symbol 和 Trace 分析。如果您没有使用 DefaultServeMux，您将需要使用您使用的 mux 注册处理程序。

参数 Parameters

Parameters can be passed via GET query params:

​ 参数可以通过 GET 查询参数传递：

• debug=N (all profiles): response format: N = 0: binary (default), N > 0: plaintext
• debug=N（适用于所有 profiles）：响应格式：N=0：二进制（默认），N>0：纯文本
• gc=N (heap profile): N > 0: run a garbage collection cycle before profiling
• gc=N（适用于 heap profile）：N>0：在分析之前运行一次垃圾回收循环
• seconds=N (allocs, block, goroutine, heap, mutex, threadcreate profiles): return a delta profile
• seconds=N（适用于 allocs、block、goroutine、heap、mutex、threadcreate profiles）：返回增量 profile
• seconds=N (cpu (profile), trace profiles): profile for the given duration
• seconds=N（适用于 cpu (profile)、trace profiles）：进行指定持续时间的分析

使用示例

Use the pprof tool to look at the heap profile:

​ 使用 pprof 工具查看堆分析文件：

1

go tool pprof http://localhost:6060/debug/pprof/heap

Or to look at a 30-second CPU profile:

​ 或者查看 30 秒的 CPU 分析文件：

1

go tool pprof http://localhost:6060/debug/pprof/profile?seconds=30

Or to look at the goroutine blocking profile, after calling runtime.SetBlockProfileRate in your program:

​ 或者在调用 runtime.SetBlockProfileRate 之后查看 goroutine 阻塞分析文件：

1

go tool pprof http://localhost:6060/debug/pprof/block

Or to look at the holders of contended mutexes, after calling runtime.SetMutexProfileFraction in your program:

​ 或者在调用 runtime.SetMutexProfileFraction 之后查看争用互斥锁的持有者分析文件：

1

go tool pprof http://localhost:6060/debug/pprof/mutex

The package also exports a handler that serves execution trace data for the “go tool trace” command. To collect a 5-second execution trace:

​ 该包还导出了一个处理程序，用于为 “go tool trace” 命令提供执行跟踪数据。要收集 5 秒的执行跟踪数据：

1
2

curl -o trace.out http://localhost:6060/debug/pprof/trace?seconds=5
go tool trace trace.out

To view all available profiles, open http://localhost:6060/debug/pprof/ in your browser.

​ 要查看所有可用的分析文件，请在浏览器中打开 http://localhost:6060/debug/pprof/。

For a study of the facility in action, visithttps://blog.golang.org/2011/06/profiling-go-programs.html.

​ 要了解该功能的实际应用，请访问官方博客：Profiling Go Programs

常量

This section is empty.

变量

This section is empty.

函数

func Cmdline

1

func Cmdline(w http.ResponseWriter, r *http.Request)

Cmdline responds with the running program’s command line, with arguments separated by NUL bytes. The package initialization registers it as /debug/pprof/cmdline.

​ Cmdline 函数响应运行程序的命令行，其中实参由 NUL 字节分隔。该包的初始化将其注册为 /debug/pprof/cmdline。

func Handler

1

func Handler(name string) http.Handler

Handler returns an HTTP handler that serves the named profile. Available profiles can be found in runtime/pprof.Profile.

​ Handler 函数返回一个 HTTP 处理程序，用于提供指定的分析文件。可用的分析文件可以在 runtime/pprof.Profile 中找到。

func Index

1

func Index(w http.ResponseWriter, r *http.Request)

Index responds with the pprof-formatted profile named by the request. For example, “/debug/pprof/heap” serves the “heap” profile. Index responds to a request for “/debug/pprof/” with an HTML page listing the available profiles.

​ Index 函数响应请求的 pprof 格式的分析文件。例如，"/debug/pprof/heap" 会提供 “heap” 分析文件。对于请求 “/debug/pprof/"，Index 会响应一个 HTML 页面，列出可用的（所有）分析文件。

func Profile

1

func Profile(w http.ResponseWriter, r *http.Request)

Profile responds with the pprof-formatted cpu profile. Profiling lasts for duration specified in seconds GET parameter, or for 30 seconds if not specified. The package initialization registers it as /debug/pprof/profile.

​ Profile 函数响应 pprof 格式的 CPU 分析文件。分析持续时间由 GET 参数中的 seconds 指定，如果未指定，则默认为 30 秒。该包的初始化将其注册为 /debug/pprof/profile。

func Symbol

1

func Symbol(w http.ResponseWriter, r *http.Request)

Symbol looks up the program counters listed in the request, responding with a table mapping program counters to function names. The package initialization registers it as /debug/pprof/symbol.

​ Symbol 函数查找请求中列出的程序计数器，响应一个表，将程序计数器映射到函数名称。该包的初始化将其注册为 /debug/pprof/symbol。

func Trace <- go1.5

1

func Trace(w http.ResponseWriter, r *http.Request)

Trace responds with the execution trace in binary form. Tracing lasts for duration specified in seconds GET parameter, or for 1 second if not specified. The package initialization registers it as /debug/pprof/trace.

​ Trace 函数响应以二进制形式的执行跟踪。跟踪持续时间由 GET 参数中的 seconds 指定，如果未指定，则默认为 1 秒。该包的初始化将其注册为 /debug/pprof/trace。

类型

This section is empty.