config: expose metrics configuration.

Add configuration bits for controlling which metrics are collected. Enable collection of policy metrics by default. Signed-off-by: Krisztian Litkey <[email protected]>
containers · Nov 15, 2024 · 0000b06 · 0000b06
1 parent a0f29c9
commit 0000b06
Show file tree

Hide file tree

Showing 14 changed files with 302 additions and 25 deletions.
diff --git a/config/crd/bases/config.nri_balloonspolicies.yaml b/config/crd/bases/config.nri_balloonspolicies.yaml
@@ -320,12 +320,36 @@ spec:
                       to expose Prometheus metrics among other things.
                     example: :8891
                     type: string
+                  metrics:
+                    default:
+                      enabled:
+                      - policy
+                    description: Metrics defines which metrics to collect.
+                    properties:
+                      enabled:
+                        description: Enabled enables collection for metrics matched
+                          by glob patterns.
+                        example:
+                        - '*'
+                        items:
+                          type: string
+                        type: array
+                      polled:
+                        description: Polled forces polled collection for metrics matched
+                          by glob patterns.
+                        example:
+                        - computationally-expensive-metrics
+                        items:
+                          type: string
+                        type: array
+                    type: object
                   prometheusExport:
                     description: PrometheusExport enables exporting /metrics for Prometheus.
                     type: boolean
                   reportPeriod:
-                    description: ReportPeriod is the interval between reporting aggregated
-                      metrics.
+                    default: 30s
+                    description: ReportPeriod is the interval between between collecting
+                      polled metrics.
                     format: duration
                     type: string
                   samplingRatePerMillion:

diff --git a/config/crd/bases/config.nri_templatepolicies.yaml b/config/crd/bases/config.nri_templatepolicies.yaml
@@ -92,12 +92,36 @@ spec:
                       to expose Prometheus metrics among other things.
                     example: :8891
                     type: string
+                  metrics:
+                    default:
+                      enabled:
+                      - policy
+                    description: Metrics defines which metrics to collect.
+                    properties:
+                      enabled:
+                        description: Enabled enables collection for metrics matched
+                          by glob patterns.
+                        example:
+                        - '*'
+                        items:
+                          type: string
+                        type: array
+                      polled:
+                        description: Polled forces polled collection for metrics matched
+                          by glob patterns.
+                        example:
+                        - computationally-expensive-metrics
+                        items:
+                          type: string
+                        type: array
+                    type: object
                   prometheusExport:
                     description: PrometheusExport enables exporting /metrics for Prometheus.
                     type: boolean
                   reportPeriod:
-                    description: ReportPeriod is the interval between reporting aggregated
-                      metrics.
+                    default: 30s
+                    description: ReportPeriod is the interval between between collecting
+                      polled metrics.
                     format: duration
                     type: string
                   samplingRatePerMillion:

diff --git a/config/crd/bases/config.nri_topologyawarepolicies.yaml b/config/crd/bases/config.nri_topologyawarepolicies.yaml
@@ -119,12 +119,36 @@ spec:
                       to expose Prometheus metrics among other things.
                     example: :8891
                     type: string
+                  metrics:
+                    default:
+                      enabled:
+                      - policy
+                    description: Metrics defines which metrics to collect.
+                    properties:
+                      enabled:
+                        description: Enabled enables collection for metrics matched
+                          by glob patterns.
+                        example:
+                        - '*'
+                        items:
+                          type: string
+                        type: array
+                      polled:
+                        description: Polled forces polled collection for metrics matched
+                          by glob patterns.
+                        example:
+                        - computationally-expensive-metrics
+                        items:
+                          type: string
+                        type: array
+                    type: object
                   prometheusExport:
                     description: PrometheusExport enables exporting /metrics for Prometheus.
                     type: boolean
                   reportPeriod:
-                    description: ReportPeriod is the interval between reporting aggregated
-                      metrics.
+                    default: 30s
+                    description: ReportPeriod is the interval between between collecting
+                      polled metrics.
                     format: duration
                     type: string
                   samplingRatePerMillion:

diff --git a/deployment/helm/balloons/crds/config.nri_balloonspolicies.yaml b/deployment/helm/balloons/crds/config.nri_balloonspolicies.yaml
@@ -320,12 +320,36 @@ spec:
                       to expose Prometheus metrics among other things.
                     example: :8891
                     type: string
+                  metrics:
+                    default:
+                      enabled:
+                      - policy
+                    description: Metrics defines which metrics to collect.
+                    properties:
+                      enabled:
+                        description: Enabled enables collection for metrics matched
+                          by glob patterns.
+                        example:
+                        - '*'
+                        items:
+                          type: string
+                        type: array
+                      polled:
+                        description: Polled forces polled collection for metrics matched
+                          by glob patterns.
+                        example:
+                        - computationally-expensive-metrics
+                        items:
+                          type: string
+                        type: array
+                    type: object
                   prometheusExport:
                     description: PrometheusExport enables exporting /metrics for Prometheus.
                     type: boolean
                   reportPeriod:
-                    description: ReportPeriod is the interval between reporting aggregated
-                      metrics.
+                    default: 30s
+                    description: ReportPeriod is the interval between between collecting
+                      polled metrics.
                     format: duration
                     type: string
                   samplingRatePerMillion:

diff --git a/deployment/helm/template/crds/config.nri_templatepolicies.yaml b/deployment/helm/template/crds/config.nri_templatepolicies.yaml
@@ -92,12 +92,36 @@ spec:
                       to expose Prometheus metrics among other things.
                     example: :8891
                     type: string
+                  metrics:
+                    default:
+                      enabled:
+                      - policy
+                    description: Metrics defines which metrics to collect.
+                    properties:
+                      enabled:
+                        description: Enabled enables collection for metrics matched
+                          by glob patterns.
+                        example:
+                        - '*'
+                        items:
+                          type: string
+                        type: array
+                      polled:
+                        description: Polled forces polled collection for metrics matched
+                          by glob patterns.
+                        example:
+                        - computationally-expensive-metrics
+                        items:
+                          type: string
+                        type: array
+                    type: object
                   prometheusExport:
                     description: PrometheusExport enables exporting /metrics for Prometheus.
                     type: boolean
                   reportPeriod:
-                    description: ReportPeriod is the interval between reporting aggregated
-                      metrics.
+                    default: 30s
+                    description: ReportPeriod is the interval between between collecting
+                      polled metrics.
                     format: duration
                     type: string
                   samplingRatePerMillion:

diff --git a/deployment/helm/topology-aware/crds/config.nri_topologyawarepolicies.yaml b/deployment/helm/topology-aware/crds/config.nri_topologyawarepolicies.yaml
@@ -119,12 +119,36 @@ spec:
                       to expose Prometheus metrics among other things.
                     example: :8891
                     type: string
+                  metrics:
+                    default:
+                      enabled:
+                      - policy
+                    description: Metrics defines which metrics to collect.
+                    properties:
+                      enabled:
+                        description: Enabled enables collection for metrics matched
+                          by glob patterns.
+                        example:
+                        - '*'
+                        items:
+                          type: string
+                        type: array
+                      polled:
+                        description: Polled forces polled collection for metrics matched
+                          by glob patterns.
+                        example:
+                        - computationally-expensive-metrics
+                        items:
+                          type: string
+                        type: array
+                    type: object
                   prometheusExport:
                     description: PrometheusExport enables exporting /metrics for Prometheus.
                     type: boolean
                   reportPeriod:
-                    description: ReportPeriod is the interval between reporting aggregated
-                      metrics.
+                    default: 30s
+                    description: ReportPeriod is the interval between between collecting
+                      polled metrics.
                     format: duration
                     type: string
                   samplingRatePerMillion:

