313 lines
9.3 KiB
Go
313 lines
9.3 KiB
Go
// Copyright 2018 The Prometheus Authors
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package prometheus
|
|
|
|
import (
|
|
"runtime"
|
|
"runtime/debug"
|
|
runmetr "runtime/metrics"
|
|
"time"
|
|
)
|
|
|
|
// goRuntimeMemStats provides the metrics initially provided by runtime.ReadMemStats.
|
|
// From Go 1.17 those similar (and better) statistics are provided by runtime/metrics, so
|
|
// while eval closure works on runtime.MemStats, the struct from Go 1.17+ is
|
|
// populated using runtime/metrics.
|
|
func goRuntimeMemStats() memStatsMetrics {
|
|
return memStatsMetrics{
|
|
{
|
|
desc: NewDesc(
|
|
memstatNamespace("alloc_bytes"),
|
|
"Number of bytes allocated and still in use.",
|
|
nil, nil,
|
|
),
|
|
eval: func(ms *runtime.MemStats) float64 { return float64(ms.Alloc) },
|
|
valType: GaugeValue,
|
|
}, {
|
|
desc: NewDesc(
|
|
memstatNamespace("alloc_bytes_total"),
|
|
"Total number of bytes allocated, even if freed.",
|
|
nil, nil,
|
|
),
|
|
eval: func(ms *runtime.MemStats) float64 { return float64(ms.TotalAlloc) },
|
|
valType: CounterValue,
|
|
}, {
|
|
desc: NewDesc(
|
|
memstatNamespace("sys_bytes"),
|
|
"Number of bytes obtained from system.",
|
|
nil, nil,
|
|
),
|
|
eval: func(ms *runtime.MemStats) float64 { return float64(ms.Sys) },
|
|
valType: GaugeValue,
|
|
}, {
|
|
desc: NewDesc(
|
|
memstatNamespace("lookups_total"),
|
|
"Total number of pointer lookups.",
|
|
nil, nil,
|
|
),
|
|
eval: func(ms *runtime.MemStats) float64 { return float64(ms.Lookups) },
|
|
valType: CounterValue,
|
|
}, {
|
|
desc: NewDesc(
|
|
memstatNamespace("mallocs_total"),
|
|
"Total number of mallocs.",
|
|
nil, nil,
|
|
),
|
|
eval: func(ms *runtime.MemStats) float64 { return float64(ms.Mallocs) },
|
|
valType: CounterValue,
|
|
}, {
|
|
desc: NewDesc(
|
|
memstatNamespace("frees_total"),
|
|
"Total number of frees.",
|
|
nil, nil,
|
|
),
|
|
eval: func(ms *runtime.MemStats) float64 { return float64(ms.Frees) },
|
|
valType: CounterValue,
|
|
}, {
|
|
desc: NewDesc(
|
|
memstatNamespace("heap_alloc_bytes"),
|
|
"Number of heap bytes allocated and still in use.",
|
|
nil, nil,
|
|
),
|
|
eval: func(ms *runtime.MemStats) float64 { return float64(ms.HeapAlloc) },
|
|
valType: GaugeValue,
|
|
}, {
|
|
desc: NewDesc(
|
|
memstatNamespace("heap_sys_bytes"),
|
|
"Number of heap bytes obtained from system.",
|
|
nil, nil,
|
|
),
|
|
eval: func(ms *runtime.MemStats) float64 { return float64(ms.HeapSys) },
|
|
valType: GaugeValue,
|
|
}, {
|
|
desc: NewDesc(
|
|
memstatNamespace("heap_idle_bytes"),
|
|
"Number of heap bytes waiting to be used.",
|
|
nil, nil,
|
|
),
|
|
eval: func(ms *runtime.MemStats) float64 { return float64(ms.HeapIdle) },
|
|
valType: GaugeValue,
|
|
}, {
|
|
desc: NewDesc(
|
|
memstatNamespace("heap_inuse_bytes"),
|
|
"Number of heap bytes that are in use.",
|
|
nil, nil,
|
|
),
|
|
eval: func(ms *runtime.MemStats) float64 { return float64(ms.HeapInuse) },
|
|
valType: GaugeValue,
|
|
}, {
|
|
desc: NewDesc(
|
|
memstatNamespace("heap_released_bytes"),
|
|
"Number of heap bytes released to OS.",
|
|
nil, nil,
|
|
),
|
|
eval: func(ms *runtime.MemStats) float64 { return float64(ms.HeapReleased) },
|
|
valType: GaugeValue,
|
|
}, {
|
|
desc: NewDesc(
|
|
memstatNamespace("heap_objects"),
|
|
"Number of allocated objects.",
|
|
nil, nil,
|
|
),
|
|
eval: func(ms *runtime.MemStats) float64 { return float64(ms.HeapObjects) },
|
|
valType: GaugeValue,
|
|
}, {
|
|
desc: NewDesc(
|
|
memstatNamespace("stack_inuse_bytes"),
|
|
"Number of bytes in use by the stack allocator.",
|
|
nil, nil,
|
|
),
|
|
eval: func(ms *runtime.MemStats) float64 { return float64(ms.StackInuse) },
|
|
valType: GaugeValue,
|
|
}, {
|
|
desc: NewDesc(
|
|
memstatNamespace("stack_sys_bytes"),
|
|
"Number of bytes obtained from system for stack allocator.",
|
|
nil, nil,
|
|
),
|
|
eval: func(ms *runtime.MemStats) float64 { return float64(ms.StackSys) },
|
|
valType: GaugeValue,
|
|
}, {
|
|
desc: NewDesc(
|
|
memstatNamespace("mspan_inuse_bytes"),
|
|
"Number of bytes in use by mspan structures.",
|
|
nil, nil,
|
|
),
|
|
eval: func(ms *runtime.MemStats) float64 { return float64(ms.MSpanInuse) },
|
|
valType: GaugeValue,
|
|
}, {
|
|
desc: NewDesc(
|
|
memstatNamespace("mspan_sys_bytes"),
|
|
"Number of bytes used for mspan structures obtained from system.",
|
|
nil, nil,
|
|
),
|
|
eval: func(ms *runtime.MemStats) float64 { return float64(ms.MSpanSys) },
|
|
valType: GaugeValue,
|
|
}, {
|
|
desc: NewDesc(
|
|
memstatNamespace("mcache_inuse_bytes"),
|
|
"Number of bytes in use by mcache structures.",
|
|
nil, nil,
|
|
),
|
|
eval: func(ms *runtime.MemStats) float64 { return float64(ms.MCacheInuse) },
|
|
valType: GaugeValue,
|
|
}, {
|
|
desc: NewDesc(
|
|
memstatNamespace("mcache_sys_bytes"),
|
|
"Number of bytes used for mcache structures obtained from system.",
|
|
nil, nil,
|
|
),
|
|
eval: func(ms *runtime.MemStats) float64 { return float64(ms.MCacheSys) },
|
|
valType: GaugeValue,
|
|
}, {
|
|
desc: NewDesc(
|
|
memstatNamespace("buck_hash_sys_bytes"),
|
|
"Number of bytes used by the profiling bucket hash table.",
|
|
nil, nil,
|
|
),
|
|
eval: func(ms *runtime.MemStats) float64 { return float64(ms.BuckHashSys) },
|
|
valType: GaugeValue,
|
|
}, {
|
|
desc: NewDesc(
|
|
memstatNamespace("gc_sys_bytes"),
|
|
"Number of bytes used for garbage collection system metadata.",
|
|
nil, nil,
|
|
),
|
|
eval: func(ms *runtime.MemStats) float64 { return float64(ms.GCSys) },
|
|
valType: GaugeValue,
|
|
}, {
|
|
desc: NewDesc(
|
|
memstatNamespace("other_sys_bytes"),
|
|
"Number of bytes used for other system allocations.",
|
|
nil, nil,
|
|
),
|
|
eval: func(ms *runtime.MemStats) float64 { return float64(ms.OtherSys) },
|
|
valType: GaugeValue,
|
|
}, {
|
|
desc: NewDesc(
|
|
memstatNamespace("next_gc_bytes"),
|
|
"Number of heap bytes when next garbage collection will take place.",
|
|
nil, nil,
|
|
),
|
|
eval: func(ms *runtime.MemStats) float64 { return float64(ms.NextGC) },
|
|
valType: GaugeValue,
|
|
},
|
|
}
|
|
}
|
|
|
|
type baseGoCollector struct {
|
|
goroutinesDesc *Desc
|
|
threadsDesc *Desc
|
|
gcDesc *Desc
|
|
gcLastTimeDesc *Desc
|
|
goInfoDesc *Desc
|
|
goMaxProcs *Desc
|
|
goGogcPercent *Desc
|
|
goMemLimit *Desc
|
|
}
|
|
|
|
func newBaseGoCollector() baseGoCollector {
|
|
return baseGoCollector{
|
|
goroutinesDesc: NewDesc(
|
|
"go_goroutines",
|
|
"Number of goroutines that currently exist.",
|
|
nil, nil),
|
|
threadsDesc: NewDesc(
|
|
"go_threads",
|
|
"Number of OS threads created.",
|
|
nil, nil),
|
|
gcDesc: NewDesc(
|
|
"go_gc_duration_seconds",
|
|
"A summary of the pause duration of garbage collection cycles.",
|
|
nil, nil),
|
|
gcLastTimeDesc: NewDesc(
|
|
"go_memstats_last_gc_time_seconds",
|
|
"Number of seconds since 1970 of last garbage collection.",
|
|
nil, nil),
|
|
goInfoDesc: NewDesc(
|
|
"go_info",
|
|
"Information about the Go environment.",
|
|
nil, Labels{"version": runtime.Version()}),
|
|
goMaxProcs: NewDesc(
|
|
"go_gomaxprocs",
|
|
"Value of GOMAXPROCS, i.e number of usable threads.",
|
|
nil, nil),
|
|
goGogcPercent: NewDesc(
|
|
"go_gogc_percent",
|
|
"Value of GOGC (percentage).",
|
|
nil, nil),
|
|
goMemLimit: NewDesc(
|
|
"go_gomemlimit",
|
|
"Value of GOMEMLIMIT (bytes).",
|
|
nil, nil),
|
|
}
|
|
}
|
|
|
|
// Describe returns all descriptions of the collector.
|
|
func (c *baseGoCollector) Describe(ch chan<- *Desc) {
|
|
ch <- c.goroutinesDesc
|
|
ch <- c.threadsDesc
|
|
ch <- c.gcDesc
|
|
ch <- c.gcLastTimeDesc
|
|
ch <- c.goInfoDesc
|
|
ch <- c.goMaxProcs
|
|
ch <- c.goGogcPercent
|
|
ch <- c.goMemLimit
|
|
}
|
|
|
|
// Collect returns the current state of all metrics of the collector.
|
|
func (c *baseGoCollector) Collect(ch chan<- Metric) {
|
|
ch <- MustNewConstMetric(c.goroutinesDesc, GaugeValue, float64(runtime.NumGoroutine()))
|
|
|
|
n := getRuntimeNumThreads()
|
|
ch <- MustNewConstMetric(c.threadsDesc, GaugeValue, n)
|
|
|
|
var stats debug.GCStats
|
|
stats.PauseQuantiles = make([]time.Duration, 5)
|
|
debug.ReadGCStats(&stats)
|
|
|
|
quantiles := make(map[float64]float64)
|
|
for idx, pq := range stats.PauseQuantiles[1:] {
|
|
quantiles[float64(idx+1)/float64(len(stats.PauseQuantiles)-1)] = pq.Seconds()
|
|
}
|
|
quantiles[0.0] = stats.PauseQuantiles[0].Seconds()
|
|
ch <- MustNewConstSummary(c.gcDesc, uint64(stats.NumGC), stats.PauseTotal.Seconds(), quantiles)
|
|
ch <- MustNewConstMetric(c.gcLastTimeDesc, GaugeValue, float64(stats.LastGC.UnixNano())/1e9)
|
|
ch <- MustNewConstMetric(c.goInfoDesc, GaugeValue, 1)
|
|
ch <- MustNewConstMetric(c.goMaxProcs, GaugeValue, float64(runtime.NumCPU()))
|
|
|
|
gogcSample := make([]runmetr.Sample, 1)
|
|
gogcSample[0].Name = "/gc/gogc:percent"
|
|
runmetr.Read(gogcSample)
|
|
ch <- MustNewConstMetric(c.goGogcPercent, GaugeValue, float64(gogcSample[0].Value.Uint64()))
|
|
|
|
memLimitSample := make([]runmetr.Sample, 1)
|
|
memLimitSample[0].Name = "/gc/gomemlimit:bytes"
|
|
runmetr.Read(memLimitSample)
|
|
ch <- MustNewConstMetric(c.goMemLimit, GaugeValue, float64(memLimitSample[0].Value.Uint64()))
|
|
|
|
}
|
|
|
|
func memstatNamespace(s string) string {
|
|
return "go_memstats_" + s
|
|
}
|
|
|
|
// memStatsMetrics provide description, evaluator, runtime/metrics name, and
|
|
// value type for memstat metrics.
|
|
type memStatsMetrics []struct {
|
|
desc *Desc
|
|
eval func(*runtime.MemStats) float64
|
|
valType ValueType
|
|
}
|