aboutsummaryrefslogtreecommitdiff
path: root/src/runtime
diff options
context:
space:
mode:
authorCherry Zhang <cherryyz@google.com>2021-02-16 16:18:18 -0500
committerCherry Zhang <cherryyz@google.com>2021-02-16 16:18:19 -0500
commit03cea563d156736a916137d0f68a14dc86c552a0 (patch)
tree0d12c5f6ff0f08adffbfc38c283f606deb474318 /src/runtime
parentb8fb049c7ad4940901613d16629a88b38c6a82da (diff)
parent5faf941df067b33485edb9cd2e880869e7feb6a3 (diff)
downloadgo-03cea563d156736a916137d0f68a14dc86c552a0.tar.xz
[dev.regabi] all: merge master (5faf941) into dev.regabi
Merge List: + 2021-02-16 5faf941df0 internal/goversion: update Version to 1.17 + 2021-02-16 6f3da9d2f6 README: pull gopher image from website + 2021-02-16 098504c73f cmd/link: generate trampoline for inter-dependent packages + 2021-02-16 1004a7cb31 runtime/metrics: update documentation to current interface + 2021-02-16 6530f2617f doc/go1.16: remove draft notice + 2021-02-16 353e111455 doc/go1.16: fix mismatched id attribute + 2021-02-16 f0d23c9dbb internal/poll: netpollcheckerr before sendfile + 2021-02-16 0cb3415154 doc: remove all docs not tied to distribution + 2021-02-16 626ef08127 doc: remove install.html and install-source.html + 2021-02-16 30641e36aa internal/poll: if copy_file_range returns 0, assume it failed + 2021-02-15 33d72fd412 doc/faq: update generics entry to reflect accepted proposal + 2021-02-15 852ce7c212 cmd/go: provide a more helpful suggestion for "go vet -?" + 2021-02-13 66c27093d0 cmd/link: fix typo in link_test.go Change-Id: I98f047b79b93c5ceb344dd43408bcb919b23aeb3
Diffstat (limited to 'src/runtime')
-rw-r--r--src/runtime/metrics/doc.go4
-rw-r--r--src/runtime/metrics/sample.go2
2 files changed, 2 insertions, 4 deletions
diff --git a/src/runtime/metrics/doc.go b/src/runtime/metrics/doc.go
index 5da050f973..7f790afc12 100644
--- a/src/runtime/metrics/doc.go
+++ b/src/runtime/metrics/doc.go
@@ -16,9 +16,7 @@ Interface
Metrics are designated by a string key, rather than, for example, a field name in
a struct. The full list of supported metrics is always available in the slice of
Descriptions returned by All. Each Description also includes useful information
-about the metric, such as how to display it (for example, gauge vs. counter)
-and how difficult or disruptive it is to obtain it (for example, do you need to
-stop the world?).
+about the metric.
Thus, users of this API are encouraged to sample supported metrics defined by the
slice returned by All to remain compatible across Go versions. Of course, situations
diff --git a/src/runtime/metrics/sample.go b/src/runtime/metrics/sample.go
index b3933e266e..4cf8cdf799 100644
--- a/src/runtime/metrics/sample.go
+++ b/src/runtime/metrics/sample.go
@@ -14,7 +14,7 @@ type Sample struct {
// Name is the name of the metric sampled.
//
// It must correspond to a name in one of the metric descriptions
- // returned by Descriptions.
+ // returned by All.
Name string
// Value is the value of the metric sample.