get display name for metric charts from config

Signed-off-by: adarsh0728 <[email protected]>
numaproj · Dec 19, 2024 · c2f7bce · c2f7bce
1 parent 7d28085
commit c2f7bce
Show file tree

Hide file tree

Showing 10 changed files with 42 additions and 23 deletions.
diff --git a/config/advanced-install/namespaced-numaflow-server.yaml b/config/advanced-install/namespaced-numaflow-server.yaml
@@ -156,6 +156,7 @@ data:
           required: false
       metrics:
         - metric_name: vertex_pending_messages
+          display_name: Vertex Pending Messages
           required_filters:
             - namespace
             - pipeline
@@ -189,6 +190,7 @@ data:
           required: false
       metrics:
         - metric_name: monovtx_pending
+          display_name: Mono Vertex Pending Messages
           required_filters:
             - namespace
             - mvtx_name
@@ -225,6 +227,7 @@ data:
           required: false
       metrics:
         - metric_name: monovtx_processing_time_bucket
+          display_name: Mono Vertex Processing Time Latency
           required_filters:
             - namespace
             - mvtx_name
@@ -235,6 +238,7 @@ data:
                 - name: pod
                   required: false
         - metric_name: monovtx_sink_time_bucket
+          display_name: Mono Vertex Sink Write Time Latency
           required_filters:
             - namespace
             - mvtx_name
@@ -259,6 +263,7 @@ data:
           required: false
       metrics:
         - metric_name: forwarder_data_read_total
+          display_name: Vertex Read Processing Rate
           required_filters:
             - namespace
             - pipeline
@@ -284,6 +289,7 @@ data:
           required: false
       metrics:
         - metric_name: monovtx_read_total
+          display_name: Mono Vertex Read Processing Rate
           required_filters:
             - namespace
             - mvtx_name

diff --git a/config/advanced-install/numaflow-server.yaml b/config/advanced-install/numaflow-server.yaml
@@ -163,6 +163,7 @@ data:
           required: false
       metrics:
         - metric_name: vertex_pending_messages
+          display_name: Vertex Pending Messages
           required_filters:
             - namespace
             - pipeline
@@ -196,6 +197,7 @@ data:
           required: false
       metrics:
         - metric_name: monovtx_pending
+          display_name: Mono Vertex Pending Messages
           required_filters:
             - namespace
             - mvtx_name
@@ -232,6 +234,7 @@ data:
           required: false
       metrics:
         - metric_name: monovtx_processing_time_bucket
+          display_name: Mono Vertex Processing Time Latency
           required_filters:
             - namespace
             - mvtx_name
@@ -242,6 +245,7 @@ data:
                 - name: pod
                   required: false
         - metric_name: monovtx_sink_time_bucket
+          display_name: Mono Vertex Sink Write Time Latency
           required_filters:
             - namespace
             - mvtx_name
@@ -266,6 +270,7 @@ data:
           required: false
       metrics:
         - metric_name: forwarder_data_read_total
+          display_name: Vertex Read Processing Rate
           required_filters:
             - namespace
             - pipeline
@@ -291,6 +296,7 @@ data:
           required: false
       metrics:
         - metric_name: monovtx_read_total
+          display_name: Mono Vertex Read Processing Rate
           required_filters:
             - namespace
             - mvtx_name

diff --git a/config/base/numaflow-server/numaflow-server-metrics-proxy-config.yaml b/config/base/numaflow-server/numaflow-server-metrics-proxy-config.yaml
@@ -22,6 +22,7 @@ data:
           required: false
       metrics:
         - metric_name: vertex_pending_messages
+          display_name: Vertex Pending Messages
           required_filters:
             - namespace
             - pipeline
@@ -55,6 +56,7 @@ data:
           required: false
       metrics:
         - metric_name: monovtx_pending
+          display_name: Mono Vertex Pending Messages
           required_filters:
             - namespace
             - mvtx_name
@@ -91,6 +93,7 @@ data:
           required: false
       metrics:
         - metric_name: monovtx_processing_time_bucket
+          display_name: Mono Vertex Processing Time Latency
           required_filters:
             - namespace
             - mvtx_name
@@ -101,6 +104,7 @@ data:
                 - name: pod
                   required: false
         - metric_name: monovtx_sink_time_bucket
+          display_name: Mono Vertex Sink Write Time Latency
           required_filters:
             - namespace
             - mvtx_name
@@ -125,6 +129,7 @@ data:
           required: false
       metrics:
         - metric_name: forwarder_data_read_total
+          display_name: Vertex Read Processing Rate
           required_filters:
             - namespace
             - pipeline
@@ -150,6 +155,7 @@ data:
           required: false
       metrics:
         - metric_name: monovtx_read_total
+          display_name: Mono Vertex Read Processing Rate
           required_filters:
             - namespace
             - mvtx_name

diff --git a/config/install.yaml b/config/install.yaml
@@ -28576,6 +28576,7 @@ data:
           required: false
       metrics:
         - metric_name: vertex_pending_messages
+          display_name: Vertex Pending Messages
           required_filters:
             - namespace
             - pipeline
@@ -28609,6 +28610,7 @@ data:
           required: false
       metrics:
         - metric_name: monovtx_pending
+          display_name: Mono Vertex Pending Messages
           required_filters:
             - namespace
             - mvtx_name
@@ -28645,6 +28647,7 @@ data:
           required: false
       metrics:
         - metric_name: monovtx_processing_time_bucket
