webhook implementation

design/BulkAPI.md

@@ -51,7 +51,10 @@ progress of the job.
   "experiment_types": [
     "container",
     "namespace"
-  ]
+  ],
+  "webhook": {
+    "url" : "http://127.0.0.1:8080/webhook"
+  }
 }
 ```
 
@@ -75,6 +78,11 @@ progress of the job.
 
 - **experiment_types:** Specifies the type(s) of experiments to run, e.g., `"container"` or `"namespace"`.
 
+- **webhook:** The `webhook` parameter allows the system to notify an external service or consumer about the completion status of
+  an experiment-processing job. When a job is completed, this webhook will be triggered to send an HTTP request to a
+  predefined URL, configured either via an environment variable (`webhookURL`) or within a `kruize` configuration
+  file or via input payload.
+
 ### Success Response
 
 - **Status:** 200 OK
@@ -119,7 +127,10 @@ GET /bulk?job_id=123e4567-e89b-12d3-a456-426614174000
   "processed_experiments": 23,
   "job_id": "54905959-77d4-42ba-8e06-90bb97b823b9",
   "job_start_time": "2024-10-10T06:07:09.066Z",
-  "job_end_time": "2024-10-10T06:07:17.471Z"
+  "job_end_time": "2024-10-10T06:07:17.471Z",
+  "webhook": {
+    "status": "COMPLETED"
+  }
 }
 ```
 
@@ -189,7 +200,7 @@ example 1:
 }
 ```
 
-example 2:
+example 2:  Job failed
 
 ```json
 {
@@ -205,11 +216,35 @@ example 2:
   },
   "job_id": "270fa4d9-2701-4ca0-b056-74229cc28498",
   "job_start_time": "2024-11-12T15:05:46.362Z",
-  "job_end_time": "2024-11-12T15:06:05.301Z"
+  "job_end_time": "2024-11-12T15:06:05.301Z",
+  "webhook": {
+    "status": "COMPLETED"
+  }
 }
 
 ```
 
+example 3:  Only Webhook failed
+
+```json
+{
+  "status": "COMPLETED",
+  "total_experiments": 23,
+  "processed_experiments": 23,
+  "job_id": "54905959-77d4-42ba-8e06-90bb97b823b9",
+  "job_start_time": "2024-10-10T06:07:09.066Z",
+  "job_end_time": "2024-10-10T06:07:17.471Z",
+  "webhook": {
+    "status": "FAILED",
+    "notifications": {
+      "type": "ERROR",
+      "message": "HttpHostConnectException: Unable to connect to the webhook. Please try again later.",
+      "code": 503
+    }
+  }
+}
+```
+
 ### Response Parameters
 
 ## API Description: Experiment and Recommendation Processing Status
@@ -275,6 +310,20 @@ resource optimization in Kubernetes environments. Below is a breakdown of the JS
     - **Type**: `String (ISO 8601 format) or null`
     - **Description**: End timestamp of the job. If the job is still in progress, this will be `null`.
 
+- **webhook**:
+    - **Type**: `Object`
+    - **Description**: An object that provides details about the webhook status and any errors encountered during the
+      webhook invocation.
+
+    - The `webhook` parameter allows the system to notify an external service or consumer about the completion status of
+      an experiment-processing job. When a job is completed, this webhook will be triggered to send an HTTP request to a
+      predefined URL, configured either via an environment variable (`webhookURL`) or within a `kruize` configuration
+      file.
+      This notification mechanism is essential for systems that require real-time updates about the job's processing
+      status, enabling consumers to take immediate follow-up actions. For example, an external analytics dashboard, a
+      monitoring service, or a message queue like Kafka can listen for these webhook calls to further process or log the
+      job completion data.
+
 **Note: Experiment Name:**
 
 - **Naming Pattern:** Experiment names are currently formed using the following pattern:
@@ -300,27 +349,27 @@ resource optimization in Kubernetes environments. Below is a breakdown of the JS
 apiVersion: v1
 kind: ConfigMap
 metadata:
-name: kruizeconfig
-namespace: openshift-tuning
+  name: kruizeconfig
+  namespace: openshift-tuning
 data:
-kruizeconfigjson: |
-  {
-    "datasource": [
-      {
-        "name": "prometheus-1",
-        "provider": "prometheus",
-        "serviceName": "prometheus-k8s",
-        "namespace": "openshift-monitoring",
-        "url": "",
-        "authentication": {
-          "type": "bearer",
-          "credentials": {
-            "tokenFilePath": "/var/run/secrets/kubernetes.io/serviceaccount/token"
+  kruizeconfigjson: |
+    {
+      "datasource": [
+        {
+          "name": "prometheus-1",
+          "provider": "prometheus",
+          "serviceName": "prometheus-k8s",
+          "namespace": "openshift-monitoring",
+          "url": "",
+          "authentication": {
+            "type": "bearer",
+            "credentials": {
+              "tokenFilePath": "/var/run/secrets/kubernetes.io/serviceaccount/token"
+            }
           }
         }
-      }
-    ]
-  }
+      ]
+    }
 ```
 
 ## Limits
