feat: Improve PersistentResource exception logging to include cluster name

PiperOrigin-RevId: 785528276

Author: vertex-sdk-bot

google/cloud/aiplatform/vertex_ray/util/_gapic_utils.py

@@ -107,21 +107,33 @@ def get_persistent_resource(
             response = None
             if num_attempts >= tolerance:
                 raise ValueError(
-                    "[Ray on Vertex AI]: Invalid cluster_resource_name (404 not found)."
+                    "[Ray on Vertex AI]: Invalid cluster_resource_name %s (404 not"
+                    " found)." % persistent_resource_name
                 )
         if response:
             if response.error.message:
-                logging.error("[Ray on Vertex AI]: %s" % response.error.message)
-                raise RuntimeError("[Ray on Vertex AI]: Cluster returned an error.")
+                logging.error(
+                    "[Ray on Vertex AI]: %s - %s",
+                    persistent_resource_name,
+                    response.error.message,
+                )
+                raise RuntimeError(
+                    "[Ray on Vertex AI]: Cluster %s returned an error."
+                    % persistent_resource_name
+                )
 
             print("[Ray on Vertex AI]: Cluster State =", response.state)
             if response.state == PersistentResource.State.RUNNING:
                 return response
             elif response.state == PersistentResource.State.STOPPING:
-                raise RuntimeError("[Ray on Vertex AI]: The cluster is stopping.")
+                raise RuntimeError(
+                    "[Ray on Vertex AI]: Cluster %s is stopping."
+                    % persistent_resource_name
+                )
             elif response.state == PersistentResource.State.ERROR:
                 raise RuntimeError(
-                    "[Ray on Vertex AI]: The cluster encountered an error."
+                    "[Ray on Vertex AI]: Cluster %s encountered an error."
+                    % persistent_resource_name
                 )
         # Polling decay
         sleep_time = polling_delay(num_attempts=num_attempts, time_scale=150.0)

tests/unit/vertex_ray/test_ray_utils.py

@@ -34,7 +34,7 @@ def test_get_persistent_resource_stopping(self, persistent_client_stopping_mock)
             )
 
         persistent_client_stopping_mock.assert_called_once()
-        e.match(regexp=r"The cluster is stopping.")
+        e.match(regexp=r"Cluster .* is stopping.")
 
     def test_get_persistent_resource_error(self, persistent_client_error_mock):
         with pytest.raises(RuntimeError) as e:
@@ -43,4 +43,4 @@ def test_get_persistent_resource_error(self, persistent_client_error_mock):
             )
 
         persistent_client_error_mock.assert_called_once()
-        e.match(regexp=r"The cluster encountered an error.")
+        e.match(regexp=r"Cluster .* encountered an error.")