From: Michael Pratt <mpratt@google.com>
Date: Mon, 4 Dec 2023 20:12:25 +0000 (-0500)
Subject: runtime/metrics: document runtime-internal locks in /sync/mutex/wait/total:seconds
X-Git-Tag: go1.22rc1~85
X-Git-Url: http://www.git.cypherpunks.su/?a=commitdiff_plain;h=3f2bf706f7f6c260cb83410131d3c2d508e05a94;p=gostls13.git

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>
---

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