+          display_name: Mono Vertex Processing Time Latency
           required_filters:
             - namespace
             - mvtx_name
@@ -28655,6 +28658,7 @@ data:
                 - name: pod
                   required: false
         - metric_name: monovtx_sink_time_bucket
+          display_name: Mono Vertex Sink Write Time Latency
           required_filters:
             - namespace
             - mvtx_name
@@ -28679,6 +28683,7 @@ data:
           required: false
       metrics:
         - metric_name: forwarder_data_read_total
+          display_name: Vertex Read Processing Rate
           required_filters:
             - namespace
             - pipeline
@@ -28704,6 +28709,7 @@ data:
           required: false
       metrics:
         - metric_name: monovtx_read_total
+          display_name: Mono Vertex Read Processing Rate
           required_filters:
             - namespace
             - mvtx_name

diff --git a/config/namespace-install.yaml b/config/namespace-install.yaml
@@ -28464,6 +28464,7 @@ data:
           required: false
       metrics:
         - metric_name: vertex_pending_messages
+          display_name: Vertex Pending Messages
           required_filters:
             - namespace
             - pipeline
@@ -28497,6 +28498,7 @@ data:
           required: false
       metrics:
         - metric_name: monovtx_pending
+          display_name: Mono Vertex Pending Messages
           required_filters:
             - namespace
             - mvtx_name
@@ -28533,6 +28535,7 @@ data:
           required: false
       metrics:
         - metric_name: monovtx_processing_time_bucket
+          display_name: Mono Vertex Processing Time Latency
           required_filters:
             - namespace
             - mvtx_name
@@ -28543,6 +28546,7 @@ data:
                 - name: pod
                   required: false
         - metric_name: monovtx_sink_time_bucket
+          display_name: Mono Vertex Sink Write Time Latency
           required_filters:
             - namespace
             - mvtx_name
@@ -28567,6 +28571,7 @@ data:
           required: false
       metrics:
         - metric_name: forwarder_data_read_total
+          display_name: Vertex Read Processing Rate
           required_filters:
             - namespace
             - pipeline
@@ -28592,6 +28597,7 @@ data:
           required: false
       metrics:
         - metric_name: monovtx_read_total
+          display_name: Mono Vertex Read Processing Rate
           required_filters:
             - namespace
             - mvtx_name

diff --git a/server/apis/v1/handler.go b/server/apis/v1/handler.go
@@ -1340,7 +1340,7 @@ func (h *handler) DiscoverMetrics(c *gin.Context) {
 					})
 				}
 
-				discoveredMetrics = append(discoveredMetrics, NewDiscoveryResponse(metric.Name, dimensionData))
+				discoveredMetrics = append(discoveredMetrics, NewDiscoveryResponse(metric.Name, metric.DisplayName, dimensionData))
 			}
 		}
 	}

diff --git a/server/apis/v1/response_metrics.go b/server/apis/v1/response_metrics.go
@@ -32,7 +32,8 @@ type Dimension struct {
 }
 
 type Metric struct {
-	Name string `yaml:"metric_name"`
+	Name        string `yaml:"metric_name"`
+	DisplayName string `yaml:"display_name"`
 	// array of required labels.
 	Filters []string `yaml:"required_filters"`
 	//array of dimensions and their data

diff --git a/server/apis/v1/response_metrics_discovery.go b/server/apis/v1/response_metrics_discovery.go
@@ -7,17 +7,19 @@ type Dimensions struct {
 }
 
 type DiscoveryResponse struct {
-	MetricName string       `json:"metric_name"`
-	Dimensions []Dimensions `json:"dimensions"`
+	MetricName  string       `json:"metric_name"`
+	DisplayName string       `json:"display_name"`
+	Dimensions  []Dimensions `json:"dimensions"`
 }
 
 // MetricsDiscoveryResponse is a list of DiscoveryResponse
 type MetricsDiscoveryResponse []DiscoveryResponse
 
 // NewDiscoveryResponse creates a new DiscoveryResponse object for each metric.
-func NewDiscoveryResponse(metricName string, dimensions []Dimensions) DiscoveryResponse {
+func NewDiscoveryResponse(metricName, displayName string, dimensions []Dimensions) DiscoveryResponse {
 	return DiscoveryResponse{
-		MetricName: metricName,
-		Dimensions: dimensions,
+		MetricName:  metricName,
+		DisplayName: displayName,
+		Dimensions:  dimensions,
 	}
 }
diff --git a/...ials/Graph/partials/NodeInfo/partials/Pods/partials/PodDetails/partials/Metrics/index.tsx b/...ials/Graph/partials/NodeInfo/partials/Pods/partials/PodDetails/partials/Metrics/index.tsx
diff --git a/...h/partials/NodeInfo/partials/Pods/partials/PodDetails/partials/Metrics/utils/constants.ts b/...h/partials/NodeInfo/partials/Pods/partials/PodDetails/partials/Metrics/utils/constants.ts
-Original file line number
+Diff line change
@@ Expand Up / @@ -1340,7 +1340,7 @@ func (h *handler) DiscoverMetrics(c *gin.Context) { @@
     					})
     				}
-    				discoveredMetrics = append(discoveredMetrics, NewDiscoveryResponse(metric.Name, dimensionData))
+    				discoveredMetrics = append(discoveredMetrics, NewDiscoveryResponse(metric.Name, metric.DisplayName, dimensionData))
     			}
     		}
     	}
@@ Expand Down @@