mirror of https://github.com/matrix-org/go-neb.git
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
356 lines
11 KiB
356 lines
11 KiB
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<meta name="theme-color" content="#375EAB">
|
|
|
|
<title>pprof - The Go Programming Language</title>
|
|
|
|
<link type="text/css" rel="stylesheet" href="../../../../lib/godoc/style.css">
|
|
|
|
<link rel="stylesheet" href="../../../../lib/godoc/jquery.treeview.css">
|
|
<script type="text/javascript">window.initFuncs = [];</script>
|
|
</head>
|
|
<body>
|
|
|
|
<div id='lowframe' style="position: fixed; bottom: 0; left: 0; height: 0; width: 100%; border-top: thin solid grey; background-color: white; overflow: auto;">
|
|
...
|
|
</div><!-- #lowframe -->
|
|
|
|
<div id="topbar" class="wide"><div class="container">
|
|
<div class="top-heading" id="heading-wide"><a href="http://localhost:6060/">The Go Programming Language</a></div>
|
|
<div class="top-heading" id="heading-narrow"><a href="http://localhost:6060/">Go</a></div>
|
|
<a href="index.html#" id="menu-button"><span id="menu-button-arrow">▽</span></a>
|
|
<form method="GET" action="http://localhost:6060/search">
|
|
<div id="menu">
|
|
<a href="http://localhost:6060/doc/">Documents</a>
|
|
<a href="http://localhost:6060/pkg/">Packages</a>
|
|
<a href="http://localhost:6060/project/">The Project</a>
|
|
<a href="http://localhost:6060/help/">Help</a>
|
|
<a href="http://localhost:6060/blog/">Blog</a>
|
|
|
|
<input type="text" id="search" name="q" class="inactive" value="Search" placeholder="Search">
|
|
</div>
|
|
</form>
|
|
|
|
</div></div>
|
|
|
|
|
|
|
|
<div id="page" class="wide">
|
|
<div class="container">
|
|
|
|
|
|
<h1>Package pprof</h1>
|
|
|
|
|
|
|
|
|
|
<div id="nav"></div>
|
|
|
|
|
|
<!--
|
|
Copyright 2009 The Go Authors. All rights reserved.
|
|
Use of this source code is governed by a BSD-style
|
|
license that can be found in the LICENSE file.
|
|
-->
|
|
<!--
|
|
Note: Static (i.e., not template-generated) href and id
|
|
attributes start with "pkg-" to make it impossible for
|
|
them to conflict with generated attributes (some of which
|
|
correspond to Go identifiers).
|
|
-->
|
|
|
|
<script type='text/javascript'>
|
|
document.ANALYSIS_DATA = null;
|
|
document.CALLGRAPH = null;
|
|
</script>
|
|
|
|
|
|
|
|
<div id="short-nav">
|
|
<dl>
|
|
<dd><code>import "net/http/pprof"</code></dd>
|
|
</dl>
|
|
<dl>
|
|
<dd><a href="index.html#pkg-overview" class="overviewLink">Overview</a></dd>
|
|
<dd><a href="index.html#pkg-index" class="indexLink">Index</a></dd>
|
|
|
|
|
|
</dl>
|
|
</div>
|
|
<!-- The package's Name is printed as title by the top-level template -->
|
|
<div id="pkg-overview" class="toggleVisible">
|
|
<div class="collapsed">
|
|
<h2 class="toggleButton" title="Click to show Overview section">Overview ▹</h2>
|
|
</div>
|
|
<div class="expanded">
|
|
<h2 class="toggleButton" title="Click to hide Overview section">Overview ▾</h2>
|
|
<p>
|
|
Package pprof serves via its HTTP server runtime profiling data
|
|
in the format expected by the pprof visualization tool.
|
|
For more information about pprof, see
|
|
<a href="http://code.google.com/p/google-perftools/">http://code.google.com/p/google-perftools/</a>.
|
|
</p>
|
|
<p>
|
|
The package is typically only imported for the side effect of
|
|
registering its HTTP handlers.
|
|
The handled paths all begin with /debug/pprof/.
|
|
</p>
|
|
<p>
|
|
To use pprof, link this package into your program:
|
|
</p>
|
|
<pre>import _ "net/http/pprof"
|
|
</pre>
|
|
<p>
|
|
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:
|
|
</p>
|
|
<pre>go func() {
|
|
log.Println(http.ListenAndServe("localhost:6060", nil))
|
|
}()
|
|
</pre>
|
|
<p>
|
|
Then use the pprof tool to look at the heap profile:
|
|
</p>
|
|
<pre>go tool pprof <a href="http://localhost:6060/debug/pprof/heap">http://localhost:6060/debug/pprof/heap</a>
|
|
</pre>
|
|
<p>
|
|
Or to look at a 30-second CPU profile:
|
|
</p>
|
|
<pre>go tool pprof <a href="http://localhost:6060/debug/pprof/profile">http://localhost:6060/debug/pprof/profile</a>
|
|
</pre>
|
|
<p>
|
|
Or to look at the goroutine blocking profile:
|
|
</p>
|
|
<pre>go tool pprof <a href="http://localhost:6060/debug/pprof/block">http://localhost:6060/debug/pprof/block</a>
|
|
</pre>
|
|
<p>
|
|
Or to collect a 5-second execution trace:
|
|
</p>
|
|
<pre>wget <a href="http://localhost:6060/debug/pprof/trace?seconds=5">http://localhost:6060/debug/pprof/trace?seconds=5</a>
|
|
</pre>
|
|
<p>
|
|
To view all available profiles, open <a href="http://localhost:6060/debug/pprof/">http://localhost:6060/debug/pprof/</a>
|
|
in your browser.
|
|
</p>
|
|
<p>
|
|
For a study of the facility in action, visit
|
|
</p>
|
|
<pre><a href="https://blog.golang.org/2011/06/profiling-go-programs.html">https://blog.golang.org/2011/06/profiling-go-programs.html</a>
|
|
</pre>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div id="pkg-index" class="toggleVisible">
|
|
<div class="collapsed">
|
|
<h2 class="toggleButton" title="Click to show Index section">Index ▹</h2>
|
|
</div>
|
|
<div class="expanded">
|
|
<h2 class="toggleButton" title="Click to hide Index section">Index ▾</h2>
|
|
|
|
<!-- Table of contents for API; must be named manual-nav to turn off auto nav. -->
|
|
<div id="manual-nav">
|
|
<dl>
|
|
|
|
|
|
|
|
|
|
<dd><a href="index.html#Cmdline">func Cmdline(w http.ResponseWriter, r *http.Request)</a></dd>
|
|
|
|
|
|
<dd><a href="index.html#Handler">func Handler(name string) http.Handler</a></dd>
|
|
|
|
|
|
<dd><a href="index.html#Index">func Index(w http.ResponseWriter, r *http.Request)</a></dd>
|
|
|
|
|
|
<dd><a href="index.html#Profile">func Profile(w http.ResponseWriter, r *http.Request)</a></dd>
|
|
|
|
|
|
<dd><a href="index.html#Symbol">func Symbol(w http.ResponseWriter, r *http.Request)</a></dd>
|
|
|
|
|
|
<dd><a href="index.html#Trace">func Trace(w http.ResponseWriter, r *http.Request)</a></dd>
|
|
|
|
|
|
|
|
</dl>
|
|
</div><!-- #manual-nav -->
|
|
|
|
|
|
|
|
|
|
<h4>Package files</h4>
|
|
<p>
|
|
<span style="font-size:90%">
|
|
|
|
<a href="http://localhost:6060/src/net/http/pprof/pprof.go">pprof.go</a>
|
|
|
|
</span>
|
|
</p>
|
|
|
|
</div><!-- .expanded -->
|
|
</div><!-- #pkg-index -->
|
|
|
|
<div id="pkg-callgraph" class="toggle" style="display: none">
|
|
<div class="collapsed">
|
|
<h2 class="toggleButton" title="Click to show Internal Call Graph section">Internal call graph ▹</h2>
|
|
</div> <!-- .expanded -->
|
|
<div class="expanded">
|
|
<h2 class="toggleButton" title="Click to hide Internal Call Graph section">Internal call graph ▾</h2>
|
|
<p>
|
|
In the call graph viewer below, each node
|
|
is a function belonging to this package
|
|
and its children are the functions it
|
|
calls—perhaps dynamically.
|
|
</p>
|
|
<p>
|
|
The root nodes are the entry points of the
|
|
package: functions that may be called from
|
|
outside the package.
|
|
There may be non-exported or anonymous
|
|
functions among them if they are called
|
|
dynamically from another package.
|
|
</p>
|
|
<p>
|
|
Click a node to visit that function's source code.
|
|
From there you can visit its callers by
|
|
clicking its declaring <code>func</code>
|
|
token.
|
|
</p>
|
|
<p>
|
|
Functions may be omitted if they were
|
|
determined to be unreachable in the
|
|
particular programs or tests that were
|
|
analyzed.
|
|
</p>
|
|
<!-- Zero means show all package entry points. -->
|
|
<ul style="margin-left: 0.5in" id="callgraph-0" class="treeview"></ul>
|
|
</div>
|
|
</div> <!-- #pkg-callgraph -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="Cmdline">func <a href="http://localhost:6060/src/net/http/pprof/pprof.go?s=2215:2267#L68">Cmdline</a></h2>
|
|
<pre>func Cmdline(w <a href="../index.html">http</a>.<a href="../index.html#ResponseWriter">ResponseWriter</a>, r *<a href="../index.html">http</a>.<a href="../index.html#Request">Request</a>)</pre>
|
|
<p>
|
|
Cmdline responds with the running program's
|
|
command line, with arguments separated by NUL bytes.
|
|
The package initialization registers it as /debug/pprof/cmdline.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="Handler">func <a href="http://localhost:6060/src/net/http/pprof/pprof.go?s=5733:5771#L181">Handler</a></h2>
|
|
<pre>func Handler(name <a href="../../../builtin/index.html#string">string</a>) <a href="../index.html">http</a>.<a href="../index.html#Handler">Handler</a></pre>
|
|
<p>
|
|
Handler returns an HTTP handler that serves the named profile.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="Index">func <a href="http://localhost:6060/src/net/http/pprof/pprof.go?s=6493:6543#L208">Index</a></h2>
|
|
<pre>func Index(w <a href="../index.html">http</a>.<a href="../index.html#ResponseWriter">ResponseWriter</a>, r *<a href="../index.html">http</a>.<a href="../index.html#Request">Request</a>)</pre>
|
|
<p>
|
|
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.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="Profile">func <a href="http://localhost:6060/src/net/http/pprof/pprof.go?s=2725:2777#L86">Profile</a></h2>
|
|
<pre>func Profile(w <a href="../index.html">http</a>.<a href="../index.html#ResponseWriter">ResponseWriter</a>, r *<a href="../index.html">http</a>.<a href="../index.html#Request">Request</a>)</pre>
|
|
<p>
|
|
Profile responds with the pprof-formatted cpu profile.
|
|
The package initialization registers it as /debug/pprof/profile.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="Symbol">func <a href="http://localhost:6060/src/net/http/pprof/pprof.go?s=4557:4608#L135">Symbol</a></h2>
|
|
<pre>func Symbol(w <a href="../index.html">http</a>.<a href="../index.html#ResponseWriter">ResponseWriter</a>, r *<a href="../index.html">http</a>.<a href="../index.html#Request">Request</a>)</pre>
|
|
<p>
|
|
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.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="Trace">func <a href="http://localhost:6060/src/net/http/pprof/pprof.go?s=3674:3724#L111">Trace</a></h2>
|
|
<pre>func Trace(w <a href="../index.html">http</a>.<a href="../index.html#ResponseWriter">ResponseWriter</a>, r *<a href="../index.html">http</a>.<a href="../index.html#Request">Request</a>)</pre>
|
|
<p>
|
|
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.
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div id="footer">
|
|
Build version go1.6.<br>
|
|
Except as <a href="https://developers.google.com/site-policies#restrictions">noted</a>,
|
|
the content of this page is licensed under the
|
|
Creative Commons Attribution 3.0 License,
|
|
and code is licensed under a <a href="http://localhost:6060/LICENSE">BSD license</a>.<br>
|
|
<a href="http://localhost:6060/doc/tos.html">Terms of Service</a> |
|
|
<a href="http://www.google.com/intl/en/policies/privacy/">Privacy Policy</a>
|
|
</div>
|
|
|
|
</div><!-- .container -->
|
|
</div><!-- #page -->
|
|
|
|
<!-- TODO(adonovan): load these from <head> using "defer" attribute? -->
|
|
<script type="text/javascript" src="../../../../lib/godoc/jquery.js"></script>
|
|
<script type="text/javascript" src="../../../../lib/godoc/jquery.treeview.js"></script>
|
|
<script type="text/javascript" src="../../../../lib/godoc/jquery.treeview.edit.js"></script>
|
|
|
|
|
|
<script type="text/javascript" src="../../../../lib/godoc/godocs.js"></script>
|
|
|
|
</body>
|
|
</html>
|
|
|