handling failure case and PR review comments

Author: agrimk

ads/aqua/modeldeployment/deployment.py

@@ -799,6 +799,7 @@ def _create_deployment(
             deployment_id,
             deployment.dsc_model_deployment.workflow_req_id,
             model_type,
+            model_name,
         )
 
         # we arbitrarily choose last 8 characters of OCID to identify MD in telemetry
@@ -1325,7 +1326,11 @@ def list_shapes(self, **kwargs) -> List[ComputeShapeSummary]:
         ]
 
     def get_deployment_status(
-        self, model_deployment_id: str, work_request_id: str, model_type: str
+        self,
+        model_deployment_id: str,
+        work_request_id: str,
+        model_type: str,
+        model_name: str,
     ) -> None:
         """Waits for the data science  model deployment to be completed and log its status in telemetry.
 
@@ -1357,20 +1362,24 @@ def get_deployment_status(
                 max_wait_time=DEFAULT_WAIT_TIME,
                 poll_interval=DEFAULT_POLL_INTERVAL,
             )
-        except Exception as e:
-            logger.error("Error while trying to create model deployment: " + str(e))
-            print("Error while trying to create model deployment: " + str(e))
-            self.telemetry.record_event_async(
+        except Exception:
+            if data_science_work_request._error_message:
+                error_str = ""
+                for error in data_science_work_request._error_message:
+                    error_str = error_str + " " + error.message
+
+            self.telemetry.record_event(
                 category=f"aqua/{model_type}/deployment/status",
                 action="FAILED",
-                detail=data_science_work_request._error_message,
-                value=ocid,
+                detail=error_str,
+                value=model_name,
                 **telemetry_kwargs,
             )
+
         else:
             self.telemetry.record_event_async(
                 category=f"aqua/{model_type}/deployment/status",
                 action="SUCCEEDED",
-                value=ocid,
+                value=model_name,
                 **telemetry_kwargs,
             )

ads/common/work_request.py

@@ -1,7 +1,5 @@
 #!/usr/bin/env python
-# -*- coding: utf-8; -*-
-
-# Copyright (c) 2024 Oracle and/or its affiliates.
+# Copyright (c) 2024, 2025 Oracle and/or its affiliates.
 # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
 
 import logging
@@ -12,6 +10,7 @@
 import oci
 from oci import Signer
 from tqdm.auto import tqdm
+
 from ads.common.oci_datascience import OCIDataScienceMixin
 
 logger = logging.getLogger(__name__)
@@ -20,10 +19,10 @@
 DEFAULT_WAIT_TIME = 1200
 DEFAULT_POLL_INTERVAL = 10
 WORK_REQUEST_PERCENTAGE = 100
-# default tqdm progress bar format: 
+# default tqdm progress bar format:
 # {l_bar}{bar}| {n_fmt}/{total_fmt} [{elapsed}<{remaining}, ' '{rate_fmt}{postfix}]
 # customize the bar format to remove the {n_fmt}/{total_fmt} from the right side
-DEFAULT_BAR_FORMAT = '{l_bar}{bar}| [{elapsed}<{remaining}, ' '{rate_fmt}{postfix}]'
+DEFAULT_BAR_FORMAT = "{l_bar}{bar}| [{elapsed}<{remaining}, " "{rate_fmt}{postfix}]"
 
 
 class DataScienceWorkRequest(OCIDataScienceMixin):
@@ -32,13 +31,13 @@ class DataScienceWorkRequest(OCIDataScienceMixin):
     """
 
     def __init__(
-        self, 
-        id: str, 
+        self,
+        id: str,
         description: str = "Processing",
-        config: dict = None, 
-        signer: Signer = None, 
+        config: dict = None,
+        signer: Signer = None,
         client_kwargs: dict = None,
-        **kwargs
+        **kwargs,
     ) -> None:
         """Initializes ADSWorkRequest object.
 
@@ -49,43 +48,43 @@ def __init__(
         description: str
             Progress bar initial step description (Defaults to `Processing`).
         config : dict, optional
-            OCI API key config dictionary to initialize 
+            OCI API key config dictionary to initialize
             oci.data_science.DataScienceClient (Defaults to None).
         signer : oci.signer.Signer, optional
-            OCI authentication signer to initialize 
+            OCI authentication signer to initialize
             oci.data_science.DataScienceClient (Defaults to None).
         client_kwargs : dict, optional
-            Additional client keyword arguments to initialize 
+            Additional client keyword arguments to initialize
             oci.data_science.DataScienceClient (Defaults to None).
         kwargs:
-            Additional keyword arguments to initialize 
+            Additional keyword arguments to initialize
             oci.data_science.DataScienceClient.
         """
         self.id = id
         self._description = description
         self._percentage = 0
         self._status = None
-        _error_message = None
+        self._error_message = ""
         super().__init__(config, signer, client_kwargs, **kwargs)