@@ -395,4 +444,5 @@ number of labels, or none at all. Here are some examples:
 - "%datasource%|%clustername%|%namespace%|%workloadname%(%workloadtype%)|%containername%"    -> Default
 - "%label:org_id%|%label:source_id%|%label:cluster_id%|%namespace%|%workloadtype%|%workloadname%|%containername%"
 - "%label:org_id%|%namespace%|%workloadtype%|%workloadname%|%containername%"
-- "%label:org_id%|%label:cluster_id%|%namespace%|%workloadtype%|%workloadname%"
+- "%label:org_id%|%label:cluster_id%|%namespace%|%workloadtype%|%workloadname%"
+

manifests/crc/BYODB-installation/minikube/kruize-crc-minikube.yaml

@@ -36,7 +36,7 @@ data:
       "local": "true",
       "logAllHttpReqAndResp": "true",
       "recommendationsURL" : "http://kruize.monitoring.svc.cluster.local:8080/generateRecommendations?experiment_name=%s",    
-      "experimentsURL" : "http://kruize.monitoring.svc.cluster.local:8080/createExperiment",    
+      "experimentsURL" : "http://kruize.monitoring.svc.cluster.local:8080/createExperiment",
       "hibernate": {
         "dialect": "org.hibernate.dialect.PostgreSQLDialect",
         "driver": "org.postgresql.Driver",

manifests/crc/default-db-included-installation/aks/kruize-crc-aks.yaml

@@ -100,7 +100,7 @@ data:
       "local": "true",
       "logAllHttpReqAndResp": "true",
       "recommendationsURL" : "http://kruize.monitoring.svc.cluster.local:8080/generateRecommendations?experiment_name=%s",    
-      "experimentsURL" : "http://kruize.monitoring.svc.cluster.local:8080/createExperiment", 
+      "experimentsURL" : "http://kruize.monitoring.svc.cluster.local:8080/createExperiment",
       "experimentNameFormat" : "%datasource%|%clustername%|%namespace%|%workloadname%(%workloadtype%)|%containername%",
       "bulkapilimit" : 1000,
       "hibernate": {

manifests/crc/default-db-included-installation/minikube/kruize-crc-minikube.yaml

@@ -114,7 +114,7 @@ data:
       "local": "true",
       "logAllHttpReqAndResp": "true",
       "recommendationsURL" : "http://kruize.monitoring.svc.cluster.local:8080/generateRecommendations?experiment_name=%s",    
-      "experimentsURL" : "http://kruize.monitoring.svc.cluster.local:8080/createExperiment",   
+      "experimentsURL" : "http://kruize.monitoring.svc.cluster.local:8080/createExperiment",
       "experimentNameFormat" : "%datasource%|%clustername%|%namespace%|%workloadname%(%workloadtype%)|%containername%",
       "bulkapilimit" : 1000,
       "hibernate": {

manifests/crc/default-db-included-installation/openshift/kruize-crc-openshift.yaml

@@ -140,10 +140,10 @@ data:
           "namespace": "openshift-monitoring",
           "url": "",
           "authentication": {
-            "type": "bearer",
-            "credentials": {
-              "tokenFilePath": "/var/run/secrets/kubernetes.io/serviceaccount/token"
-            }
+              "type": "bearer",
+              "credentials": {
+                "tokenFilePath": "/var/run/secrets/kubernetes.io/serviceaccount/token"
+              }
           }
         }
       ]

src/main/java/com/autotune/analyzer/serviceObjects/BulkInput.java

@@ -25,6 +25,7 @@ public class BulkInput {
     private FilterWrapper filter;
     private TimeRange time_range;
     private String datasource;
+    private Webhook webhook;
 
     // Getters and Setters
 
@@ -136,4 +137,22 @@ public void setEnd(String end) {
             this.end = end;
         }
     }
+
+    public static class Webhook{
+        private String url;
+        public String getUrl() {
+            return url;
+        }
+        public void setUrl(String url) {
+            this.url = url;
+        }
+    }
+
+    public Webhook getWebhook() {
+        return webhook;
+    }
+
+    public void setWebhook(Webhook webhook) {
+        this.webhook = webhook;
+    }
 }

src/main/java/com/autotune/analyzer/serviceObjects/BulkJobStatus.java

@@ -48,6 +48,7 @@ public class BulkJobStatus {
     private String endTime;   // Change to String to store formatted time
     private Map<String, Notification> notifications;
     private Map<String, Experiment> experiments = Collections.synchronizedMap(new HashMap<>());
+    private Webhook webhook;
 
     public BulkJobStatus(String jobID, String status, Instant startTime) {
         this.jobID = jobID;
@@ -112,6 +113,14 @@ public void setExperiments(Map<String, Experiment> experiments) {
         this.experiments = experiments;
     }
 
+    public Webhook getWebhook() {
+        return webhook;
+    }
+
+    public void setWebhook(Webhook webhook) {
+        this.webhook = webhook;
+    }
+
     // Method to add a new experiment with "unprocessed" status and null notification
     public synchronized Experiment addExperiment(String experimentName) {
         Experiment experiment = new Experiment(experimentName);
@@ -188,6 +197,14 @@ public Recommendation getRecommendations() {
         public void setNotification(Notification notification) {
             this.notification = notification;
         }
+
+        public Notification getNotification() {
+            return notification;
+        }
+
+        public void setRecommendations(Recommendation recommendations) {
+            this.recommendations = recommendations;
+        }
     }
 
     public static class Recommendation {
@@ -255,5 +272,29 @@ public void setCode(int code) {
         }
     }
 
+    public static class Webhook {
+        private KruizeConstants.KRUIZE_BULK_API.NotificationConstants.WebHookStatus status;
+        private Notification notifications; // Notifications can hold multiple entries
+
+        public Webhook(KruizeConstants.KRUIZE_BULK_API.NotificationConstants.WebHookStatus status) {
+            this.status = status;
+        }
+
+        public KruizeConstants.KRUIZE_BULK_API.NotificationConstants.WebHookStatus getStatus() {
+            return status;
+        }
+
+        public void setStatus(KruizeConstants.KRUIZE_BULK_API.NotificationConstants.WebHookStatus status) {
+            this.status = status;
+        }
+
+        public Notification getNotifications() {
+            return notifications;
+        }
+
+        public void setNotifications(Notification notifications) {
+            this.notifications = notifications;
+        }
+    }
 
-}
+    }

src/main/java/com/autotune/analyzer/services/BulkService.java

@@ -72,6 +72,15 @@ protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws Se
             boolean verbose = verboseParam != null && Boolean.parseBoolean(verboseParam);
             BulkJobStatus jobDetails;
             LOGGER.info("Job ID: " + jobID);
+            if (jobStatusMap.isEmpty()) {
+                sendErrorResponse(
+                        resp,
+                        null,
+                        HttpServletResponse.SC_NOT_FOUND,
+                        JOB_NOT_FOUND_MSG
+                );
+                return;
+            }
             jobDetails = jobStatusMap.get(jobID);
             LOGGER.info("Job Status: " + jobDetails.getStatus());
             resp.setContentType(JSON_CONTENT_TYPE);