add missing request id

Author: VipulMascarenhas

ads/aqua/extension/aqua_ws_msg_handler.py

@@ -1,10 +1,10 @@
 #!/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 traceback
+import uuid
 from abc import abstractmethod
 from http.client import responses
 from typing import List
@@ -34,7 +34,7 @@ def __init__(self, message: str):
             self.telemetry = TelemetryClient(
                 bucket=AQUA_TELEMETRY_BUCKET, namespace=AQUA_TELEMETRY_BUCKET_NS
             )
-        except:
+        except Exception:
             pass
 
     @staticmethod
@@ -66,24 +66,31 @@ def write_error(self, status_code, **kwargs):
             "message": message,
             "service_payload": service_payload,
             "reason": reason,
+            "request_id": str(uuid.uuid4()),
         }
         exc_info = kwargs.get("exc_info")
         if exc_info:
-            logger.error("".join(traceback.format_exception(*exc_info)))
+            logger.error(
+                f"Error Request ID: {reply['request_id']}\n"
+                f"Error: {''.join(traceback.format_exception(*exc_info))}"
+            )
             e = exc_info[1]
             if isinstance(e, HTTPError):
                 reply["message"] = e.log_message or message
                 reply["reason"] = e.reason
-            else:
-                logger.warning(reply["message"])
+
+        logger.error(
+            f"Error Request ID: {reply['request_id']}\n"
+            f"Error: {reply['message']} {reply['reason']}"
+        )
         # telemetry may not be present if there is an error while initializing
         if hasattr(self, "telemetry"):
             aqua_api_details = kwargs.get("aqua_api_details", {})
             self.telemetry.record_event_async(
                 category="aqua/error",
                 action=str(status_code),
                 value=reason,
-                **aqua_api_details
+                **aqua_api_details,
             )
         response = AquaWsError(
             status=status_code,

ads/cli.py

@@ -1,12 +1,12 @@
 #!/usr/bin/env python
-# -*- coding: utf-8 -*--
 
-# Copyright (c) 2021, 2024 Oracle and/or its affiliates.
+# Copyright (c) 2021, 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
 import sys
 import traceback
-from dataclasses import is_dataclass
+import uuid
 
 import fire
 
@@ -27,7 +27,7 @@
     )
     logger.debug(ex)
     logger.debug(traceback.format_exc())
-    exit()
+    sys.exit()
 
 # https://packaging.python.org/en/latest/guides/single-sourcing-package-version/#single-sourcing-the-package-version
 if sys.version_info >= (3, 8):
@@ -122,8 +122,9 @@ def exit_program(ex: Exception, logger: "logging.Logger") -> None:
     ...     exit_program(e, logger)
     """
 
-    logger.debug(traceback.format_exc())
-    logger.error(str(ex))
+    request_id = str(uuid.uuid4())
+    logger.debug(f"Error Request ID: {request_id}\nError: {traceback.format_exc()}")
+    logger.error(f"Error Request ID: {request_id}\n" f"Error: {str(ex)}")
 
     exit_code = getattr(ex, "exit_code", 1)
     logger.error(f"Exit code: {exit_code}")

tests/unitary/with_extras/aqua/test_cli.py

@@ -1,12 +1,13 @@
 #!/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
 import os
 import subprocess
+import uuid
 from importlib import reload
 from unittest import TestCase
 from unittest.mock import call, patch
@@ -148,6 +149,7 @@ def test_aqua_cli(self, mock_logger, mock_aqua_command, mock_fire, mock_serializ
         ]
     )
     @patch("sys.argv", ["ads", "aqua", "--error-option"])
+    @patch("uuid.uuid4")
     @patch("fire.Fire")
     @patch("ads.aqua.cli.AquaCommand")
     @patch("ads.aqua.logger.error")
@@ -162,11 +164,17 @@ def test_aqua_cli_with_error(
         mock_logger_error,
         mock_aqua_command,
         mock_fire,
+        mock_uuid,
     ):
         """Tests when Aqua Cli gracefully exit when error raised."""
         mock_fire.side_effect = mock_side_effect
         from ads.cli import cli
 
+        uuid_value = "12345678-1234-5678-1234-567812345678"
+        mock_uuid.return_value = uuid.UUID(uuid_value)
+        expected_logging_message = type(expected_logging_message)(
+            f"Error Request ID: {uuid_value}\nError: {str(expected_logging_message)}"
+        )
         cli()
         calls = [
             call(expected_logging_message),