-        
 
     def _sync(self):
         """Fetches the latest work request information to ADSWorkRequest object."""
         work_request = self.client.get_work_request(self.id).data
-        work_request_logs = self.client.list_work_request_logs(
-            self.id
-        ).data
+        work_request_logs = self.client.list_work_request_logs(self.id).data
 
-        self._percentage= work_request.percent_complete
+        self._percentage = work_request.percent_complete
         self._status = work_request.status
-        self._description = work_request_logs[-1].message if work_request_logs else "Processing"
-        if work_request.status == 'FAILED' : self._error_message = self.client.list_work_request_errors
+        self._description = (
+            work_request_logs[-1].message if work_request_logs else "Processing"
+        )
+        if work_request.status == "FAILED":
+            self._error_message = self.client.list_work_request_errors(self.id).data
 
     def watch(
-        self, 
+        self,
         progress_callback: Callable,
-        max_wait_time: int=DEFAULT_WAIT_TIME,
-        poll_interval: int=DEFAULT_POLL_INTERVAL,
+        max_wait_time: int = DEFAULT_WAIT_TIME,
+        poll_interval: int = DEFAULT_POLL_INTERVAL,
     ):
         """Updates the progress bar with realtime message and percentage until the process is completed.
 
@@ -94,10 +93,10 @@ def watch(
         progress_callback: Callable
             Progress bar callback function.
             It must accept `(percent_change, description)` where `percent_change` is the
-            work request percent complete and `description` is the latest work request log message. 
+            work request percent complete and `description` is the latest work request log message.
         max_wait_time: int
             Maximum amount of time to wait in seconds (Defaults to 1200).
-            Negative implies infinite wait time. 
+            Negative implies infinite wait time.
         poll_interval: int
             Poll interval in seconds (Defaults to 10).
 
@@ -109,7 +108,6 @@ def watch(
 
         start_time = time.time()
         while self._percentage < 100:
-
             seconds_since = time.time() - start_time
             if max_wait_time > 0 and seconds_since >= max_wait_time:
                 logger.error(f"Exceeded max wait time of {max_wait_time} seconds.")
@@ -126,12 +124,14 @@ def watch(
             percent_change = self._percentage - previous_percent_complete
             previous_percent_complete = self._percentage
             progress_callback(
-                percent_change=percent_change,
-                description=self._description
+                percent_change=percent_change, description=self._description
             )
 
             if self._status in WORK_REQUEST_STOP_STATE:
-                if self._status != oci.work_requests.models.WorkRequest.STATUS_SUCCEEDED:
+                if (
+                    self._status
+                    != oci.work_requests.models.WorkRequest.STATUS_SUCCEEDED
+                ):
                     if self._description:
                         raise Exception(self._description)
                     else:
@@ -147,12 +147,12 @@ def watch(
 
     def wait_work_request(
         self,
-        progress_bar_description: str="Processing",
-        max_wait_time: int=DEFAULT_WAIT_TIME,
-        poll_interval: int=DEFAULT_POLL_INTERVAL
+        progress_bar_description: str = "Processing",
+        max_wait_time: int = DEFAULT_WAIT_TIME,
+        poll_interval: int = DEFAULT_POLL_INTERVAL,
     ):
         """Waits for the work request progress bar to be completed.
-        
+
         Parameters
         ----------
         progress_bar_description: str
@@ -162,7 +162,7 @@ def wait_work_request(
             Negative implies infinite wait time.
         poll_interval: int
             Poll interval in seconds (Defaults to 10).
-        
+
         Returns
         -------
         None
@@ -174,7 +174,7 @@ def wait_work_request(
             mininterval=0,
             file=sys.stdout,
             desc=progress_bar_description,
-            bar_format=DEFAULT_BAR_FORMAT
+            bar_format=DEFAULT_BAR_FORMAT,
         ) as pbar:
 
             def progress_callback(percent_change, description):
@@ -186,6 +186,5 @@ def progress_callback(percent_change, description):
             self.watch(
                 progress_callback=progress_callback,
                 max_wait_time=max_wait_time,
-                poll_interval=poll_interval
+                poll_interval=poll_interval,
             )
- 

ads/telemetry/client.py

@@ -81,8 +81,7 @@ def record_event(
             # Here `endpoint`` is for debugging purpose
             # For some federated/domain users, the `endpoint` may not be a valid URL
             endpoint = f"{self.service_endpoint}/n/{self.namespace}/b/{self.bucket}/o/telemetry/{category}/{action}"
-            logger.info(f"Sending telemetry to endpoint: {endpoint}")
-            print(f"Sending telemetry to endpoint: {endpoint}")
+            logger.debug(f"Sending telemetry to endpoint: {endpoint}")
 
             self.os_client.base_client.user_agent = self._encode_user_agent(**kwargs)
             try: