Skip to content

Commit 384ec16

Browse files
committed
Use the runtime/metrics package for the Go collector for 1.17+
This change introduces use of the runtime/metrics package in place of runtime.MemStats for Go 1.17 or later. The runtime/metrics package was introduced in Go 1.16, but not all the old metrics were accounted for until 1.17. The runtime/metrics package offers several advantages over using runtime.MemStats: * The list of metrics and their descriptions are machine-readable, allowing new metrics to get added without any additional work. * Detailed histogram-based metrics are now available, offering much deeper insights into the Go runtime. * The runtime/metrics API is significantly more efficient than runtime.MemStats, even with the additional metrics added, because it does not require any stop-the-world events. That being said, integrating the package comes with some caveats, some of which were discussed in #842. Namely: * The old MemStats-based metrics need to continue working, so they're exported under their old names backed by equivalent runtime/metrics metrics. * Earlier versions of Go need to continue working, so the old code remains, but behind a build tag. Finally, a few notes about the implementation: * This change includes a whole bunch of refactoring to avoid significant code duplication. * This change adds a new histogram metric type specifically optimized for runtime/metrics histograms. This type's methods also include additional logic to deal with differences in bounds conventions. * This change makes a whole bunch of decisions about how runtime/metrics names are translated. Signed-off-by: Michael Anthony Knyszek <[email protected]>
1 parent dc1559e commit 384ec16

File tree

7 files changed

+1012
-381
lines changed

7 files changed

+1012
-381
lines changed

prometheus/build_info_collector.go

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
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+
package prometheus
15+
16+
import "runtime/debug"
17+
18+
// NewBuildInfoCollector is the obsolete version of collectors.NewBuildInfoCollector.
19+
// See there for documentation.
20+
//
21+
// Deprecated: Use collectors.NewBuildInfoCollector instead.
22+
func NewBuildInfoCollector() Collector {
23+
path, version, sum := "unknown", "unknown", "unknown"
24+
if bi, ok := debug.ReadBuildInfo(); ok {
25+
path = bi.Main.Path
26+
version = bi.Main.Version
27+
sum = bi.Main.Sum
28+
}
29+
c := &selfCollector{MustNewConstMetric(
30+
NewDesc(
31+
"go_build_info",
32+
"Build information about the main Go module.",
33+
nil, Labels{"path": path, "version": version, "checksum": sum},
34+
),
35+
GaugeValue, 1)}
36+
c.init(c.self)
37+
return c
38+
}

0 commit comments

Comments
 (0)