qbit/go
1
0
Fork 0
mirror of https://github.com/golang/go synced 2024-11-19 16:44:43 -07:00
Code Releases Activity

runtime/trace: improve package doc

Browse Source 
Explaining how to enable tracing.

Change-Id: Ic8391cb290742b4dc1efab15deba85853e182b4d
Reviewed-on: https://go-review.googlesource.com/59612
Reviewed-by: Heschi Kreinick <heschi@google.com>
This commit is contained in:
Hana Kim 2017-08-28 17:34:33 -04:00 committed by Hyang-Ah Hana Kim
parent 0cf7e54f2f
commit 931c43328a
1 changed files with 30 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
src/runtime/trace/trace.go
View File

@ -2,13 +2,36 @@
// Use of this source code is governed by a BSD-style // Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file. // license that can be found in the LICENSE file.
// Go execution tracer. // Package trace contains facilities for programs to generate trace
// The tracer captures a wide range of execution events like goroutine // for Go execution tracer.
// creation/blocking/unblocking, syscall enter/exit/block, GC-related events, //
// changes of heap size, processor start/stop, etc and writes them to an io.Writer // The execution trace captures a wide range of execution events such as
// in a compact form. A precise nanosecond-precision timestamp and a stack // goroutine creation/blocking/unblocking, syscall enter/exit/block,
// trace is captured for most events. A trace can be analyzed later with // GC-related events, changes of heap size, processor stop/stop, etc.
// 'go tool trace' command. // A precise nanosecond-precision timestamp and a stack trace is
// captured for most events. The generated trace can be interpreted
// using `go tool trace`.
//
// Tracing a Go program
//
// Support for tracing tests and benchmarks built with the standard
// testing package is built into `go test`. For example, the following
// command runs the test in the current directory and writes the trace
// file (trace.out).
//
// go test -trace=test.out
//
// This runtime/trace package provides APIs to add equivalent tracing
// support to a standalone program. See the Example that demonstrates
// how to use this API to enable tracing.
//
// There is also a standard HTTP interface to profiling data. Adding the
// following line will install handlers under the /debug/pprof/trace URL
// to download live profiles:
//
// import _ "net/http/pprof"
//
// See the net/http/pprof package for more details.
package trace package trace
import ( import (