Feature: Log files (#423)

* log_file

feature: added a new parameter for crew that creates a txt file to log agent execution

* unit tests and documentation

unit test if file is created but not what is inside the file

src/crewai/crew.py

@@ -25,7 +25,7 @@ from crewai.process import Process
 from crewai.task import Task
 from crewai.telemetry import Telemetry
 from crewai.tools.agent_tools import AgentTools
-from crewai.utilities import I18N, Logger, RPMController
+from crewai.utilities import I18N, Logger, RPMController, FileHandler
 
 
 class Crew(BaseModel):
@@ -55,6 +55,7 @@ class Crew(BaseModel):
     _execution_span: Any = PrivateAttr()
     _rpm_controller: RPMController = PrivateAttr()
     _logger: Logger = PrivateAttr()
+    _file_handler: FileHandler = PrivateAttr()
     _cache_handler: InstanceOf[CacheHandler] = PrivateAttr(default=CacheHandler())
     _short_term_memory: Optional[InstanceOf[ShortTermMemory]] = PrivateAttr()
     _long_term_memory: Optional[InstanceOf[LongTermMemory]] = PrivateAttr()
@@ -115,6 +116,10 @@ class Crew(BaseModel):
         default=None,
         description="Path to the language file to be used for the crew.",
     )
+    output_log_file: Optional[Union[bool, str]] = Field(
+        default=False,
+        description="output_log_file",
+    )
 
     @field_validator("id", mode="before")
     @classmethod
@@ -145,6 +150,8 @@ class Crew(BaseModel):
         """Set private attributes."""
         self._cache_handler = CacheHandler()
         self._logger = Logger(self.verbose)
+        if self.output_log_file:
+            self._file_handler = FileHandler(self.output_log_file)
         self._rpm_controller = RPMController(max_rpm=self.max_rpm, logger=self._logger)
         self._telemetry = Telemetry()
         self._telemetry.set_tracer()
@@ -278,6 +285,11 @@ class Crew(BaseModel):
                 "info", f"== Starting Task: {task.description}", color="bold_purple"
             )
 
+            if self.output_log_file:
+                self._file_handler.log(
+                    agent=role, task=task.description, status="started"
+                )
+
             output = task.execute(context=task_output)
             if not task.async_execution:
                 task_output = output
@@ -285,6 +297,9 @@ class Crew(BaseModel):
             role = task.agent.role if task.agent is not None else "None"
             self._logger.log("debug", f"== [{role}] Task output: {task_output}\n\n")
 
+            if self.output_log_file:
+                self._file_handler.log(agent=role, task=task_output, status="completed")
+
         self._finish_execution(task_output)
         return self._format_output(task_output)
 
@@ -306,12 +321,22 @@ class Crew(BaseModel):
             self._logger.log("debug", f"Working Agent: {manager.role}")
             self._logger.log("info", f"Starting Task: {task.description}")
 
+            if self.output_log_file:
+                self._file_handler.log(
+                    agent=manager.role, task=task.description, status="started"
+                )
+
             task_output = task.execute(
                 agent=manager, context=task_output, tools=manager.tools
             )
 
             self._logger.log("debug", f"[{manager.role}] Task output: {task_output}")
 
+            if self.output_log_file:
+                self._file_handler.log(
+                    agent=manager.role, task=task_output, status="completed"
+                )
+
         self._finish_execution(task_output)
         return self._format_output(task_output), manager._token_process.get_summary()
 

src/crewai/utilities/__init__.py

@@ -5,3 +5,4 @@ from .logger import Logger
 from .printer import Printer
 from .prompts import Prompts
 from .rpm_controller import RPMController
+from .fileHandler import FileHandler

src/crewai/utilities/fileHandler.py

@@ -0,0 +1,20 @@
+import os
+from datetime import datetime
+
+
+class FileHandler:
+    """take care of file operations, currently it only logs messages to a file"""
+
+    def __init__(self, file_path):
+        if isinstance(file_path, bool):
+            self._path = os.path.join(os.curdir, "logs.txt")
+        elif isinstance(file_path, str):
+            self._path = file_path
+        else:
+            raise ValueError("file_path must be either a boolean or a string.")
+
+    def log(self, **kwargs):
+        now = datetime.now().strftime("%Y-%m-%d %H:%M:%S")
+        message = f"{now}: ".join([f"{key}={value}" for key, value in kwargs.items()])
+        with open(self._path, "a") as file:
+            file.write(message + "\n")