diff options
| author | Michael Pratt <mpratt@google.com> | 2023-12-04 15:12:25 -0500 |
|---|---|---|
| committer | Gopher Robot <gobot@golang.org> | 2023-12-06 17:59:12 +0000 |
| commit | 3f2bf706f7f6c260cb83410131d3c2d508e05a94 (patch) | |
| tree | cf706e72521dfe466310513e84a0c3b2334e5f87 /src/runtime | |
| parent | 98fd8f5768169c1c9cc9ae20490bd1b63ea55461 (diff) | |
| download | go-3f2bf706f7f6c260cb83410131d3c2d508e05a94.tar.xz | |
runtime/metrics: document runtime-internal locks in /sync/mutex/wait/total:seconds
For #57071.
Change-Id: I7ce6c35bed95a6ea3cdc17007f861c5dd82404d2
Reviewed-on: https://go-review.googlesource.com/c/go/+/547056
Auto-Submit: Michael Pratt <mpratt@google.com>
Reviewed-by: Rhys Hiltner <rhys@justin.tv>
Reviewed-by: Michael Knyszek <mknyszek@google.com>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Diffstat (limited to 'src/runtime')
| -rw-r--r-- | src/runtime/metrics/description.go | 2 | ||||
| -rw-r--r-- | src/runtime/metrics/doc.go | 10 |
2 files changed, 6 insertions, 6 deletions
diff --git a/src/runtime/metrics/description.go b/src/runtime/metrics/description.go index abe7440f10..19a7dbf07a 100644 --- a/src/runtime/metrics/description.go +++ b/src/runtime/metrics/description.go @@ -441,7 +441,7 @@ var allDesc = []Description{ }, { Name: "/sync/mutex/wait/total:seconds", - Description: "Approximate cumulative time goroutines have spent blocked on a sync.Mutex or sync.RWMutex. This metric is useful for identifying global changes in lock contention. Collect a mutex or block profile using the runtime/pprof package for more detailed contention data.", + Description: "Approximate cumulative time goroutines have spent blocked on a sync.Mutex, sync.RWMutex, or runtime-internal lock. This metric is useful for identifying global changes in lock contention. Collect a mutex or block profile using the runtime/pprof package for more detailed contention data.", Kind: KindFloat64, Cumulative: true, }, diff --git a/src/runtime/metrics/doc.go b/src/runtime/metrics/doc.go index 8df475666e..ba153174a6 100644 --- a/src/runtime/metrics/doc.go +++ b/src/runtime/metrics/doc.go @@ -447,10 +447,10 @@ Below is the full list of supported metrics, ordered lexicographically. monotonically. /sync/mutex/wait/total:seconds - Approximate cumulative time goroutines have spent blocked - on a sync.Mutex or sync.RWMutex. This metric is useful for - identifying global changes in lock contention. Collect a mutex - or block profile using the runtime/pprof package for more - detailed contention data. + Approximate cumulative time goroutines have spent blocked on a + sync.Mutex, sync.RWMutex, or runtime-internal lock. This metric + is useful for identifying global changes in lock contention. + Collect a mutex or block profile using the runtime/pprof package + for more detailed contention data. */ package metrics |