Added metric name to GetObservationLogRequest (kubeflow#559)

* Adding metric name to GetObservationLogRequest * regenerate mockdb
arrikto · May 20, 2019 · 4c378bc · 4c378bc
1 parent 0a98288
commit 4c378bc
Show file tree

Hide file tree

Showing 12 changed files with 613 additions and 371 deletions.
diff --git a/cmd/manager/v1alpha2/main.go b/cmd/manager/v1alpha2/main.go
@@ -121,7 +121,7 @@ func (s *server) ReportObservationLog(ctx context.Context, in *api_pb.ReportObse
 
 // Get all log of Observations for a Trial.
 func (s *server) GetObservationLog(ctx context.Context, in *api_pb.GetObservationLogRequest) (*api_pb.GetObservationLogReply, error) {
-	ol, err := dbIf.GetObservationLog(in.TrialName, in.StartTime, in.EndTime)
+	ol, err := dbIf.GetObservationLog(in.TrialName, in.MetricName, in.StartTime, in.EndTime)
 	return &api_pb.GetObservationLogReply{
 		ObservationLog: ol,
 	}, err

diff --git a/cmd/manager/v1alpha2/main_test.go b/cmd/manager/v1alpha2/main_test.go
@@ -597,7 +597,7 @@ func TestGetObservationLog(t *testing.T) {
 		},
 	}
 
-	mockDB.EXPECT().GetObservationLog(req.TrialName, req.StartTime, req.EndTime).Return(obs, nil)
+	mockDB.EXPECT().GetObservationLog(req.TrialName, req.MetricName, req.StartTime, req.EndTime).Return(obs, nil)
 	ret, err := s.GetObservationLog(context.Background(), req)
 	if err != nil {
 		t.Fatalf("GetObservationLog Error %v", err)

diff --git a/pkg/api/v1alpha2/api.pb.go b/pkg/api/v1alpha2/api.pb.go
diff --git a/pkg/api/v1alpha2/api.pb.gw.go b/pkg/api/v1alpha2/api.pb.gw.go
diff --git a/pkg/api/v1alpha2/api.proto b/pkg/api/v1alpha2/api.proto
@@ -149,7 +149,8 @@ service Manager {
      */
     rpc GetObservationLog(GetObservationLogRequest) returns (GetObservationLogReply){
         option (google.api.http) = {
-            get: "/api/Manager/GetObservationLog/{trial_name}"
+            post: "/api/Manager/GetObservationLog"
+            body: "*"
             };
     };
 
@@ -491,8 +492,9 @@ message ReportObservationLogReply {
 
 message GetObservationLogRequest {
     string trial_name = 1;
-    string start_time = 2; ///The start of the time range. RFC3339 format
-    string end_time = 3; ///The end of the time range. RFC3339 format
+    string metric_name = 2;
+    string start_time = 3; ///The start of the time range. RFC3339 format
+    string end_time = 4; ///The end of the time range. RFC3339 format
 }
 
 message GetObservationLogReply {

diff --git a/pkg/api/v1alpha2/api.swagger.json b/pkg/api/v1alpha2/api.swagger.json
@@ -132,8 +132,8 @@
         ]
       }
     },
-    "/api/Manager/GetObservationLog/{trial_name}": {
-      "get": {
+    "/api/Manager/GetObservationLog": {
+      "post": {
         "summary": "*\nGet all log of Observations for a Trial.",
         "operationId": "GetObservationLog",
         "responses": {
@@ -146,22 +146,12 @@
         },
         "parameters": [
           {
-            "name": "trial_name",
-            "in": "path",
+            "name": "body",
+            "in": "body",
             "required": true,
-            "type": "string"
-          },
-          {
-            "name": "start_time",
-            "in": "query",
-            "required": false,
-            "type": "string"
-          },
-          {
-            "name": "end_time",
-            "in": "query",
-            "required": false,
-            "type": "string"
+            "schema": {
+              "$ref": "#/definitions/alpha2GetObservationLogRequest"
+            }
           }
         ],
         "tags": [
@@ -681,6 +671,23 @@
         }
       }
     },
+    "alpha2GetObservationLogRequest": {
+      "type": "object",
+      "properties": {
+        "trial_name": {
+          "type": "string"
+        },
+        "metric_name": {
+          "type": "string"
+        },
+        "start_time": {
+          "type": "string"
+        },
+        "end_time": {
+          "type": "string"
+        }
+      }
+    },
     "alpha2GetSuggestionsReply": {
       "type": "object",
       "properties": {