chore: add log_dir for browser and terminal tool (#3102)

Author: Wendong-Fan

camel/toolkits/hybrid_browser_toolkit/config_loader.py

@@ -54,6 +54,7 @@ class ToolkitConfig:
 
     cache_dir: str = "tmp/"
     browser_log_to_file: bool = False
+    log_dir: Optional[str] = None
     session_id: Optional[str] = None
     enabled_tools: Optional[list] = None
 
@@ -147,6 +148,7 @@ def to_ws_config(self) -> Dict[str, Any]:
             "screenshotTimeout": self.browser_config.screenshot_timeout,
             "pageStabilityTimeout": self.browser_config.page_stability_timeout,
             "browser_log_to_file": self.toolkit_config.browser_log_to_file,
+            "log_dir": self.toolkit_config.log_dir,
             "session_id": self.toolkit_config.session_id,
             "viewport_limit": self.browser_config.viewport_limit,
             "connectOverCdp": self.browser_config.connect_over_cdp,

camel/toolkits/hybrid_browser_toolkit/hybrid_browser_toolkit.py

@@ -38,6 +38,7 @@ def __new__(
         cache_dir: str = "tmp/",
         enabled_tools: Optional[List[str]] = None,
         browser_log_to_file: bool = False,
+        log_dir: Optional[str] = None,
         session_id: Optional[str] = None,
         default_start_url: str = "https://google.com/",
         default_timeout: Optional[int] = None,
@@ -73,6 +74,8 @@ def __new__(
                 Defaults to None.
             browser_log_to_file (bool): Whether to log browser actions to
                 file. Defaults to False.
+            log_dir (Optional[str]): Custom directory path for log files.
+                If None, defaults to "browser_log". Defaults to None.
             session_id (Optional[str]): Session identifier. Defaults to None.
             default_start_url (str): Default URL to start with. Defaults
                 to "https://google.com/".
@@ -123,6 +126,7 @@ def __new__(
                 cache_dir=cache_dir,
                 enabled_tools=enabled_tools,
                 browser_log_to_file=browser_log_to_file,
+                log_dir=log_dir,
                 session_id=session_id,
                 default_start_url=default_start_url,
                 default_timeout=default_timeout,
@@ -167,6 +171,7 @@ def __new__(
                 cache_dir=cache_dir,
                 enabled_tools=enabled_tools,
                 browser_log_to_file=browser_log_to_file,
+                log_dir=log_dir,
                 session_id=session_id,
                 default_start_url=default_start_url,
                 default_timeout=default_timeout,

camel/toolkits/hybrid_browser_toolkit/hybrid_browser_toolkit_ts.py

@@ -86,6 +86,7 @@ def __init__(
         cache_dir: str = "tmp/",
         enabled_tools: Optional[List[str]] = None,
         browser_log_to_file: bool = False,
+        log_dir: Optional[str] = None,
         session_id: Optional[str] = None,
         default_start_url: str = "https://google.com/",
         default_timeout: Optional[int] = None,
@@ -116,6 +117,8 @@ def __init__(
             Defaults to None.
             browser_log_to_file (bool): Whether to log browser actions to
             file. Defaults to False.
+            log_dir (Optional[str]): Custom directory path for log files.
+            If None, defaults to "browser_log". Defaults to None.
             session_id (Optional[str]): Session identifier. Defaults to None.
             default_start_url (str): Default URL to start with. Defaults
             to "https://google.com/".
@@ -167,6 +170,7 @@ def __init__(
             viewport_limit=viewport_limit,
             cache_dir=cache_dir,
             browser_log_to_file=browser_log_to_file,
+            log_dir=log_dir,
             session_id=session_id,
             enabled_tools=enabled_tools,
             connect_over_cdp=connect_over_cdp,

camel/toolkits/hybrid_browser_toolkit/ws_wrapper.py

@@ -122,6 +122,7 @@ def __init__(self, config: Optional[Dict[str, Any]] = None):
         self.browser_log_to_file = (config or {}).get(
             'browser_log_to_file', False
         )
+        self.log_dir = (config or {}).get('log_dir', 'browser_log')
         self.session_id = (config or {}).get('session_id', 'default')
         self.log_file_path: Optional[str] = None
         self.log_buffer: List[Dict[str, Any]] = []
@@ -131,7 +132,7 @@ def __init__(self, config: Optional[Dict[str, Any]] = None):
 
         # Set up log files if needed
         if self.browser_log_to_file:
-            log_dir = "browser_log"
+            log_dir = self.log_dir if self.log_dir else "browser_log"
             os.makedirs(log_dir, exist_ok=True)
             timestamp = datetime.datetime.now().strftime("%Y%m%d_%H%M%S")
             self.log_file_path = os.path.join(

camel/toolkits/hybrid_browser_toolkit_py/hybrid_browser_toolkit.py

@@ -95,6 +95,7 @@ def __init__(
         cache_dir: str = "tmp/",
         enabled_tools: Optional[List[str]] = None,
         browser_log_to_file: bool = False,
+        log_dir: Optional[str] = None,
         session_id: Optional[str] = None,
         default_start_url: str = "https://google.com/",
         default_timeout: Optional[int] = None,
@@ -144,6 +145,8 @@ def __init__(
                 and page loading times.
                 Logs are saved to an auto-generated timestamped file.
                 Defaults to `False`.
+            log_dir (Optional[str]): Custom directory path for log files.
+                If None, defaults to "browser_log". Defaults to `None`.
             session_id (Optional[str]): A unique identifier for this browser
                 session. When multiple HybridBrowserToolkit instances are
                 used
@@ -201,6 +204,7 @@ def __init__(
         self._web_agent_model = web_agent_model
         self._cache_dir = cache_dir
         self._browser_log_to_file = browser_log_to_file
+        self._log_dir = log_dir
         self._default_start_url = default_start_url
         self._session_id = session_id or "default"
         self._viewport_limit = viewport_limit
@@ -237,7 +241,7 @@ def __init__(
         # Set up log file if needed
         if self.log_to_file:
             # Create log directory if it doesn't exist
-            log_dir = "browser_log"
+            log_dir = self._log_dir if self._log_dir else "browser_log"
             os.makedirs(log_dir, exist_ok=True)
 
             timestamp = datetime.datetime.now().strftime("%Y%m%d_%H%M%S")

camel/toolkits/terminal_toolkit.py

@@ -66,6 +66,9 @@ class TerminalToolkit(BaseToolkit):
             connecting them to the terminal's standard input. This is useful
             for commands that require user input, like `ssh`. Interactive mode
             is only supported on macOS and Linux. (default: :obj:`False`)
+        log_dir (Optional[str]): Custom directory path for log files.
+            If None, logs are saved to the current working directory.
+            (default: :obj:`None`)
 
     Note:
         Most functions are compatible with Unix-based systems (macOS, Linux).
@@ -83,6 +86,7 @@ def __init__(
         clone_current_env: bool = False,
         safe_mode: bool = True,
         interactive: bool = False,
+        log_dir: Optional[str] = None,
     ):
         # Store timeout before calling super().__init__
         self._timeout = timeout
@@ -99,6 +103,7 @@ def __init__(
         self.use_shell_mode = use_shell_mode
         self._human_takeover_active = False
         self.interactive = interactive
+        self.log_dir = log_dir
 
         self.python_executable = sys.executable
         self.is_macos = platform.system() == 'Darwin'
@@ -153,8 +158,13 @@ def _setup_file_output(self):
         r"""Set up file output to replace GUI, using a fixed file to simulate
         terminal.
         """
-
-        self.log_file = os.path.join(os.getcwd(), "camel_terminal.txt")
+        # Use custom log directory if provided, otherwise use current directory
+        if self.log_dir:
+            # Create the log directory if it doesn't exist
+            os.makedirs(self.log_dir, exist_ok=True)
+            self.log_file = os.path.join(self.log_dir, "camel_terminal.txt")
+        else:
+            self.log_file = os.path.join(os.getcwd(), "camel_terminal.txt")
 
         # Inform the user
         logger.info(f"Terminal output will be redirected to: {self.log_file}")