feat: Add a selector for runtime volume metrics (#1486)

kyma-project · Oct 11, 2024 · 7adb021 · 7adb021
1 parent eadeaaa
commit 7adb021
Show file tree

Hide file tree

Showing 34 changed files with 798 additions and 148 deletions.
diff --git a/apis/telemetry/v1alpha1/metricpipeline_types.go b/apis/telemetry/v1alpha1/metricpipeline_types.go
@@ -103,7 +103,7 @@ type MetricPipelineRuntimeInput struct {
 	Namespaces *MetricPipelineInputNamespaceSelector `json:"namespaces,omitempty"`
 	// Describes the Kubernetes resources for which runtime metrics are scraped.
 	// +optional
-	// +kubebuilder:default={pod: {enabled: true}, container: {enabled: true}, node: {enabled: false}}
+	// +kubebuilder:default={pod: {enabled: true}, container: {enabled: true}, node: {enabled: false}, volume: {enabled: false}}
 	Resources *MetricPipelineRuntimeInputResources `json:"resources,omitempty"`
 }
 
@@ -121,6 +121,10 @@ type MetricPipelineRuntimeInputResources struct {
 	// +optional
 	// +kubebuilder:default={enabled: false}
 	Node *MetricPipelineRuntimeInputResourceDisabledByDefault `json:"node,omitempty"`
+	// Configures Volume runtime metrics scraping.
+	// +optional
+	// +kubebuilder:default={enabled: false}
+	Volume *MetricPipelineRuntimeInputResourceDisabledByDefault `json:"volume,omitempty"`
 }
 
 // MetricPipelineRuntimeInputResourceEnabledByDefault defines if the scraping of runtime metrics is enabled for a specific resource. The scraping is enabled by default.

diff --git a/apis/telemetry/v1alpha1/zz_generated.deepcopy.go b/apis/telemetry/v1alpha1/zz_generated.deepcopy.go
diff --git a/apis/telemetry/v1beta1/metricpipeline_types.go b/apis/telemetry/v1beta1/metricpipeline_types.go
@@ -90,7 +90,7 @@ type MetricPipelineRuntimeInput struct {
 	Namespaces *MetricPipelineInputNamespaceSelector `json:"namespaces,omitempty"`
 	// Describes the Kubernetes resources for which runtime metrics are scraped.
 	// +optional
-	// +kubebuilder:default={pod: {enabled: true}, container: {enabled: true}, node: {enabled: false}}
+	// +kubebuilder:default={pod: {enabled: true}, container: {enabled: true}, node: {enabled: false}, volume: {enabled: false}}
 	Resources *MetricPipelineRuntimeInputResources `json:"resources,omitempty"`
 }
 
@@ -108,6 +108,10 @@ type MetricPipelineRuntimeInputResources struct {
 	// +optional
 	// +kubebuilder:default={enabled: false}
 	Node *MetricPipelineRuntimeInputResourceDisabledByDefault `json:"node,omitempty"`
+	// Configures Volume runtime metrics scraping.
+	// +optional
+	// +kubebuilder:default={enabled: false}
+	Volume *MetricPipelineRuntimeInputResourceDisabledByDefault `json:"volume,omitempty"`
 }
 
 // MetricPipelineRuntimeInputResourceEnabledByDefault defines if the scraping of runtime metrics is enabled for a specific resource. The scraping is enabled by default.

diff --git a/apis/telemetry/v1beta1/zz_generated.deepcopy.go b/apis/telemetry/v1beta1/zz_generated.deepcopy.go
diff --git a/config/busola/metricpipeline_busola_extension_cm.yaml b/config/busola/metricpipeline_busola_extension_cm.yaml
@@ -112,6 +112,9 @@ data:
                   - name: Node
                     visibility: $exists(spec.input.runtime.resources.node)
                     source: spec.input.runtime.resources.node.enabled
+                  - name: Volume
+                    visibility: $exists(spec.input.runtime.resources.volume)
+                    source: spec.input.runtime.resources.volume.enabled
           - name: OTLP
             widget: Panel
             visibility: $exists(spec.input.otlp)
@@ -344,6 +347,9 @@ data:
               - name: Enable Node Metrics
                 path: node.enabled
                 simple: true
+              - name: Enable Volume Metrics
+                path: volume.enabled
+                simple: true
         - name: OTLP
           path: otlp
           widget: FormGroup

diff --git a/config/crd/bases/telemetry.kyma-project.io_metricpipelines.yaml b/config/crd/bases/telemetry.kyma-project.io_metricpipelines.yaml
@@ -223,6 +223,8 @@ spec:
                             enabled: false
                           pod:
                             enabled: true
+                          volume:
+                            enabled: false
                         description: Describes the Kubernetes resources for which
                           runtime metrics are scraped.
                         properties:
@@ -259,6 +261,17 @@ spec:
                                   resource are scraped. The default is `true`.
                                 type: boolean
                             type: object
+                          volume:
+                            default:
+                              enabled: false
+                            description: Configures Volume runtime metrics scraping.
+                            properties:
+                              enabled:
+                                default: false
+                                description: If enabled, the runtime metrics for the
+                                  resource are scraped. The default is `false`.
+                                type: boolean
+                            type: object
                         type: object
                     type: object
                 type: object

diff --git a/config/development/crd/bases/telemetry.kyma-project.io_metricpipelines.yaml b/config/development/crd/bases/telemetry.kyma-project.io_metricpipelines.yaml
@@ -223,6 +223,8 @@ spec:
                             enabled: false
                           pod:
                             enabled: true
+                          volume:
+                            enabled: false
                         description: Describes the Kubernetes resources for which
                           runtime metrics are scraped.
                         properties:
@@ -259,6 +261,17 @@ spec:
                                   resource are scraped. The default is `true`.
                                 type: boolean
                             type: object
+                          volume:
+                            default:
+                              enabled: false
+                            description: Configures Volume runtime metrics scraping.
+                            properties:
+                              enabled:
+                                default: false
+                                description: If enabled, the runtime metrics for the
+                                  resource are scraped. The default is `false`.
+                                type: boolean
+                            type: object
                         type: object
                     type: object
                 type: object
@@ -825,6 +838,8 @@ spec:
                             enabled: false
                           pod:
                             enabled: true
+                          volume:
+                            enabled: false
                         description: Describes the Kubernetes resources for which
                           runtime metrics are scraped.
                         properties:
@@ -861,6 +876,17 @@ spec:
                                   resource are scraped. The default is `true`.
                                 type: boolean
                             type: object
+                          volume:
+                            default:
+                              enabled: false
+                            description: Configures Volume runtime metrics scraping.
+                            properties:
+                              enabled:
+                                default: false
+                                description: If enabled, the runtime metrics for the
+                                  resource are scraped. The default is `false`.
+                                type: boolean
+                            type: object
                         type: object
                     type: object
                 type: object

diff --git a/config/rbac/role.yaml b/config/rbac/role.yaml
@@ -17,6 +17,7 @@ rules:
   - namespaces/status
   - nodes
   - nodes/metrics
+  - nodes/proxy
   - nodes/spec
   - nodes/stats
   - pods

diff --git a/docs/user/04-metrics.md b/docs/user/04-metrics.md
@@ -31,7 +31,7 @@ Optionally, the Telemetry module provides a DaemonSet of an OTel Collector actin
 1. An application (exposing metrics in OTLP) sends metrics to the central metric gateway service.
 2. An application (exposing metrics in Prometheus protocol) activates the agent to scrape the metrics with an annotation-based configuration.
 3. Additionally, you can activate the agent to pull metrics of each Istio sidecar.
-4. The agent supports collecting container metrics from the Kubelet and Kubernetes APIServer.
+4. The agent supports collecting metrics from the Kubelet and Kubernetes APIServer.
 5. The agent converts and sends all collected metric data to the gateway in OTLP.
 6. The gateway discovers the metadata and enriches all received data with typical metadata of the source by communicating with the Kubernetes APIServer. Furthermore, it filters data according to the pipeline configuration.
 7. Telemetry Manager configures the agent and gateway according to the `MetricPipeline` resource specification, including the target backend for the metric gateway. Also, it observes the metrics flow to the backend and reports problems in the MetricPipeline status.
@@ -414,13 +414,15 @@ The following example collects only the Pod metrics:
             enabled: false
           node:
             enabled: false
+          volume:
+            enabled: false
     output:
       otlp:
         endpoint:
           value: https://backend.example.com:4317
   ```
 
-If you enable Pod metrics, the following metrics are collected:
+If Pod metrics are enabled, the following metrics are collected:
 
 - From the [kubletstatsreceiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/kubeletstatsreceiver):
   - `k8s.pod.cpu.capacity`
@@ -470,6 +472,13 @@ If Node metrics are enabled, the following metrics are collected:
   - `k8s.node.memory.rss`
   - `k8s.node.memory.working_set`
 
+If Volume metrics are enabled, the following metrics are collected:
+- From the [kubletstatsreceiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/kubeletstatsreceiver):
+  - `k8s.volume.available`
+  - `k8s.volume.capacity`
+  - `k8s.volume.inodes`
+  - `k8s.volume.inodes.free`
+  - `k8s.volume.inodes.used`
 
 ### 7. Activate Istio Metrics
 

diff --git a/docs/user/assets/metrics-arch.drawio.svg b/docs/user/assets/metrics-arch.drawio.svg
diff --git a/docs/user/resources/05-metricpipeline.md b/docs/user/resources/05-metricpipeline.md
@@ -100,6 +100,8 @@ For details, see the [MetricPipeline specification file](https://github.com/kyma
 | **input.&#x200b;runtime.&#x200b;resources.&#x200b;node.&#x200b;enabled**  | boolean | If enabled, the runtime metrics for the resource are scraped. The default is `false`. |
 | **input.&#x200b;runtime.&#x200b;resources.&#x200b;pod**  | object | Configures Pod runtime metrics scraping. |
 | **input.&#x200b;runtime.&#x200b;resources.&#x200b;pod.&#x200b;enabled**  | boolean | If enabled, the runtime metrics for the resource are scraped. The default is `true`. |
+| **input.&#x200b;runtime.&#x200b;resources.&#x200b;volume**  | object | Configures Volume runtime metrics scraping. |
+| **input.&#x200b;runtime.&#x200b;resources.&#x200b;volume.&#x200b;enabled**  | boolean | If enabled, the runtime metrics for the resource are scraped. The default is `false`. |
 | **output**  | object | Configures the metric gateway. |
 | **output.&#x200b;otlp** (required) | object | Defines an output using the OpenTelemetry protocol. |
 | **output.&#x200b;otlp.&#x200b;authentication**  | object | Defines authentication options for the OTLP output |

diff --git a/internal/otelcollector/config/metric/agent/config.go b/internal/otelcollector/config/metric/agent/config.go
@@ -23,12 +23,13 @@ type Receivers struct {
 }
 
 type KubeletStatsReceiver struct {
-	CollectionInterval string                    `yaml:"collection_interval"`
-	AuthType           string                    `yaml:"auth_type"`
-	Endpoint           string                    `yaml:"endpoint"`
-	InsecureSkipVerify bool                      `yaml:"insecure_skip_verify"`
-	MetricGroups       []MetricGroupType         `yaml:"metric_groups"`
-	Metrics            KubeletStatsMetricsConfig `yaml:"metrics"`
+	CollectionInterval  string                    `yaml:"collection_interval"`
+	AuthType            string                    `yaml:"auth_type"`
+	Endpoint            string                    `yaml:"endpoint"`
+	InsecureSkipVerify  bool                      `yaml:"insecure_skip_verify"`
+	MetricGroups        []MetricGroupType         `yaml:"metric_groups"`
+	Metrics             KubeletStatsMetricsConfig `yaml:"metrics"`
+	ExtraMetadataLabels []string                  `yaml:"extra_metadata_labels,omitempty"`
 }
 
 type MetricConfig struct {
@@ -55,6 +56,7 @@ const (
 	MetricGroupTypeContainer MetricGroupType = "container"
 	MetricGroupTypePod       MetricGroupType = "pod"
 	MetricGroupTypeNode      MetricGroupType = "node"
+	MetricGroupTypeVolume    MetricGroupType = "volume"
 )
 
 type PrometheusReceiver struct {
@@ -128,6 +130,7 @@ type Processors struct {
 	SetInstrumentationScopePrometheus *metric.TransformProcessor `yaml:"transform/set-instrumentation-scope-prometheus,omitempty"`
 	SetInstrumentationScopeIstio      *metric.TransformProcessor `yaml:"transform/set-instrumentation-scope-istio,omitempty"`
 	InsertSkipEnrichmentAttribute     *metric.TransformProcessor `yaml:"transform/insert-skip-enrichment-attribute,omitempty"`
+	DropNonPVCVolumesMetrics          *FilterProcessor           `yaml:"filter/drop-non-pvc-volumes-metrics,omitempty"`
 }
 
 type Exporters struct {