|
| 1 | +// Copyright 2021 The Prometheus Authors |
| 2 | +// Licensed under the Apache License, Version 2.0 (the "License"); |
| 3 | +// you may not use this file except in compliance with the License. |
| 4 | +// You may obtain a copy of the License at |
| 5 | +// |
| 6 | +// http://www.apache.org/licenses/LICENSE-2.0 |
| 7 | +// |
| 8 | +// Unless required by applicable law or agreed to in writing, software |
| 9 | +// distributed under the License is distributed on an "AS IS" BASIS, |
| 10 | +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 11 | +// See the License for the specific language governing permissions and |
| 12 | +// limitations under the License. |
| 13 | + |
| 14 | +//go:build go1.17 |
| 15 | +// +build go1.17 |
| 16 | + |
| 17 | +package collectors |
| 18 | + |
| 19 | +import "github.com/prometheus/client_golang/prometheus" |
| 20 | + |
| 21 | +//nolint:staticcheck // Ignore SA1019 until v2. |
| 22 | +type goOptions = prometheus.GoCollectorOptions |
| 23 | +type goOption func(o *goOptions) |
| 24 | + |
| 25 | +type GoCollectionOption uint32 |
| 26 | + |
| 27 | +const ( |
| 28 | + // GoRuntimeMemStatsCollection represents the metrics represented by runtime.MemStats structure such as |
| 29 | + // go_memstats_alloc_bytes |
| 30 | + // go_memstats_alloc_bytes_total |
| 31 | + // go_memstats_sys_bytes |
| 32 | + // go_memstats_lookups_total |
| 33 | + // go_memstats_mallocs_total |
| 34 | + // go_memstats_frees_total |
| 35 | + // go_memstats_heap_alloc_bytes |
| 36 | + // go_memstats_heap_sys_bytes |
| 37 | + // go_memstats_heap_idle_bytes |
| 38 | + // go_memstats_heap_inuse_bytes |
| 39 | + // go_memstats_heap_released_bytes |
| 40 | + // go_memstats_heap_objects |
| 41 | + // go_memstats_stack_inuse_bytes |
| 42 | + // go_memstats_stack_sys_bytes |
| 43 | + // go_memstats_mspan_inuse_bytes |
| 44 | + // go_memstats_mspan_sys_bytes |
| 45 | + // go_memstats_mcache_inuse_bytes |
| 46 | + // go_memstats_mcache_sys_bytes |
| 47 | + // go_memstats_buck_hash_sys_bytes |
| 48 | + // go_memstats_gc_sys_bytes |
| 49 | + // go_memstats_other_sys_bytes |
| 50 | + // go_memstats_next_gc_bytes |
| 51 | + // so the metrics known from pre client_golang v1.12.0, except skipped go_memstats_gc_cpu_fraction (see |
| 52 | + // https://github.com/prometheus/client_golang/issues/842#issuecomment-861812034 for explanation. |
| 53 | + // |
| 54 | + // NOTE that this mode represents runtime.MemStats statistics, but they are |
| 55 | + // actually implemented using new runtime/metrics package. |
| 56 | + // Deprecated: Use GoRuntimeMetricsCollection instead going forward. |
| 57 | + GoRuntimeMemStatsCollection GoCollectionOption = 1 << iota |
| 58 | + // GoRuntimeMetricsCollection is the new set of metrics represented by runtime/metrics package and follows |
| 59 | + // consistent naming. The exposed metric set depends on Go version, but it is controlled against |
| 60 | + // unexpected cardinality. This set has overlapping information with GoRuntimeMemStatsCollection, just with |
| 61 | + // new names. GoRuntimeMetricsCollection is what is recommended for using going forward. |
| 62 | + GoRuntimeMetricsCollection |
| 63 | +) |
| 64 | + |
| 65 | +// WithGoCollections allows enabling different collections for Go collector on top of base metrics |
| 66 | +// like go_goroutines, go_threads, go_gc_duration_seconds, go_memstats_last_gc_time_seconds, go_info. |
| 67 | +// |
| 68 | +// Check GoRuntimeMemStatsCollection and GoRuntimeMetricsCollection for more details. You can use none, |
| 69 | +// one or more collections at once. For example: |
| 70 | +// WithGoCollections(GoRuntimeMemStatsCollection | GoRuntimeMetricsCollection) means both GoRuntimeMemStatsCollection |
| 71 | +// metrics and GoRuntimeMetricsCollection will be exposed. |
| 72 | +// |
| 73 | +// Use WithGoCollections(GoRuntimeMemStatsCollection) to have Go collector working in |
| 74 | +// the compatibility mode with client_golang pre v1.12 (move to runtime/metrics). |
| 75 | +func WithGoCollections(flags uint32) goOption { |
| 76 | + return func(o *goOptions) { |
| 77 | + o.EnabledCollections = flags |
| 78 | + } |
| 79 | +} |
| 80 | + |
| 81 | +// NewGoCollector returns a collector that exports metrics about the current Go |
| 82 | +// process using debug.GCStats using runtime/metrics. |
| 83 | +func NewGoCollector(opts ...goOption) prometheus.Collector { |
| 84 | + //nolint:staticcheck // Ignore SA1019 until v2. |
| 85 | + promPkgOpts := make([]func(o *prometheus.GoCollectorOptions), len(opts)) |
| 86 | + for i, opt := range opts { |
| 87 | + promPkgOpts[i] = opt |
| 88 | + } |
| 89 | + //nolint:staticcheck // Ignore SA1019 until v2. |
| 90 | + return prometheus.NewGoCollector(promPkgOpts...) |
| 91 | +} |
0 commit comments