]> Cypherpunks repositories - gostls13.git/commitdiff
runtime/metrics: document runtime-internal locks in /sync/mutex/wait/total:seconds
authorMichael Pratt <mpratt@google.com>
Mon, 4 Dec 2023 20:12:25 +0000 (15:12 -0500)
committerGopher Robot <gobot@golang.org>
Wed, 6 Dec 2023 17:59:12 +0000 (17:59 +0000)
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>

src/runtime/metrics/description.go
src/runtime/metrics/doc.go

index abe7440f107712fb73c75abf4d9449dd1881ced6..19a7dbf07a6a0b1ce152734fdd5044a11bc3cef5 100644 (file)
@@ -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,
        },
index 8df475666e5903d1eda18a840c85169b114dd8e7..ba153174a6e379c796eef891bdd801e40b098b2f 100644 (file)
@@ -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