runtime/metrics: add the last GC cycle that had the limiter enabled

This metric exports the the last GC cycle index that the GC limiter was
enabled. This metric is useful for debugging and identifying the root
cause of OOMs, especially when SetMemoryLimit is in use.

For #48409.

Change-Id: Ic6383b19e88058366a74f6ede1683b8ffb30a69c
Reviewed-on: https://go-review.googlesource.com/c/go/+/403614
TryBot-Result: Gopher Robot <gobot@golang.org>
Reviewed-by: David Chase <drchase@google.com>
Run-TryBot: Michael Knyszek <mknyszek@google.com>
This commit is contained in:
Michael Anthony Knyszek 2022-05-13 15:14:54 +00:00 committed by Michael Knyszek
parent 9bd6e2776f
commit cfccb5cb7c
4 changed files with 29 additions and 2 deletions

View file

@ -102,6 +102,13 @@ Below is the full list of supported metrics, ordered lexicographically.
only their block. Each block is already accounted for in
allocs-by-size and frees-by-size.
/gc/limiter/last-enabled:gc-cycle
GC cycle the last time the GC CPU limiter was enabled.
This metric is useful for diagnosing the root cause of an out-of-memory
error, because the limiter trades memory for CPU time when the GC's CPU
time gets too high. This is most likely to occur with use of SetMemoryLimit.
The first GC cycle is cycle 1, so a value of 0 indicates that it was never enabled.
/gc/pauses:seconds
Distribution individual GC-related stop-the-world pause latencies.