Add process_start_time_seconds metric into csi metric lib

Author: Jiawei0227

metrics/metrics.go

@@ -357,7 +357,7 @@ func VerifyMetricsMatch(expectedMetrics, actualMetrics string, metricToIgnore st
 		wantScanner.Scan()
 		wantLine := strings.TrimSpace(wantScanner.Text())
 		gotLine := strings.TrimSpace(gotScanner.Text())
-		if wantLine != gotLine && (metricToIgnore == "" || !strings.HasPrefix(gotLine, metricToIgnore)) {
+		if wantLine != gotLine && (metricToIgnore == "" || !strings.HasPrefix(gotLine, metricToIgnore)) && !strings.HasPrefix(gotLine, "#") {
 			return fmt.Errorf("\r\nMetric Want: %q\r\nMetric Got:  %q\r\n", wantLine, gotLine)
 		}
 	}
@@ -366,6 +366,7 @@ func VerifyMetricsMatch(expectedMetrics, actualMetrics string, metricToIgnore st
 }
 
 func (cmm *csiMetricsManager) registerMetrics() {
+	metrics.RegisterProcessStartTime(cmm.registry.Register)
 	cmm.registry.MustRegister(cmm.csiOperationsLatencyMetric)
 }
 

metrics/metrics_test.go

@@ -29,6 +29,11 @@ import (
 	"k8s.io/component-base/metrics/testutil"
 )
 
+const (
+	SidecarOperationMetric = "csi_sidecar_operations_seconds"
+	ProcessStartTimeMetric = "process_start_time_seconds"
+)
+
 func TestRecordMetrics(t *testing.T) {
 	testcases := map[string]struct {
 		subsystem      string
@@ -102,15 +107,17 @@ func testRecordMetrics(t *testing.T, subsystem string, stabilityLevel metrics.St
 		csi_sidecar_operations_seconds_sum{driver_name="fake.csi.driver.io",grpc_status_code="OK",method_name="/csi.v1.Controller/ControllerGetCapabilities"} 20
 		csi_sidecar_operations_seconds_count{driver_name="fake.csi.driver.io",grpc_status_code="OK",method_name="/csi.v1.Controller/ControllerGetCapabilities"} 1
 		`
+	metricName := SidecarOperationMetric
 	if subsystem != "" {
 		expectedMetrics = strings.Replace(expectedMetrics, "csi_sidecar", subsystem, -1)
+		metricName = strings.Replace(metricName, "csi_sidecar", subsystem, -1)
 	}
 	if stabilityLevel != "" {
 		expectedMetrics = strings.Replace(expectedMetrics, "ALPHA", string(stabilityLevel), -1)
 	}
 
 	if err := testutil.GatherAndCompare(
-		cmm.GetRegistry(), strings.NewReader(expectedMetrics)); err != nil {
+		cmm.GetRegistry(), strings.NewReader(expectedMetrics), metricName); err != nil {
 		t.Fatal(err)
 	}
 }
@@ -150,8 +157,9 @@ func TestFixedLabels(t *testing.T) {
 		csi_sidecar_operations_seconds_count{a="111",b="222",driver_name="unknown-driver",grpc_status_code="OK",method_name="myOperation"} 1
 	`
 
+	time.Sleep(1000)
 	if err := testutil.GatherAndCompare(
-		cmm.GetRegistry(), strings.NewReader(expectedMetrics)); err != nil {
+		cmm.GetRegistry(), strings.NewReader(expectedMetrics), SidecarOperationMetric); err != nil {
 		t.Fatal(err)
 	}
 }
@@ -200,7 +208,7 @@ func TestVaryingLabels(t *testing.T) {
 	`
 
 	if err := testutil.GatherAndCompare(
-		cmm.GetRegistry(), strings.NewReader(expectedMetrics)); err != nil {
+		cmm.GetRegistry(), strings.NewReader(expectedMetrics), SidecarOperationMetric); err != nil {
 		t.Fatal(err)
 	}
 }
@@ -273,7 +281,7 @@ func TestTwoVaryingLabels(t *testing.T) {
 	`
 
 	if err := testutil.GatherAndCompare(
-		cmm.GetRegistry(), strings.NewReader(expectedMetrics)); err != nil {
+		cmm.GetRegistry(), strings.NewReader(expectedMetrics), SidecarOperationMetric); err != nil {
 		t.Fatal(err)
 	}
 }
@@ -318,7 +326,7 @@ func TestVaryingLabelsBackfill(t *testing.T) {
 	`
 
 	if err := testutil.GatherAndCompare(
-		cmm.GetRegistry(), strings.NewReader(expectedMetrics)); err != nil {
+		cmm.GetRegistry(), strings.NewReader(expectedMetrics), SidecarOperationMetric); err != nil {
 		t.Fatal(err)
 	}
 }
@@ -392,7 +400,7 @@ func TestCombinedLabels(t *testing.T) {
 	`
 
 	if err := testutil.GatherAndCompare(
-		cmm.GetRegistry(), strings.NewReader(expectedMetrics)); err != nil {
+		cmm.GetRegistry(), strings.NewReader(expectedMetrics), SidecarOperationMetric); err != nil {
 		t.Fatal(err)
 	}
 }
@@ -431,7 +439,7 @@ func TestRecordMetrics_NoDriverName(t *testing.T) {
 	`
 
 	if err := testutil.GatherAndCompare(
-		cmm.GetRegistry(), strings.NewReader(expectedMetrics)); err != nil {
+		cmm.GetRegistry(), strings.NewReader(expectedMetrics), SidecarOperationMetric); err != nil {
 		t.Fatal(err)
 	}
 }
@@ -469,7 +477,7 @@ func TestRecordMetrics_Negative(t *testing.T) {
 		csi_sidecar_operations_seconds_count{driver_name="fake.csi.driver.io",grpc_status_code="InvalidArgument",method_name="myOperation"} 1
 		`
 	if err := testutil.GatherAndCompare(
-		cmm.GetRegistry(), strings.NewReader(expectedMetrics)); err != nil {
+		cmm.GetRegistry(), strings.NewReader(expectedMetrics), SidecarOperationMetric); err != nil {
 		t.Fatal(err)
 	}
 }
@@ -488,7 +496,7 @@ func TestStartMetricsEndPoint_Noop(t *testing.T) {
 		operationDuration /* operationDuration */)
 
 	// Assert
-	request, err := http.NewRequest("GET", "http://localhost:8080/metrics", strings.NewReader(""))
+	request, err := http.NewRequest("GET", "http://localhost:8080/metrics?"+SidecarOperationMetric, strings.NewReader(""))
 	if err != nil {
 		t.Fatalf("Creating request for metrics endpoint failed: %v", err)
 	}
@@ -524,10 +532,10 @@ func TestStartMetricsEndPoint_Noop(t *testing.T) {
 		csi_sidecar_operations_seconds_bucket{driver_name="fake.csi.driver.io",grpc_status_code="OK",method_name="/csi.v1.Controller/ControllerGetCapabilities",le="+Inf"} 1
 		csi_sidecar_operations_seconds_sum{driver_name="fake.csi.driver.io",grpc_status_code="OK",method_name="/csi.v1.Controller/ControllerGetCapabilities"} 20
 		csi_sidecar_operations_seconds_count{driver_name="fake.csi.driver.io",grpc_status_code="OK",method_name="/csi.v1.Controller/ControllerGetCapabilities"} 1
-`
+	`
 
 	actualMetrics := string(contentBytes)
-	if err := VerifyMetricsMatch(expectedMetrics, actualMetrics, ""); err != nil {
+	if err := VerifyMetricsMatch(expectedMetrics, actualMetrics, ProcessStartTimeMetric); err != nil {
 		t.Fatalf("Metrics returned by end point do not match expectation: %v", err)
 	}
 }