diff options
| author | Emmanuel Odeke <emm.odeke@gmail.com> | 2016-05-22 02:20:11 -0700 |
|---|---|---|
| committer | Austin Clements <austin@google.com> | 2016-06-01 19:06:43 +0000 |
| commit | 77026ef902d3fa21597400d230701979bc1f0efc (patch) | |
| tree | 138c767e8f1051355b4af0bb8c6a5fac7190fbfa | |
| parent | bc4fdfdbfe6b971fcceaf4d75514a882917df10d (diff) | |
| download | go-77026ef902d3fa21597400d230701979bc1f0efc.tar.xz | |
runtime: document heap scavenger memory summary
Fixes #15212.
Change-Id: I2628ec8333330721cddc5145af1ffda6f3e0c63f
Reviewed-on: https://go-review.googlesource.com/23319
Reviewed-by: Austin Clements <austin@google.com>
| -rw-r--r-- | src/runtime/extern.go | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/src/runtime/extern.go b/src/runtime/extern.go index 1df8691cfc..441dcd9702 100644 --- a/src/runtime/extern.go +++ b/src/runtime/extern.go @@ -82,6 +82,21 @@ It is a comma-separated list of name=val pairs setting these named variables: If the line ends with "(forced)", this GC was forced by a runtime.GC() call and all phases are STW. + Setting gctrace to any value > 0 also causes the garbage collector + to emit a summary when memory is released back to the system. + This process of returning memory to the system is called scavenging. + The format of this summary is subject to change. + Currently it is: + scvg#: # MB released printed only if non-zero + scvg#: inuse: # idle: # sys: # released: # consumed: # (MB) + where the fields are as follows: + scvg# the scavenge cycle number, incremented at each scavenge + inuse: # MB used or partially used spans + idle: # MB spans pending scavenging + sys: # MB mapped from the system + released: # MB released to the system + consumed: # MB allocated from the system + memprofilerate: setting memprofilerate=X will update the value of runtime.MemProfileRate. When set to 0 memory profiling is disabled. Refer to the description of MemProfileRate for the default value. |