client_golang/prometheus/internal/go_runtime_metrics_test.go

98 lines
2.3 KiB
Go
Raw Normal View History

Use the runtime/metrics package for the Go collector for 1.17+ (#955) 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. * This change adds a `go generate` script to generate a list of expected runtime/metrics names for a given Go version for auditing. Users of new versions of Go will transparently be allowed to use new metrics, however. Signed-off-by: Michael Anthony Knyszek <mknyszek@google.com>
2022-01-16 19:41:56 +03:00
// Copyright 2021 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.
//go:build go1.17
// +build go1.17
package internal
import (
"runtime/metrics"
"testing"
)
func TestRuntimeMetricsToProm(t *testing.T) {
tests := []struct {
got metrics.Description
expect string
}{
{
metrics.Description{
Name: "/memory/live:bytes",
Kind: metrics.KindUint64,
},
"go_memory_live_bytes",
},
{
metrics.Description{
Name: "/memory/allocs:bytes",
Kind: metrics.KindUint64,
Cumulative: true,
},
"go_memory_allocs_bytes_total",
},
{
metrics.Description{
Name: "/memory/alloc-rate:bytes/second",
Kind: metrics.KindFloat64,
},
"go_memory_alloc_rate_bytes_per_second",
},
{
metrics.Description{
Name: "/gc/time:cpu*seconds",
Kind: metrics.KindFloat64,
Cumulative: true,
},
"go_gc_time_cpu_seconds_total",
},
{
metrics.Description{
Name: "/this/is/a/very/deep/metric:metrics",
Kind: metrics.KindFloat64,
},
"go_this_is_a_very_deep_metric_metrics",
},
{
metrics.Description{
Name: "/this*is*an*invalid...:µname",
Kind: metrics.KindUint64,
},
"",
},
{
metrics.Description{
Name: "/this/is/a/valid/name:objects",
Kind: metrics.KindBad,
},
"",
},
}
for _, test := range tests {
ns, ss, n, ok := RuntimeMetricsToProm(&test.got)
name := ns + "_" + ss + "_" + n
if test.expect == "" && ok {
t.Errorf("bad input expected a bad output: input %s, got %s", test.got.Name, name)
continue
}
if test.expect != "" && !ok {
t.Errorf("unexpected bad output on good input: input %s", test.got.Name)
continue
}
if test.expect != "" && name != test.expect {
t.Errorf("expected %s, got %s", test.expect, name)
continue
}
}
}