From c576b951ad94df7cb97d1b3b6f5cdb49315f5721 Mon Sep 17 00:00:00 2001 From: Kemal Akkoyun Date: Fri, 5 Aug 2022 15:48:33 +0200 Subject: [PATCH] Generate new Go runtime metrics for go 1.19 (#1105) * Generate new Go runtime metrics Fix generation script Signed-off-by: Kemal Akkoyun * Address review issues Signed-off-by: Kemal Akkoyun --- .github/workflows/golangci-lint.yml | 2 +- .go-version | 1 + Makefile | 8 +++ prometheus/gen_go_collector_metrics_set.go | 57 +++++++++++-------- prometheus/go_collector_latest_test.go | 2 +- prometheus/go_collector_metrics_go119_test.go | 45 +++++++++++++++ 6 files changed, 88 insertions(+), 27 deletions(-) create mode 100644 .go-version create mode 100644 prometheus/go_collector_metrics_go119_test.go diff --git a/.github/workflows/golangci-lint.yml b/.github/workflows/golangci-lint.yml index 6034bcb..8f069d3 100644 --- a/.github/workflows/golangci-lint.yml +++ b/.github/workflows/golangci-lint.yml @@ -20,7 +20,7 @@ jobs: - name: install Go uses: actions/setup-go@v2 with: - go-version: 1.18.x + go-version-file: .go-version - name: Install snmp_exporter/generator dependencies run: sudo apt-get update && sudo apt-get -y install libsnmp-dev if: github.repository == 'prometheus/snmp_exporter' diff --git a/.go-version b/.go-version new file mode 100644 index 0000000..adc97d8 --- /dev/null +++ b/.go-version @@ -0,0 +1 @@ +1.18 diff --git a/Makefile b/Makefile index f35cf58..4f526d7 100644 --- a/Makefile +++ b/Makefile @@ -18,3 +18,11 @@ test: deps common-test .PHONY: test-short test-short: deps common-test-short + +.PHONY: generate-go-collector-test-files +VERSIONS := 1.17 1.18 1.19 +generate-go-collector-test-files: + for GO_VERSION in $(VERSIONS); do \ + docker run --rm -v $(PWD):/workspace -w /workspace golang:$$GO_VERSION go run prometheus/gen_go_collector_metrics_set.go; \ + mv -f go_collector_metrics* prometheus; \ + done diff --git a/prometheus/gen_go_collector_metrics_set.go b/prometheus/gen_go_collector_metrics_set.go index 2f60ea3..74b67ac 100644 --- a/prometheus/gen_go_collector_metrics_set.go +++ b/prometheus/gen_go_collector_metrics_set.go @@ -25,28 +25,41 @@ import ( "os" "runtime" "runtime/metrics" - "strconv" "strings" "text/template" "github.com/prometheus/client_golang/prometheus" "github.com/prometheus/client_golang/prometheus/internal" + + "github.com/hashicorp/go-version" ) func main() { - if len(os.Args) != 2 { - log.Fatal("requires Go version (e.g. go1.17) as an argument") - } + var givenVersion string toolVersion := runtime.Version() - mtv := majorVersion(toolVersion) - mv := majorVersion(os.Args[1]) - if mtv != mv { - log.Fatalf("using Go version %q but expected Go version %q", mtv, mv) + if len(os.Args) != 2 { + log.Printf("requires Go version (e.g. go1.17) as an argument. Since it is not specified, assuming %s.", toolVersion) + givenVersion = toolVersion + } else { + givenVersion = os.Args[1] } - version, err := parseVersion(mv) + log.Printf("given version for Go: %s", givenVersion) + log.Printf("tool version for Go: %s", toolVersion) + + tv, err := version.NewVersion(strings.TrimPrefix(givenVersion, "go")) if err != nil { - log.Fatalf("parsing Go version: %v", err) + log.Fatal(err) } + gv, err := version.NewVersion(strings.TrimPrefix(toolVersion, "go")) + if err != nil { + log.Fatal(err) + } + if !gv.Equal(tv) { + log.Fatalf("using Go version %q but expected Go version %q", tv, gv) + } + + v := goVersion(gv.Segments()[1]) + log.Printf("generating metrics for Go version %q", v) // Generate code. var buf bytes.Buffer @@ -56,7 +69,7 @@ func main() { Cardinality int }{ Descriptions: metrics.All(), - GoVersion: version, + GoVersion: v, Cardinality: rmCardinality(), }) if err != nil { @@ -70,7 +83,7 @@ func main() { } // Write it to a file. - fname := fmt.Sprintf("go_collector_metrics_%s_test.go", version.Abbr()) + fname := fmt.Sprintf("go_collector_metrics_%s_test.go", v.Abbr()) if err := os.WriteFile(fname, result, 0o644); err != nil { log.Fatalf("writing file: %v", err) } @@ -86,19 +99,6 @@ func (g goVersion) Abbr() string { return fmt.Sprintf("go1%d", g) } -func parseVersion(s string) (goVersion, error) { - i := strings.IndexRune(s, '.') - if i < 0 { - return goVersion(-1), fmt.Errorf("bad Go version format") - } - i, err := strconv.Atoi(s[i+1:]) - return goVersion(i), err -} - -func majorVersion(v string) string { - return v[:strings.LastIndexByte(v, '.')] -} - func rmCardinality() int { cardinality := 0 @@ -123,6 +123,7 @@ func rmCardinality() int { name[strings.IndexRune(name, ':')+1:], ) cardinality += len(buckets) + 3 // Plus total count, sum, and the implicit infinity bucket. + // runtime/metrics bucket boundaries are lower-bound-inclusive, but // always represents each actual *boundary* so Buckets is always // 1 longer than Counts, while in Prometheus the mapping is one-to-one, @@ -134,6 +135,12 @@ func rmCardinality() int { // We already counted the infinity bucket separately. cardinality-- } + // Prometheus also doesn't have buckets for -Inf, so they need to be omitted. + // See the following PR for more information: + // https://github.com/prometheus/client_golang/pull/1049 + if buckets[0] == math.Inf(-1) { + cardinality-- + } } return cardinality diff --git a/prometheus/go_collector_latest_test.go b/prometheus/go_collector_latest_test.go index 11094c8..df18d5d 100644 --- a/prometheus/go_collector_latest_test.go +++ b/prometheus/go_collector_latest_test.go @@ -269,7 +269,7 @@ func TestMemStatsEquivalence(t *testing.T) { } func TestExpectedRuntimeMetrics(t *testing.T) { - goMetrics := collectGoMetrics(t, goRuntimeMetricsCollection) + goMetrics := collectGoMetrics(t, goRuntimeMemStatsCollection|goRuntimeMetricsCollection) goMetricSet := make(map[string]Metric) for _, m := range goMetrics { goMetricSet[m.Desc().fqName] = m diff --git a/prometheus/go_collector_metrics_go119_test.go b/prometheus/go_collector_metrics_go119_test.go new file mode 100644 index 0000000..ec3430a --- /dev/null +++ b/prometheus/go_collector_metrics_go119_test.go @@ -0,0 +1,45 @@ +// Code generated by gen_go_collector_metrics_set.go; DO NOT EDIT. +//go:generate go run gen_go_collector_metrics_set.go go1.19 + +//go:build go1.19 && !go1.20 +// +build go1.19,!go1.20 + +package prometheus + +var expectedRuntimeMetrics = map[string]string{ + "/cgo/go-to-c-calls:calls": "go_cgo_go_to_c_calls_calls_total", + "/gc/cycles/automatic:gc-cycles": "go_gc_cycles_automatic_gc_cycles_total", + "/gc/cycles/forced:gc-cycles": "go_gc_cycles_forced_gc_cycles_total", + "/gc/cycles/total:gc-cycles": "go_gc_cycles_total_gc_cycles_total", + "/gc/heap/allocs-by-size:bytes": "go_gc_heap_allocs_by_size_bytes", + "/gc/heap/allocs:bytes": "go_gc_heap_allocs_bytes_total", + "/gc/heap/allocs:objects": "go_gc_heap_allocs_objects_total", + "/gc/heap/frees-by-size:bytes": "go_gc_heap_frees_by_size_bytes", + "/gc/heap/frees:bytes": "go_gc_heap_frees_bytes_total", + "/gc/heap/frees:objects": "go_gc_heap_frees_objects_total", + "/gc/heap/goal:bytes": "go_gc_heap_goal_bytes", + "/gc/heap/objects:objects": "go_gc_heap_objects_objects", + "/gc/heap/tiny/allocs:objects": "go_gc_heap_tiny_allocs_objects_total", + "/gc/limiter/last-enabled:gc-cycle": "go_gc_limiter_last_enabled_gc_cycle", + "/gc/pauses:seconds": "go_gc_pauses_seconds", + "/gc/stack/starting-size:bytes": "go_gc_stack_starting_size_bytes", + "/memory/classes/heap/free:bytes": "go_memory_classes_heap_free_bytes", + "/memory/classes/heap/objects:bytes": "go_memory_classes_heap_objects_bytes", + "/memory/classes/heap/released:bytes": "go_memory_classes_heap_released_bytes", + "/memory/classes/heap/stacks:bytes": "go_memory_classes_heap_stacks_bytes", + "/memory/classes/heap/unused:bytes": "go_memory_classes_heap_unused_bytes", + "/memory/classes/metadata/mcache/free:bytes": "go_memory_classes_metadata_mcache_free_bytes", + "/memory/classes/metadata/mcache/inuse:bytes": "go_memory_classes_metadata_mcache_inuse_bytes", + "/memory/classes/metadata/mspan/free:bytes": "go_memory_classes_metadata_mspan_free_bytes", + "/memory/classes/metadata/mspan/inuse:bytes": "go_memory_classes_metadata_mspan_inuse_bytes", + "/memory/classes/metadata/other:bytes": "go_memory_classes_metadata_other_bytes", + "/memory/classes/os-stacks:bytes": "go_memory_classes_os_stacks_bytes", + "/memory/classes/other:bytes": "go_memory_classes_other_bytes", + "/memory/classes/profiling/buckets:bytes": "go_memory_classes_profiling_buckets_bytes", + "/memory/classes/total:bytes": "go_memory_classes_total_bytes", + "/sched/gomaxprocs:threads": "go_sched_gomaxprocs_threads", + "/sched/goroutines:goroutines": "go_sched_goroutines_goroutines", + "/sched/latencies:seconds": "go_sched_latencies_seconds", +} + +const expectedRuntimeMetricsCardinality = 81