Minor changes on FlowMetrics doc (#2025)

Author: jotak

api/flowmetrics/v1alpha1/flowmetric_types.go

@@ -43,7 +43,7 @@ const (
 )
 
 type MetricFilter struct {
-	// Name of the field to filter on
+	// Name of the field to filter on (for example: `SrcK8S_Namespace`).
 	// +required
 	Field string `json:"field"`
 
@@ -63,7 +63,7 @@ type MetricFilter struct {
 // usage of Prometheus workloads as this could potentially have a high impact. Cf https://rhobs-handbook.netlify.app/products/openshiftmonitoring/telemetry.md/#what-is-the-cardinality-of-a-metric<br>
 // To check the cardinality of all NetObserv metrics, run as `promql`: `count({__name__=~"netobserv.*"}) by (__name__)`.
 type FlowMetricSpec struct {
-	// Name of the metric. In Prometheus, it is automatically prefixed with "netobserv_".
+	// Name of the metric. In Prometheus, it is automatically prefixed with "netobserv_". Leave empty to generate the name based on the `FlowMetric` resource name.
 	// +kubebuilder:validation:Pattern:="^[a-zA-Z_][a-zA-Z0-9:_]*$|^$"
 	// +optional
 	MetricName string `json:"metricName"`
@@ -72,11 +72,11 @@ type FlowMetricSpec struct {
 	// Use "Counter" for any value that increases over time and on which you can compute a rate, such as Bytes or Packets.
 	// Use "Histogram" for any value that must be sampled independently, such as latencies.
 	// Use "Gauge" for other values that don't necessitate accuracy over time (gauges are sampled only every N seconds when Prometheus fetches the metric).
-	// +kubebuilder:validation:Enum:="Counter";"Histogram"
+	// +kubebuilder:validation:Enum:="Counter";"Histogram";"Gauge"
 	// +required
 	Type MetricType `json:"type"`
 
-	// `valueField` is the flow field that must be used as a value for this metric. This field must hold numeric values.
+	// `valueField` is the flow field that must be used as a value for this metric (for example: `Bytes`). This field must hold numeric values.
 	// Leave empty to count flows rather than a specific value per flow.
 	// Refer to the documentation for the list of available fields: https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/network_observability/json-flows-format-reference.
 	// +optional
@@ -87,7 +87,7 @@ type FlowMetricSpec struct {
 	// +optional
 	Filters []MetricFilter `json:"filters"`
 
-	// `labels` is a list of fields that should be used as Prometheus labels, also known as dimensions.
+	// `labels` is a list of fields that should be used as Prometheus labels, also known as dimensions (for example: `SrcK8S_Namespace`).
 	// From choosing labels results the level of granularity of this metric, and the available aggregations at query time.
 	// It must be done carefully as it impacts the metric cardinality (cf https://rhobs-handbook.netlify.app/products/openshiftmonitoring/telemetry.md/#what-is-the-cardinality-of-a-metric).
 	// In general, avoid setting very high cardinality labels such as IP or MAC addresses.

bundle/manifests/flows.netobserv.io_flowmetrics.yaml

@@ -162,7 +162,7 @@ spec:
                 items:
                   properties:
                     field:
-                      description: Name of the field to filter on
+                      description: 'Name of the field to filter on (for example: `SrcK8S_Namespace`).'
                       type: string
                     matchType:
                       default: Equal
@@ -194,7 +194,7 @@ spec:
                 type: array
               labels:
                 description: |-
-                  `labels` is a list of fields that should be used as Prometheus labels, also known as dimensions.
+                  `labels` is a list of fields that should be used as Prometheus labels, also known as dimensions (for example: `SrcK8S_Namespace`).
                   From choosing labels results the level of granularity of this metric, and the available aggregations at query time.
                   It must be done carefully as it impacts the metric cardinality (cf https://rhobs-handbook.netlify.app/products/openshiftmonitoring/telemetry.md/#what-is-the-cardinality-of-a-metric).
                   In general, avoid setting very high cardinality labels such as IP or MAC addresses.
@@ -205,7 +205,8 @@ spec:
                 type: array
               metricName:
                 description: Name of the metric. In Prometheus, it is automatically
-                  prefixed with "netobserv_".
+                  prefixed with "netobserv_". Leave empty to generate the name based
+                  on the `FlowMetric` resource name.
                 pattern: ^[a-zA-Z_][a-zA-Z0-9:_]*$|^$
                 type: string
               remap:
@@ -225,10 +226,11 @@ spec:
                 enum:
                 - Counter
                 - Histogram
+                - Gauge
                 type: string
               valueField:
                 description: |-
-                  `valueField` is the flow field that must be used as a value for this metric. This field must hold numeric values.
+                  `valueField` is the flow field that must be used as a value for this metric (for example: `Bytes`). This field must hold numeric values.
                   Leave empty to count flows rather than a specific value per flow.
                   Refer to the documentation for the list of available fields: https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/network_observability/json-flows-format-reference.
                 type: string

bundle/manifests/netobserv-operator.clusterserviceversion.yaml

@@ -253,7 +253,7 @@ metadata:
     categories: Monitoring, Networking, Observability
     console.openshift.io/plugins: '["netobserv-plugin"]'
     containerImage: quay.io/netobserv/network-observability-operator:1.9.2-community
-    createdAt: "2025-09-18T08:50:21Z"
+    createdAt: "2025-09-24T14:09:38Z"
     description: Network flows collector and monitoring solution
     operatorframework.io/initialization-resource: '{"apiVersion":"flows.netobserv.io/v1beta2",
       "kind":"FlowCollector","metadata":{"name":"cluster"},"spec": {}}'

config/crd/bases/flows.netobserv.io_flowmetrics.yaml

@@ -162,7 +162,7 @@ spec:
                 items:
                   properties:
                     field:
-                      description: Name of the field to filter on
+                      description: 'Name of the field to filter on (for example: `SrcK8S_Namespace`).'
                       type: string
                     matchType:
                       default: Equal
@@ -194,7 +194,7 @@ spec:
                 type: array
               labels:
                 description: |-
-                  `labels` is a list of fields that should be used as Prometheus labels, also known as dimensions.
+                  `labels` is a list of fields that should be used as Prometheus labels, also known as dimensions (for example: `SrcK8S_Namespace`).
                   From choosing labels results the level of granularity of this metric, and the available aggregations at query time.
                   It must be done carefully as it impacts the metric cardinality (cf https://rhobs-handbook.netlify.app/products/openshiftmonitoring/telemetry.md/#what-is-the-cardinality-of-a-metric).
                   In general, avoid setting very high cardinality labels such as IP or MAC addresses.
@@ -205,7 +205,8 @@ spec:
                 type: array
               metricName:
                 description: Name of the metric. In Prometheus, it is automatically
-                  prefixed with "netobserv_".
+                  prefixed with "netobserv_". Leave empty to generate the name based
+                  on the `FlowMetric` resource name.
                 pattern: ^[a-zA-Z_][a-zA-Z0-9:_]*$|^$
                 type: string
               remap:
@@ -225,10 +226,11 @@ spec:
                 enum:
                 - Counter
                 - Histogram
+                - Gauge
                 type: string
               valueField:
                 description: |-
-                  `valueField` is the flow field that must be used as a value for this metric. This field must hold numeric values.
+                  `valueField` is the flow field that must be used as a value for this metric (for example: `Bytes`). This field must hold numeric values.
                   Leave empty to count flows rather than a specific value per flow.
                   Refer to the documentation for the list of available fields: https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/network_observability/json-flows-format-reference.
                 type: string

docs/FlowMetric.md

@@ -100,7 +100,7 @@ Use "Counter" for any value that increases over time and on which you can comput
 Use "Histogram" for any value that must be sampled independently, such as latencies.
 Use "Gauge" for other values that don't necessitate accuracy over time (gauges are sampled only every N seconds when Prometheus fetches the metric).<br/>
           <br/>
-            <i>Enum</i>: Counter, Histogram<br/>
+            <i>Enum</i>: Counter, Histogram, Gauge<br/>
         </td>
         <td>true</td>
       </tr><tr>
@@ -156,7 +156,7 @@ For instance, when flattening `Interfaces` on a bytes counter, a flow having Int
         <td><b>labels</b></td>
         <td>[]string</td>
         <td>
-          `labels` is a list of fields that should be used as Prometheus labels, also known as dimensions.
+          `labels` is a list of fields that should be used as Prometheus labels, also known as dimensions (for example: `SrcK8S_Namespace`).
 From choosing labels results the level of granularity of this metric, and the available aggregations at query time.
 It must be done carefully as it impacts the metric cardinality (cf https://rhobs-handbook.netlify.app/products/openshiftmonitoring/telemetry.md/#what-is-the-cardinality-of-a-metric).
 In general, avoid setting very high cardinality labels such as IP or MAC addresses.
@@ -168,7 +168,7 @@ Refer to the documentation for the list of available fields: https://docs.redhat
         <td><b>metricName</b></td>
         <td>string</td>
         <td>
-          Name of the metric. In Prometheus, it is automatically prefixed with "netobserv_".<br/>
+          Name of the metric. In Prometheus, it is automatically prefixed with "netobserv_". Leave empty to generate the name based on the `FlowMetric` resource name.<br/>
         </td>
         <td>false</td>
       </tr><tr>
@@ -182,7 +182,7 @@ Refer to the documentation for the list of available fields: https://docs.redhat
         <td><b>valueField</b></td>
         <td>string</td>
         <td>
-          `valueField` is the flow field that must be used as a value for this metric. This field must hold numeric values.
+          `valueField` is the flow field that must be used as a value for this metric (for example: `Bytes`). This field must hold numeric values.
 Leave empty to count flows rather than a specific value per flow.
 Refer to the documentation for the list of available fields: https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/network_observability/json-flows-format-reference.<br/>
         </td>
@@ -330,7 +330,7 @@ To learn more about `promQL`, refer to the Prometheus documentation: https://pro
         <td><b>field</b></td>
         <td>string</td>
         <td>
-          Name of the field to filter on<br/>
+          Name of the field to filter on (for example: `SrcK8S_Namespace`).<br/>
         </td>
         <td>true</td>
       </tr><tr>

helm/crds/flows.netobserv.io_flowmetrics.yaml

@@ -152,7 +152,7 @@ spec:
                   items:
                     properties:
                       field:
-                        description: Name of the field to filter on
+                        description: 'Name of the field to filter on (for example: `SrcK8S_Namespace`).'
                         type: string
                       matchType:
                         default: Equal
@@ -182,7 +182,7 @@ spec:
                   type: array
                 labels:
                   description: |-
-                    `labels` is a list of fields that should be used as Prometheus labels, also known as dimensions.
+                    `labels` is a list of fields that should be used as Prometheus labels, also known as dimensions (for example: `SrcK8S_Namespace`).
                     From choosing labels results the level of granularity of this metric, and the available aggregations at query time.
                     It must be done carefully as it impacts the metric cardinality (cf https://rhobs-handbook.netlify.app/products/openshiftmonitoring/telemetry.md/#what-is-the-cardinality-of-a-metric).
                     In general, avoid setting very high cardinality labels such as IP or MAC addresses.
@@ -192,7 +192,7 @@ spec:
                     type: string
                   type: array
                 metricName:
-                  description: Name of the metric. In Prometheus, it is automatically prefixed with "netobserv_".
+                  description: Name of the metric. In Prometheus, it is automatically prefixed with "netobserv_". Leave empty to generate the name based on the `FlowMetric` resource name.
                   pattern: ^[a-zA-Z_][a-zA-Z0-9:_]*$|^$
                   type: string
                 remap:
@@ -210,10 +210,11 @@ spec:
                   enum:
                     - Counter
                     - Histogram
+                    - Gauge
                   type: string
                 valueField:
                   description: |-
-                    `valueField` is the flow field that must be used as a value for this metric. This field must hold numeric values.
+                    `valueField` is the flow field that must be used as a value for this metric (for example: `Bytes`). This field must hold numeric values.
                     Leave empty to count flows rather than a specific value per flow.
                     Refer to the documentation for the list of available fields: https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/network_observability/json-flows-format-reference.
                   type: string