1 // Copyright 2020 The Go Authors. All rights reserved. 2 // Use of this source code is governed by a BSD-style 3 // license that can be found in the LICENSE file. 4 5 // Note: run 'go generate' (which will run 'go test -generate') to update the "Supported metrics" list. 6 //go:generate go test -run=Docs -generate 7 8 /* 9 Package metrics provides a stable interface to access implementation-defined 10 metrics exported by the Go runtime. This package is similar to existing functions 11 like [runtime.ReadMemStats] and [runtime/debug.ReadGCStats], but significantly more general. 12 13 The set of metrics defined by this package may evolve as the runtime itself 14 evolves, and also enables variation across Go implementations, whose relevant 15 metric sets may not intersect. 16 17 # Interface 18 19 Metrics are designated by a string key, rather than, for example, a field name in 20 a struct. The full list of supported metrics is always available in the slice of 21 Descriptions returned by [All]. Each [Description] also includes useful information 22 about the metric. 23 24 Thus, users of this API are encouraged to sample supported metrics defined by the 25 slice returned by All to remain compatible across Go versions. Of course, situations 26 arise where reading specific metrics is critical. For these cases, users are 27 encouraged to use build tags, and although metrics may be deprecated and removed, 28 users should consider this to be an exceptional and rare event, coinciding with a 29 very large change in a particular Go implementation. 30 31 Each metric key also has a "kind" (see [ValueKind]) that describes the format of the 32 metric's value. 33 In the interest of not breaking users of this package, the "kind" for a given metric 34 is guaranteed not to change. If it must change, then a new metric will be introduced 35 with a new key and a new "kind." 36 37 # Metric key format 38 39 As mentioned earlier, metric keys are strings. Their format is simple and well-defined, 40 designed to be both human and machine readable. It is split into two components, 41 separated by a colon: a rooted path and a unit. The choice to include the unit in 42 the key is motivated by compatibility: if a metric's unit changes, its semantics likely 43 did also, and a new key should be introduced. 44 45 For more details on the precise definition of the metric key's path and unit formats, see 46 the documentation of the Name field of the Description struct. 47 48 # A note about floats 49 50 This package supports metrics whose values have a floating-point representation. In 51 order to improve ease-of-use, this package promises to never produce the following 52 classes of floating-point values: NaN, infinity. 53 54 # Supported metrics 55 56 Below is the full list of supported metrics, ordered lexicographically. 57 58 /cgo/go-to-c-calls:calls 59 Count of calls made from Go to C by the current process. 60 61 /cpu/classes/gc/mark/assist:cpu-seconds 62 Estimated total CPU time goroutines spent performing GC 63 tasks to assist the GC and prevent it from falling behind the 64 application. This metric is an overestimate, and not directly 65 comparable to system CPU time measurements. Compare only with 66 other /cpu/classes metrics. 67 68 /cpu/classes/gc/mark/dedicated:cpu-seconds 69 Estimated total CPU time spent performing GC tasks on processors 70 (as defined by GOMAXPROCS) dedicated to those tasks. This metric 71 is an overestimate, and not directly comparable to system CPU 72 time measurements. Compare only with other /cpu/classes metrics. 73 74 /cpu/classes/gc/mark/idle:cpu-seconds 75 Estimated total CPU time spent performing GC tasks on spare CPU 76 resources that the Go scheduler could not otherwise find a use 77 for. This should be subtracted from the total GC CPU time to 78 obtain a measure of compulsory GC CPU time. This metric is an 79 overestimate, and not directly comparable to system CPU time 80 measurements. Compare only with other /cpu/classes metrics. 81 82 /cpu/classes/gc/pause:cpu-seconds 83 Estimated total CPU time spent with the application paused by 84 the GC. Even if only one thread is running during the pause, 85 this is computed as GOMAXPROCS times the pause latency because 86 nothing else can be executing. This is the exact sum of samples 87 in /sched/pauses/total/gc:seconds if each sample is multiplied 88 by GOMAXPROCS at the time it is taken. This metric is an 89 overestimate, and not directly comparable to system CPU time 90 measurements. Compare only with other /cpu/classes metrics. 91 92 /cpu/classes/gc/total:cpu-seconds 93 Estimated total CPU time spent performing GC tasks. This metric 94 is an overestimate, and not directly comparable to system CPU 95 time measurements. Compare only with other /cpu/classes metrics. 96 Sum of all metrics in /cpu/classes/gc. 97 98 /cpu/classes/idle:cpu-seconds 99 Estimated total available CPU time not spent executing 100 any Go or Go runtime code. In other words, the part of 101 /cpu/classes/total:cpu-seconds that was unused. This metric is 102 an overestimate, and not directly comparable to system CPU time 103 measurements. Compare only with other /cpu/classes metrics. 104 105 /cpu/classes/scavenge/assist:cpu-seconds 106 Estimated total CPU time spent returning unused memory to the 107 underlying platform in response eagerly to memory pressure. This 108 metric is an overestimate, and not directly comparable to system 109 CPU time measurements. Compare only with other /cpu/classes 110 metrics. 111 112 /cpu/classes/scavenge/background:cpu-seconds 113 Estimated total CPU time spent performing background tasks to 114 return unused memory to the underlying platform. This metric is 115 an overestimate, and not directly comparable to system CPU time 116 measurements. Compare only with other /cpu/classes metrics. 117 118 /cpu/classes/scavenge/total:cpu-seconds 119 Estimated total CPU time spent performing tasks that return 120 unused memory to the underlying platform. This metric is an 121 overestimate, and not directly comparable to system CPU time 122 measurements. Compare only with other /cpu/classes metrics. 123 Sum of all metrics in /cpu/classes/scavenge. 124 125 /cpu/classes/total:cpu-seconds 126 Estimated total available CPU time for user Go code or the Go 127 runtime, as defined by GOMAXPROCS. In other words, GOMAXPROCS 128 integrated over the wall-clock duration this process has been 129 executing for. This metric is an overestimate, and not directly 130 comparable to system CPU time measurements. Compare only with 131 other /cpu/classes metrics. Sum of all metrics in /cpu/classes. 132 133 /cpu/classes/user:cpu-seconds 134 Estimated total CPU time spent running user Go code. This may 135 also include some small amount of time spent in the Go runtime. 136 This metric is an overestimate, and not directly comparable 137 to system CPU time measurements. Compare only with other 138 /cpu/classes metrics. 139 140 /gc/cleanups/executed:cleanups 141 Approximate total count of cleanup functions (created 142 by runtime.AddCleanup) executed by the runtime. Subtract 143 /gc/cleanups/queued:cleanups to approximate cleanup queue 144 length. Useful for detecting slow cleanups holding up the queue. 145 146 /gc/cleanups/queued:cleanups 147 Approximate total count of cleanup functions (created by 148 runtime.AddCleanup) queued by the runtime for execution. 149 Subtract from /gc/cleanups/executed:cleanups to approximate 150 cleanup queue length. Useful for detecting slow cleanups holding 151 up the queue. 152 153 /gc/cycles/automatic:gc-cycles 154 Count of completed GC cycles generated by the Go runtime. 155 156 /gc/cycles/forced:gc-cycles 157 Count of completed GC cycles forced by the application. 158 159 /gc/cycles/total:gc-cycles 160 Count of all completed GC cycles. 161 162 /gc/finalizers/executed:finalizers 163 Total count of finalizer functions (created by 164 runtime.SetFinalizer) executed by the runtime. Subtract 165 /gc/finalizers/queued:finalizers to approximate finalizer queue 166 length. Useful for detecting finalizers overwhelming the queue, 167 either by being too slow, or by there being too many of them. 168 169 /gc/finalizers/queued:finalizers 170 Total count of finalizer functions (created by 171 runtime.SetFinalizer) and queued by the runtime for execution. 172 Subtract from /gc/finalizers/executed:finalizers to approximate 173 finalizer queue length. Useful for detecting slow finalizers 174 holding up the queue. 175 176 /gc/gogc:percent 177 Heap size target percentage configured by the user, otherwise 178 100. This value is set by the GOGC environment variable, and the 179 runtime/debug.SetGCPercent function. 180 181 /gc/gomemlimit:bytes 182 Go runtime memory limit configured by the user, otherwise 183 math.MaxInt64. This value is set by the GOMEMLIMIT environment 184 variable, and the runtime/debug.SetMemoryLimit function. 185 186 /gc/heap/allocs-by-size:bytes 187 Distribution of heap allocations by approximate size. 188 Bucket counts increase monotonically. Note that this does not 189 include tiny objects as defined by /gc/heap/tiny/allocs:objects, 190 only tiny blocks. 191 192 /gc/heap/allocs:bytes 193 Cumulative sum of memory allocated to the heap by the 194 application. 195 196 /gc/heap/allocs:objects 197 Cumulative count of heap allocations triggered by the 198 application. Note that this does not include tiny objects as 199 defined by /gc/heap/tiny/allocs:objects, only tiny blocks. 200 201 /gc/heap/frees-by-size:bytes 202 Distribution of freed heap allocations by approximate size. 203 Bucket counts increase monotonically. Note that this does not 204 include tiny objects as defined by /gc/heap/tiny/allocs:objects, 205 only tiny blocks. 206 207 /gc/heap/frees:bytes 208 Cumulative sum of heap memory freed by the garbage collector. 209 210 /gc/heap/frees:objects 211 Cumulative count of heap allocations whose storage was freed 212 by the garbage collector. Note that this does not include tiny 213 objects as defined by /gc/heap/tiny/allocs:objects, only tiny 214 blocks. 215 216 /gc/heap/goal:bytes 217 Heap size target for the end of the GC cycle. 218 219 /gc/heap/live:bytes 220 Heap memory occupied by live objects that were marked by the 221 previous GC. 222 223 /gc/heap/objects:objects 224 Number of objects, live or unswept, occupying heap memory. 225 226 /gc/heap/tiny/allocs:objects 227 Count of small allocations that are packed together into blocks. 228 These allocations are counted separately from other allocations 229 because each individual allocation is not tracked by the 230 runtime, only their block. Each block is already accounted for 231 in allocs-by-size and frees-by-size. 232 233 /gc/limiter/last-enabled:gc-cycle 234 GC cycle the last time the GC CPU limiter was enabled. 235 This metric is useful for diagnosing the root cause of an 236 out-of-memory error, because the limiter trades memory for CPU 237 time when the GC's CPU time gets too high. This is most likely 238 to occur with use of SetMemoryLimit. The first GC cycle is cycle 239 1, so a value of 0 indicates that it was never enabled. 240 241 /gc/pauses:seconds 242 Deprecated. Prefer the identical /sched/pauses/total/gc:seconds. 243 244 /gc/scan/globals:bytes 245 The total amount of global variable space that is scannable. 246 247 /gc/scan/heap:bytes 248 The total amount of heap space that is scannable. 249 250 /gc/scan/stack:bytes 251 The number of bytes of stack that were scanned last GC cycle. 252 253 /gc/scan/total:bytes 254 The total amount space that is scannable. Sum of all metrics in 255 /gc/scan. 256 257 /gc/stack/starting-size:bytes 258 The stack size of new goroutines. 259 260 /godebug/non-default-behavior/allowmultiplevcs:events 261 The number of non-default behaviors executed by the cmd/go 262 package due to a non-default GODEBUG=allowmultiplevcs=... 263 setting. 264 265 /godebug/non-default-behavior/containermaxprocs:events 266 The number of non-default behaviors executed by the runtime 267 package due to a non-default GODEBUG=containermaxprocs=... 268 setting. 269 270 /godebug/non-default-behavior/cryptocustomrand:events 271 The number of non-default behaviors executed by the crypto 272 package due to a non-default GODEBUG=cryptocustomrand=... 273 setting. 274 275 /godebug/non-default-behavior/embedfollowsymlinks:events 276 The number of non-default behaviors executed by the cmd/go 277 package due to a non-default GODEBUG=embedfollowsymlinks=... 278 setting. 279 280 /godebug/non-default-behavior/execerrdot:events 281 The number of non-default behaviors executed by the os/exec 282 package due to a non-default GODEBUG=execerrdot=... setting. 283 284 /godebug/non-default-behavior/fips140ems:events 285 The number of non-default behaviors executed by the crypto/tls 286 package due to a non-default GODEBUG=fips140ems=... setting. 287 288 /godebug/non-default-behavior/gocachehash:events 289 The number of non-default behaviors executed by the cmd/go 290 package due to a non-default GODEBUG=gocachehash=... setting. 291 292 /godebug/non-default-behavior/gocachetest:events 293 The number of non-default behaviors executed by the cmd/go 294 package due to a non-default GODEBUG=gocachetest=... setting. 295 296 /godebug/non-default-behavior/gocacheverify:events 297 The number of non-default behaviors executed by the cmd/go 298 package due to a non-default GODEBUG=gocacheverify=... setting. 299 300 /godebug/non-default-behavior/gotestjsonbuildtext:events 301 The number of non-default behaviors executed by the cmd/go 302 package due to a non-default GODEBUG=gotestjsonbuildtext=... 303 setting. 304 305 /godebug/non-default-behavior/htmlmetacontenturlescape:events 306 The number of non-default behaviors executed by 307 the html/template package due to a non-default 308 GODEBUG=htmlmetacontenturlescape=... setting. 309 310 /godebug/non-default-behavior/http2client:events 311 The number of non-default behaviors executed by the net/http 312 package due to a non-default GODEBUG=http2client=... setting. 313 314 /godebug/non-default-behavior/http2server:events 315 The number of non-default behaviors executed by the net/http 316 package due to a non-default GODEBUG=http2server=... setting. 317 318 /godebug/non-default-behavior/httpcookiemaxnum:events 319 The number of non-default behaviors executed by the net/http 320 package due to a non-default GODEBUG=httpcookiemaxnum=... 321 setting. 322 323 /godebug/non-default-behavior/httplaxcontentlength:events 324 The number of non-default behaviors executed by the net/http 325 package due to a non-default GODEBUG=httplaxcontentlength=... 326 setting. 327 328 /godebug/non-default-behavior/httpmuxgo121:events 329 The number of non-default behaviors executed by the net/http 330 package due to a non-default GODEBUG=httpmuxgo121=... setting. 331 332 /godebug/non-default-behavior/httpservecontentkeepheaders:events 333 The number of non-default behaviors executed 334 by the net/http package due to a non-default 335 GODEBUG=httpservecontentkeepheaders=... setting. 336 337 /godebug/non-default-behavior/installgoroot:events 338 The number of non-default behaviors executed by the go/build 339 package due to a non-default GODEBUG=installgoroot=... setting. 340 341 /godebug/non-default-behavior/multipartmaxheaders:events 342 The number of non-default behaviors executed by 343 the mime/multipart package due to a non-default 344 GODEBUG=multipartmaxheaders=... setting. 345 346 /godebug/non-default-behavior/multipartmaxparts:events 347 The number of non-default behaviors executed by 348 the mime/multipart package due to a non-default 349 GODEBUG=multipartmaxparts=... setting. 350 351 /godebug/non-default-behavior/multipathtcp:events 352 The number of non-default behaviors executed by the net package 353 due to a non-default GODEBUG=multipathtcp=... setting. 354 355 /godebug/non-default-behavior/netedns0:events 356 The number of non-default behaviors executed by the net package 357 due to a non-default GODEBUG=netedns0=... setting. 358 359 /godebug/non-default-behavior/panicnil:events 360 The number of non-default behaviors executed by the runtime 361 package due to a non-default GODEBUG=panicnil=... setting. 362 363 /godebug/non-default-behavior/randautoseed:events 364 The number of non-default behaviors executed by the math/rand 365 package due to a non-default GODEBUG=randautoseed=... setting. 366 367 /godebug/non-default-behavior/randseednop:events 368 The number of non-default behaviors executed by the math/rand 369 package due to a non-default GODEBUG=randseednop=... setting. 370 371 /godebug/non-default-behavior/rsa1024min:events 372 The number of non-default behaviors executed by the crypto/rsa 373 package due to a non-default GODEBUG=rsa1024min=... setting. 374 375 /godebug/non-default-behavior/tarinsecurepath:events 376 The number of non-default behaviors executed by the archive/tar 377 package due to a non-default GODEBUG=tarinsecurepath=... 378 setting. 379 380 /godebug/non-default-behavior/tlsmaxrsasize:events 381 The number of non-default behaviors executed by the crypto/tls 382 package due to a non-default GODEBUG=tlsmaxrsasize=... setting. 383 384 /godebug/non-default-behavior/tlssha1:events 385 The number of non-default behaviors executed by the crypto/tls 386 package due to a non-default GODEBUG=tlssha1=... setting. 387 388 /godebug/non-default-behavior/updatemaxprocs:events 389 The number of non-default behaviors executed by the runtime 390 package due to a non-default GODEBUG=updatemaxprocs=... setting. 391 392 /godebug/non-default-behavior/urlmaxqueryparams:events 393 The number of non-default behaviors executed by the net/url 394 package due to a non-default GODEBUG=urlmaxqueryparams=... 395 setting. 396 397 /godebug/non-default-behavior/urlstrictcolons:events 398 The number of non-default behaviors executed by the net/url 399 package due to a non-default GODEBUG=urlstrictcolons=... 400 setting. 401 402 /godebug/non-default-behavior/winreadlinkvolume:events 403 The number of non-default behaviors executed by the os package 404 due to a non-default GODEBUG=winreadlinkvolume=... setting. 405 406 /godebug/non-default-behavior/winsymlink:events 407 The number of non-default behaviors executed by the os package 408 due to a non-default GODEBUG=winsymlink=... setting. 409 410 /godebug/non-default-behavior/x509negativeserial:events 411 The number of non-default behaviors executed by the crypto/x509 412 package due to a non-default GODEBUG=x509negativeserial=... 413 setting. 414 415 /godebug/non-default-behavior/x509rsacrt:events 416 The number of non-default behaviors executed by the crypto/x509 417 package due to a non-default GODEBUG=x509rsacrt=... setting. 418 419 /godebug/non-default-behavior/x509sha256skid:events 420 The number of non-default behaviors executed by the crypto/x509 421 package due to a non-default GODEBUG=x509sha256skid=... setting. 422 423 /godebug/non-default-behavior/x509sslcertoverrideplatform:events 424 The number of non-default behaviors executed by 425 the crypto/x509 package due to a non-default 426 GODEBUG=x509sslcertoverrideplatform=... setting. 427 428 /godebug/non-default-behavior/x509usefallbackroots:events 429 The number of non-default behaviors executed by the crypto/x509 430 package due to a non-default GODEBUG=x509usefallbackroots=... 431 setting. 432 433 /godebug/non-default-behavior/x509usepolicies:events 434 The number of non-default behaviors executed by the crypto/x509 435 package due to a non-default GODEBUG=x509usepolicies=... 436 setting. 437 438 /godebug/non-default-behavior/zipinsecurepath:events 439 The number of non-default behaviors executed by the archive/zip 440 package due to a non-default GODEBUG=zipinsecurepath=... 441 setting. 442 443 /memory/classes/heap/free:bytes 444 Memory that is completely free and eligible to be returned to 445 the underlying system, but has not been. This metric is the 446 runtime's estimate of free address space that is backed by 447 physical memory. 448 449 /memory/classes/heap/objects:bytes 450 Memory occupied by live objects and dead objects that have not 451 yet been marked free by the garbage collector. 452 453 /memory/classes/heap/released:bytes 454 Memory that is completely free and has been returned to the 455 underlying system. This metric is the runtime's estimate of free 456 address space that is still mapped into the process, but is not 457 backed by physical memory. 458 459 /memory/classes/heap/stacks:bytes 460 Memory allocated from the heap that is reserved for stack space, 461 whether or not it is currently in-use. Currently, this 462 represents all stack memory for goroutines. It also includes all 463 OS thread stacks in non-cgo programs. Note that stacks may be 464 allocated differently in the future, and this may change. 465 466 /memory/classes/heap/unused:bytes 467 Memory that is reserved for heap objects but is not currently 468 used to hold heap objects. 469 470 /memory/classes/metadata/mcache/free:bytes 471 Memory that is reserved for runtime mcache structures, but not 472 in-use. 473 474 /memory/classes/metadata/mcache/inuse:bytes 475 Memory that is occupied by runtime mcache structures that are 476 currently being used. 477 478 /memory/classes/metadata/mspan/free:bytes 479 Memory that is reserved for runtime mspan structures, but not 480 in-use. 481 482 /memory/classes/metadata/mspan/inuse:bytes 483 Memory that is occupied by runtime mspan structures that are 484 currently being used. 485 486 /memory/classes/metadata/other:bytes 487 Memory that is reserved for or used to hold runtime metadata. 488 489 /memory/classes/os-stacks:bytes 490 Stack memory allocated by the underlying operating system. 491 In non-cgo programs this metric is currently zero. This may 492 change in the future.In cgo programs this metric includes 493 OS thread stacks allocated directly from the OS. Currently, 494 this only accounts for one stack in c-shared and c-archive build 495 modes, and other sources of stacks from the OS are not measured. 496 This too may change in the future. 497 498 /memory/classes/other:bytes 499 Memory used by execution trace buffers, structures for debugging 500 the runtime, finalizer and profiler specials, and more. 501 502 /memory/classes/profiling/buckets:bytes 503 Memory that is used by the stack trace hash map used for 504 profiling. 505 506 /memory/classes/total:bytes 507 All memory mapped by the Go runtime into the current process 508 as read-write. Note that this does not include memory mapped 509 by code called via cgo or via the syscall package. Sum of all 510 metrics in /memory/classes. 511 512 /sched/gomaxprocs:threads 513 The current runtime.GOMAXPROCS setting, or the number of 514 operating system threads that can execute user-level Go code 515 simultaneously. 516 517 /sched/goroutines-created:goroutines 518 Count of goroutines created since program start. 519 520 /sched/goroutines/not-in-go:goroutines 521 Approximate count of goroutines running or blocked in 522 a system call or cgo call. Not guaranteed to add up to 523 /sched/goroutines:goroutines with other goroutine metrics. 524 525 /sched/goroutines/runnable:goroutines 526 Approximate count of goroutines ready to execute, 527 but not executing. Not guaranteed to add up to 528 /sched/goroutines:goroutines with other goroutine metrics. 529 530 /sched/goroutines/running:goroutines 531 Approximate count of goroutines executing. Always less than or 532 equal to /sched/gomaxprocs:threads. Not guaranteed to add up to 533 /sched/goroutines:goroutines with other goroutine metrics. 534 535 /sched/goroutines/waiting:goroutines 536 Approximate count of goroutines waiting on a resource 537 (I/O or sync primitives). Not guaranteed to add up to 538 /sched/goroutines:goroutines with other goroutine metrics. 539 540 /sched/goroutines:goroutines 541 Count of live goroutines. 542 543 /sched/latencies:seconds 544 Distribution of the time goroutines have spent in the scheduler 545 in a runnable state before actually running. Bucket counts 546 increase monotonically. 547 548 /sched/pauses/stopping/gc:seconds 549 Distribution of individual GC-related stop-the-world stopping 550 latencies. This is the time it takes from deciding to stop the 551 world until all Ps are stopped. This is a subset of the total 552 GC-related stop-the-world time (/sched/pauses/total/gc:seconds). 553 During this time, some threads may be executing. Bucket counts 554 increase monotonically. 555 556 /sched/pauses/stopping/other:seconds 557 Distribution of individual non-GC-related stop-the-world 558 stopping latencies. This is the time it takes from deciding 559 to stop the world until all Ps are stopped. This is a 560 subset of the total non-GC-related stop-the-world time 561 (/sched/pauses/total/other:seconds). During this time, some 562 threads may be executing. Bucket counts increase monotonically. 563 564 /sched/pauses/total/gc:seconds 565 Distribution of individual GC-related stop-the-world pause 566 latencies. This is the time from deciding to stop the world 567 until the world is started again. Some of this time is spent 568 getting all threads to stop (this is measured directly in 569 /sched/pauses/stopping/gc:seconds), during which some threads 570 may still be running. Bucket counts increase monotonically. 571 572 /sched/pauses/total/other:seconds 573 Distribution of individual non-GC-related stop-the-world 574 pause latencies. This is the time from deciding to stop the 575 world until the world is started again. Some of this time 576 is spent getting all threads to stop (measured directly in 577 /sched/pauses/stopping/other:seconds). Bucket counts increase 578 monotonically. 579 580 /sched/threads/total:threads 581 The current count of live threads that are owned by the Go 582 runtime. 583 584 /sync/mutex/wait/total:seconds 585 Approximate cumulative time goroutines have spent blocked on a 586 sync.Mutex, sync.RWMutex, or runtime-internal lock. This metric 587 is useful for identifying global changes in lock contention. 588 Collect a mutex or block profile using the runtime/pprof package 589 for more detailed contention data. 590 */ 591 package metrics 592