File tree Expand file tree Collapse file tree 1 file changed +3
-2
lines changed Expand file tree Collapse file tree 1 file changed +3
-2
lines changed Original file line number Diff line number Diff line change 8
8
/*
9
9
Package metrics provides a stable interface to access implementation-defined
10
10
metrics exported by the Go runtime. This package is similar to existing functions
11
- like [runtime.ReadMemStats] and [debug.ReadGCStats], but significantly more general.
11
+ like [runtime.ReadMemStats] and [runtime/ debug.ReadGCStats], but significantly more general.
12
12
13
13
The set of metrics defined by this package may evolve as the runtime itself
14
14
evolves, and also enables variation across Go implementations, whose relevant
@@ -28,7 +28,8 @@ encouraged to use build tags, and although metrics may be deprecated and removed
28
28
users should consider this to be an exceptional and rare event, coinciding with a
29
29
very large change in a particular Go implementation.
30
30
31
- Each metric key also has a "kind" that describes the format of the metric's value.
31
+ Each metric key also has a "kind" (see [ValueKind]) that describes the format of the
32
+ metric's value.
32
33
In the interest of not breaking users of this package, the "kind" for a given metric
33
34
is guaranteed not to change. If it must change, then a new metric will be introduced
34
35
with a new key and a new "kind."
You can’t perform that action at this time.
0 commit comments