diff --git a/docs/resource-policy/policy/balloons.md b/docs/resource-policy/policy/balloons.md
@@ -264,13 +264,13 @@ Balloons policy parameters:
   - `prometheusExport`: if set to True, balloons with their CPUs
      and assigned containers are readable through `/metrics` from the
      httpEndpoint.
-  - `reportPeriod`: `/metrics` aggregation interval.
+  - `reportPeriod`: `/metrics` aggregation interval for polled metrics.
 
 ### Example
 
 Example configuration that runs all pods in balloons of 1-4
 CPUs. Instrumentation enables reading CPUs and containers in balloons
-from `http://localhost:8891/metrics`.
+from `http://$localhost_or_pod_IP:8891/metrics`.
 
 ```yaml
 apiVersion: config.nri/v1alpha1
@@ -413,9 +413,12 @@ nri-resource-policy global config:
 instrumentation:
   # The balloons policy exports containers running in each balloon,
   # and cpusets of balloons. Accessible in command line:
-  # curl --silent http://localhost:8891/metrics
+  # curl --silent http://$localhost_or_pod_IP:8891/metrics
   HTTPEndpoint: :8891
   PrometheusExport: true
+  metrics:
+    enabled: # use '*' instead for all available metrics
+    - policy
 logger:
   Debug: policy
 ```
diff --git a/pkg/apis/config/v1alpha1/instrumentation/config.go b/pkg/apis/config/v1alpha1/instrumentation/config.go
@@ -15,10 +15,12 @@
 package instrumentation
 
 import (
+	"github.com/containers/nri-plugins/pkg/apis/config/v1alpha1/metrics"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
 // Config provides runtime configuration for instrumentation.
+// +k8s:deepcopy-gen=true
 type Config struct {
 	// SamplingRatePerMillion is the number of samples to collect per million spans.
 	// +optional
@@ -33,9 +35,10 @@ type Config struct {
 	// +optional
 	// +kubebuilder:example="otlp-http://localhost:4318"
 	TracingCollector string `json:"tracingCollector,omitempty"`
-	// ReportPeriod is the interval between reporting aggregated metrics.
+	// ReportPeriod is the interval between between collecting polled metrics.
 	// +optional
 	// +kubebuilder:validation:Format="duration"
+	// +kubebuilder:default="30s"
 	ReportPeriod metav1.Duration `json:"reportPeriod,omitempty"`
 	// HTTPEndpoint is the address our HTTP server listens on. This endpoint is used
 	// to expose Prometheus metrics among other things.
@@ -45,4 +48,7 @@ type Config struct {
 	// PrometheusExport enables exporting /metrics for Prometheus.
 	// +optional
 	PrometheusExport bool `json:"prometheusExport,omitempty"`
+	// Metrics defines which metrics to collect.
+	// +kubebuilder:default={"enabled": {"policy"}}
+	Metrics *metrics.Config `json:"metrics,omitempty"`
 }
diff --git a/pkg/apis/config/v1alpha1/instrumentation/zz_generated.deepcopy.go b/pkg/apis/config/v1alpha1/instrumentation/zz_generated.deepcopy.go
diff --git a/pkg/apis/config/v1alpha1/metrics/config.go b/pkg/apis/config/v1alpha1/metrics/config.go
@@ -0,0 +1,28 @@
+// 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 metrics
+
+// Config provides runtime configuration for metrics collection.
+// +k8s:deepcopy-gen=true
+type Config struct {
+	// Enabled enables collection for metrics matched by glob patterns.
+	// +optional
+	// +kubebuilder:example={"*"}
+	Enabled []string `json:"enabled,omitempty"`
+	// Polled forces polled collection for metrics matched by glob patterns.
+	// +optional
+	// +kubebuilder:example={"computationally-expensive-metrics"}
+	Polled []string `json:"polled,omitempty"`
+}