]> Cypherpunks.ru repositories - gostls13.git/blobdiff - src/runtime/metrics/doc.go
crypto/tls: remove RSA KEX ciphers from the default list
[gostls13.git] / src / runtime / metrics / doc.go
index 44e2676ac5d8cff4ef96e2b6f123fce8af6ccb18..78b2e6c3bce99972a8a1fb0ebd07d6696c89d018 100644 (file)
@@ -18,7 +18,7 @@ metric sets may not intersect.
 
 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
+Descriptions returned by [All]. Each [Description] also includes useful information
 about the metric.
 
 Thus, users of this API are encouraged to sample supported metrics defined by the
@@ -66,11 +66,9 @@ Below is the full list of supported metrics, ordered lexicographically.
 
        /cpu/classes/gc/mark/dedicated:cpu-seconds
                Estimated total CPU time spent performing GC tasks on processors
-               (as defined by GOMAXPROCS) dedicated to those tasks. This
-               includes time spent with the world stopped due to the GC. This
-               metric is an overestimate, and not directly comparable to system
-               CPU time measurements. Compare only with other /cpu/classes
-               metrics.
+               (as defined by GOMAXPROCS) dedicated to those tasks. This metric
+               is an overestimate, and not directly comparable to system CPU
+               time measurements. Compare only with other /cpu/classes metrics.
 
        /cpu/classes/gc/mark/idle:cpu-seconds
                Estimated total CPU time spent performing GC tasks on spare CPU
@@ -236,6 +234,22 @@ Below is the full list of supported metrics, ordered lexicographically.
                The number of non-default behaviors executed by the os/exec
                package due to a non-default GODEBUG=execerrdot=... setting.
 
+       /godebug/non-default-behavior/gocachehash:events
+               The number of non-default behaviors executed by the cmd/go
+               package due to a non-default GODEBUG=gocachehash=... setting.
+
+       /godebug/non-default-behavior/gocachetest:events
+               The number of non-default behaviors executed by the cmd/go
+               package due to a non-default GODEBUG=gocachetest=... setting.
+
+       /godebug/non-default-behavior/gocacheverify:events
+               The number of non-default behaviors executed by the cmd/go
+               package due to a non-default GODEBUG=gocacheverify=... setting.
+
+       /godebug/non-default-behavior/gotypesalias:events
+               The number of non-default behaviors executed by the go/types
+               package due to a non-default GODEBUG=gotypesalias=... setting.
+
        /godebug/non-default-behavior/http2client:events
                The number of non-default behaviors executed by the net/http
                package due to a non-default GODEBUG=http2client=... setting.
@@ -244,6 +258,15 @@ Below is the full list of supported metrics, ordered lexicographically.
                The number of non-default behaviors executed by the net/http
                package due to a non-default GODEBUG=http2server=... setting.
 
+       /godebug/non-default-behavior/httplaxcontentlength:events
+               The number of non-default behaviors executed by the net/http
+               package due to a non-default GODEBUG=httplaxcontentlength=...
+               setting.
+
+       /godebug/non-default-behavior/httpmuxgo121:events
+               The number of non-default behaviors executed by the net/http
+               package due to a non-default GODEBUG=httpmuxgo121=... setting.
+
        /godebug/non-default-behavior/installgoroot:events
                The number of non-default behaviors executed by the go/build
                package due to a non-default GODEBUG=installgoroot=... setting.
@@ -263,6 +286,10 @@ Below is the full list of supported metrics, ordered lexicographically.
                the mime/multipart package due to a non-default
                GODEBUG=multipartmaxparts=... setting.
 
+       /godebug/non-default-behavior/multipathtcp:events
+               The number of non-default behaviors executed by the net package
+               due to a non-default GODEBUG=multipathtcp=... setting.
+
        /godebug/non-default-behavior/panicnil:events
                The number of non-default behaviors executed by the runtime
                package due to a non-default GODEBUG=panicnil=... setting.
@@ -276,6 +303,18 @@ Below is the full list of supported metrics, ordered lexicographically.
                package due to a non-default GODEBUG=tarinsecurepath=...
                setting.
 
+       /godebug/non-default-behavior/tls10server:events
+               The number of non-default behaviors executed by the crypto/tls
+               package due to a non-default GODEBUG=tls10server=... setting.
+
+       /godebug/non-default-behavior/tlsmaxrsasize:events
+               The number of non-default behaviors executed by the crypto/tls
+               package due to a non-default GODEBUG=tlsmaxrsasize=... setting.
+
+       /godebug/non-default-behavior/tlsrsakex:events
+               The number of non-default behaviors executed by the crypto/tls
+               package due to a non-default GODEBUG=tlsrsakex=... setting.
+
        /godebug/non-default-behavior/x509sha1:events
                The number of non-default behaviors executed by the crypto/x509
                package due to a non-default GODEBUG=x509sha1=... setting.
@@ -308,7 +347,10 @@ Below is the full list of supported metrics, ordered lexicographically.
 
        /memory/classes/heap/stacks:bytes
                Memory allocated from the heap that is reserved for stack space,
-               whether or not it is currently in-use.
+               whether or not it is currently in-use. Currently, this
+               represents all stack memory for goroutines. It also includes all
+               OS thread stacks in non-cgo programs. Note that stacks may be
+               allocated differently in the future, and this may change.
 
        /memory/classes/heap/unused:bytes
                Memory that is reserved for heap objects but is not currently
@@ -335,6 +377,12 @@ Below is the full list of supported metrics, ordered lexicographically.
 
        /memory/classes/os-stacks:bytes
                Stack memory allocated by the underlying operating system.
+               In non-cgo programs this metric is currently zero. This may
+               change in the future.In cgo programs this metric includes
+               OS thread stacks allocated directly from the OS. Currently,
+               this only accounts for one stack in c-shared and c-archive build
+               modes, and other sources of stacks from the OS are not measured.
+               This too may change in the future.
 
        /memory/classes/other:bytes
                Memory used by execution trace buffers, structures for debugging