From 705bd9ef6bc48c084095363f6e3dcd4ffe888398 Mon Sep 17 00:00:00 2001 From: Krisztian Litkey Date: Mon, 11 Nov 2024 10:38:20 +0200 Subject: [PATCH] metrics: add standard collectors. Add a metrics/collectors subpackage. When imported it pulls in and registers the fairly standard buildinfo, process and golang runtime collectors. Turn on the build info collector by default. Signed-off-by: Krisztian Litkey --- .../bases/config.nri_balloonspolicies.yaml | 1 + .../bases/config.nri_templatepolicies.yaml | 1 + .../config.nri_topologyawarepolicies.yaml | 1 + .../crds/config.nri_balloonspolicies.yaml | 1 + .../crds/config.nri_templatepolicies.yaml | 1 + .../config.nri_topologyawarepolicies.yaml | 1 + .../config/v1alpha1/instrumentation/config.go | 2 +- pkg/metrics/collectors/collectors.go | 66 +++++++++++++++++++ pkg/resmgr/main/main.go | 1 + 9 files changed, 74 insertions(+), 1 deletion(-) create mode 100644 pkg/metrics/collectors/collectors.go diff --git a/config/crd/bases/config.nri_balloonspolicies.yaml b/config/crd/bases/config.nri_balloonspolicies.yaml index da3b852c2..33d1d11dc 100644 --- a/config/crd/bases/config.nri_balloonspolicies.yaml +++ b/config/crd/bases/config.nri_balloonspolicies.yaml @@ -324,6 +324,7 @@ spec: default: enabled: - policy + - buildinfo description: Metrics defines which metrics to collect. properties: enabled: diff --git a/config/crd/bases/config.nri_templatepolicies.yaml b/config/crd/bases/config.nri_templatepolicies.yaml index 2b1d4db9a..a5a5b5511 100644 --- a/config/crd/bases/config.nri_templatepolicies.yaml +++ b/config/crd/bases/config.nri_templatepolicies.yaml @@ -96,6 +96,7 @@ spec: default: enabled: - policy + - buildinfo description: Metrics defines which metrics to collect. properties: enabled: diff --git a/config/crd/bases/config.nri_topologyawarepolicies.yaml b/config/crd/bases/config.nri_topologyawarepolicies.yaml index af76a8e9a..9e7f8fa7c 100644 --- a/config/crd/bases/config.nri_topologyawarepolicies.yaml +++ b/config/crd/bases/config.nri_topologyawarepolicies.yaml @@ -123,6 +123,7 @@ spec: default: enabled: - policy + - buildinfo description: Metrics defines which metrics to collect. properties: enabled: diff --git a/deployment/helm/balloons/crds/config.nri_balloonspolicies.yaml b/deployment/helm/balloons/crds/config.nri_balloonspolicies.yaml index da3b852c2..33d1d11dc 100644 --- a/deployment/helm/balloons/crds/config.nri_balloonspolicies.yaml +++ b/deployment/helm/balloons/crds/config.nri_balloonspolicies.yaml @@ -324,6 +324,7 @@ spec: default: enabled: - policy + - buildinfo description: Metrics defines which metrics to collect. properties: enabled: diff --git a/deployment/helm/template/crds/config.nri_templatepolicies.yaml b/deployment/helm/template/crds/config.nri_templatepolicies.yaml index 2b1d4db9a..a5a5b5511 100644 --- a/deployment/helm/template/crds/config.nri_templatepolicies.yaml +++ b/deployment/helm/template/crds/config.nri_templatepolicies.yaml @@ -96,6 +96,7 @@ spec: default: enabled: - policy + - buildinfo description: Metrics defines which metrics to collect. properties: enabled: diff --git a/deployment/helm/topology-aware/crds/config.nri_topologyawarepolicies.yaml b/deployment/helm/topology-aware/crds/config.nri_topologyawarepolicies.yaml index af76a8e9a..9e7f8fa7c 100644 --- a/deployment/helm/topology-aware/crds/config.nri_topologyawarepolicies.yaml +++ b/deployment/helm/topology-aware/crds/config.nri_topologyawarepolicies.yaml @@ -123,6 +123,7 @@ spec: default: enabled: - policy + - buildinfo description: Metrics defines which metrics to collect. properties: enabled: diff --git a/pkg/apis/config/v1alpha1/instrumentation/config.go b/pkg/apis/config/v1alpha1/instrumentation/config.go index 1e387dc20..f8cabb767 100644 --- a/pkg/apis/config/v1alpha1/instrumentation/config.go +++ b/pkg/apis/config/v1alpha1/instrumentation/config.go @@ -49,6 +49,6 @@ type Config struct { // +optional PrometheusExport bool `json:"prometheusExport,omitempty"` // Metrics defines which metrics to collect. - // +kubebuilder:default={"enabled": {"policy"}} + // +kubebuilder:default={"enabled": {"policy", "buildinfo"}} Metrics *metrics.Config `json:"metrics,omitempty"` } diff --git a/pkg/metrics/collectors/collectors.go b/pkg/metrics/collectors/collectors.go new file mode 100644 index 000000000..04cb0058a --- /dev/null +++ b/pkg/metrics/collectors/collectors.go @@ -0,0 +1,66 @@ +// Copyright The NRI Plugins Authors. All Rights Reserved. +// +// 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 collectors + +import ( + "github.com/prometheus/client_golang/prometheus" + "github.com/prometheus/client_golang/prometheus/collectors" + + logger "github.com/containers/nri-plugins/pkg/log" + "github.com/containers/nri-plugins/pkg/metrics" + "github.com/containers/nri-plugins/pkg/version" +) + +var ( + log = logger.Get("metrics") +) + +func NewVersionInfoCollector(v, b string) prometheus.Collector { + return prometheus.NewGaugeFunc( + prometheus.GaugeOpts{ + Name: "version_info", + Help: "A metric with constant '1' value labeled by version and build info.", + ConstLabels: prometheus.Labels{ + "version": v, + "build": b, + }, + }, + func() float64 { return 1 }, + ) +} + +func init() { + var ( + collectors = map[string]prometheus.Collector{ + "buildinfo": collectors.NewBuildInfoCollector(), + "golang": collectors.NewGoCollector(), + "process": collectors.NewProcessCollector(collectors.ProcessCollectorOpts{}), + "versioninfo": NewVersionInfoCollector(version.Version, version.Build), + } + options = []metrics.RegisterOption{ + metrics.WithGroup("standard"), + metrics.WithCollectorOptions( + metrics.WithoutNamespace(), + metrics.WithoutSubsystem(), + ), + } + ) + + for name, collector := range collectors { + if err := metrics.Register(name, collector, options...); err != nil { + log.Error("failed to register %s collector: %v", name, err) + } + } +} diff --git a/pkg/resmgr/main/main.go b/pkg/resmgr/main/main.go index 35663bb21..d2e3c7579 100644 --- a/pkg/resmgr/main/main.go +++ b/pkg/resmgr/main/main.go @@ -23,6 +23,7 @@ import ( "github.com/containers/nri-plugins/pkg/agent" "github.com/containers/nri-plugins/pkg/instrumentation" + _ "github.com/containers/nri-plugins/pkg/metrics/collectors" "github.com/containers/nri-plugins/pkg/resmgr" "github.com/containers/nri-plugins/pkg/resmgr/policy"