RM API Endpoint: /listExperiments

[dinogun]

This is overview of the RM API endpoint design

listExperiments

Get the list of Autotune Experiments currently underway. Every experiment is
Request GET /listExperiments

GET /listExperiments?experiment_id=<ID>
curl -H 'Accept: application/json' http://<URL>:<PORT>/listExperiments?experiment_id=<ID>&trial_num=2

Response

[
   {
      "experiment_id": "2190310A384BC90EF",
      "application_name": "galaxies-sample-cf764b6d-kmh27",
      "objective_function": "request_sum/request_count",
      "sla_class": "response_time",
      "direction": "minimize",
      "trials": [
         {
            "app-version": "v1",
            "trial_id": "",
            "trial_num": 1,
            "trial_run": "15mins",
            "trial_measurement_time": "3mins",
            "training": {
               "deployment_name": "petclinic-sample-training-1",
               "state": "",
               "result": "",
               "result_info": "",
               "result_error": "",
               "metrics": [
                  {
                     "name": "request_sum",
                     "query": "request_sum_query",
                     "datasource": "prometheus",
                     "score": "",
                     "Error": "",
                     "min": "",
                     "mean": "",
                     "mode": "",
                     "max": "",
                     "95.0": "",
                     "99.0": "",
                     "99.9": "",
                     "99.99": "",
                     "99.999": "",
                     "99.9999": "",
                     "100.0": "",
                     "spike": ""
                  },
                  {
                     "name": "request_count",
                     "query": "request_count_query",
                     "datasource": "prometheus"
                  },
                  {
                     "name": "hotspot_function",
                     "query": "hotspot_function_query",
                     "datasource": "prometheus"
                  },
                  {
                     "name": "cpuRequest",
                     "query": "cpuRequest_query",
                     "datasource": "prometheus"
                  },
                  {
                     "name": "memRequest",
                     "query": "memRequest_query",
                     "datasource": "prometheus"
                  }
               ],
               "config": [
                  {
                     "name": "update requests and limits",
                     "spec": {
                        "template": {
                           "spec": {
                              "container": {
                                 "resources": {
                                    "requests": {
                                       "cpu": 2,
                                       "memory": "512Mi"
                                    },
                                    "limits": {
                                       "cpu": 3,
                                       "memory": "1024Mi"
                                    }
                                 }
                              }
                           }
                        }
                     }
                  },
                  {
                     "name": "update env",
                     "spec": {
                        "template": {
                           "spec": {
                              "container": {
                                 "env": {
                                    "JVM_OPTIONS": "-XX:MaxInlineLevel=23",
                                    "JVM_ARGS": "-XX:MaxInlineLevel=23"
                                 }
                              }
                           }
                        }
                     }
                  }
               ]
            },
            "production": {
               "deployment_name": "petclinic-sample-1",
               "state": "",
               "result": "",
               "result_info": "",
               "result_error": "",
               "metrics": [
                  {
                     "name": "request_sum",
                     "query": "request_sum_query",
                     "datasource": "prometheus",
                     "score": "",
                     "Error": "",
                     "min": "",
                     "mean": "",
                     "mode": "",
                     "max": "",
                     "95.0": "",
                     "99.0": "",
                     "99.9": "",
                     "99.99": "",
                     "99.999": "",
                     "99.9999": "",
                     "100.0": "",
                     "spike": ""
                  },
                  {
                     "name": "request_count",
                     "query": "request_count_query",
                     "datasource": "prometheus"
                  },
                  {
                     "name": "hotspot_function",
                     "query": "hotspot_function_query",
                     "datasource": "prometheus"
                  },
                  {
                     "name": "cpuRequest",
                     "query": "cpuRequest_query",
                     "datasource": "prometheus"
                  },
                  {
                     "name": "memRequest",
                     "query": "memRequest_query",
                     "datasource": "prometheus"
                  }
               ],
               "config": [
                  {
                     "name": "update requests and limits",
                     "spec": {
                        "template": {
                           "spec": {
                              "container": {
                                 "resources": {
                                    "requests": {
                                       "cpu": 2,
                                       "memory": "512Mi"
                                    },
                                    "limits": {
                                       "cpu": 3,
                                       "memory": "1024Mi"
                                    }
                                 }
                              }
                           }
                        }
                     }
                  },
                  {
                     "name": "update env",
                     "spec": {
                        "template": {
                           "spec": {
                              "container": {
                                 "env": {
                                    "JVM_OPTIONS": "-XX:MaxInlineLevel=23",
                                    "JVM_ARGS": "-XX:MaxInlineLevel=23"
                                 }
                              }
                           }
                        }
                     }
                  }
               ]
            }
         },
         {
            "app-version": "v1",
            "trial_id": "",
            "trial_num": 2,
            "trial_run": "15mins",
            "trial_measurement_time": "3mins",
            "training": {
               "state": "",
               "result": "",
               "result_info": "",
               "result_error": "",
               "metrics": [
                  {
                  }
               ],
               "config": [
                  {
                  }
               ]  
            },
            "production": {
               "state": "",
               "result": "",
               "result_info": "",
               "result_error": "",
               "metrics": [
                  {
                  }
               ],
               "config": [
                  {
                  }
               ]
            }
         }
      ]
   },
   {
      "experiment_id": "21901213354545310A384BC90EF",
      "application_name": "petclinic-c7f764b6d-kmh27",
      "objective_function": "request_count",
      "sla_class": "response_time",
      "direction": "minimize",
      "trials" : [
         {
         }
      ]
   }
]

[dinogun]

Updated the /listExperiments API to have both training pod and production pod info contained within the trials array. Both the training and production objects contain a metrics array that describe the parameters to be monitored and a config array that describes the config to be deployed (in the case of training) or the one that is currently running (in the case of production).

It is also possible that production is not to be monitored in which case, the values in the production object will be null.