Exposed the ability to setup custom log formating for a logger. To support non traditional log messages for cmd_bio using the same log engine

Author: StevenAWhite

projects/biogears/libBiogears/include/biogears/cdm/utils/Logger.h

@@ -83,6 +83,7 @@ class BIOGEARS_API Logger {
   virtual ~Logger();
 
   void LogToConsole(bool log_to_console);
+  void FormatMessages(bool format_messages);
 
   void ResetLogFile(const std::string& logFilename = Loggable::empty, const std::string& working_dir = Loggable::empty);
   void ResetLogFile(const char* logFilename , const char* working_dir = Loggable::empty_cStr);
@@ -93,6 +94,9 @@ class BIOGEARS_API Logger {
 
   virtual void SetLogTime(const SEScalarTime* time);
 
+  void SetsetConversionPattern(const std::string&);
+  void SetConsolesetConversionPattern(const std::string&);
+
   virtual void SetForward(LoggerForward* forward);
   virtual bool HasForward();
 
@@ -126,5 +130,6 @@ class BIOGEARS_API Logger {
   log4cpp::Appender* m_ConsoleAppender;
   const SEScalarTime* m_time;
   std::stringstream m_ss;
+  bool m_FormatMessages;
 };
 }

projects/biogears/libBiogears/src/cdm/utils/Logger.cpp

@@ -29,13 +29,15 @@ const char* Loggable::empty_cStr("");
 Logger::Logger(const std::string& logFilename, const std::string& working_dir)
   : m_Forward(nullptr)
   , m_time(nullptr)
+  , m_FormatMessages(true)
 {
   ResetLogFile(logFilename, working_dir);
 }
 
 Logger::Logger(const char* logFilename, const char* working_dir)
   : m_Forward(nullptr)
   , m_time(nullptr)
+  , m_FormatMessages(true)
 {
   ResetLogFile(logFilename, working_dir);
 }
@@ -49,9 +51,16 @@ void Logger::LogToConsole(bool log_to_console)
   }
 }
 
+void Logger::FormatMessages(bool format_messages)
+{
+  m_FormatMessages = format_messages;
+}
 void Logger::ResetLogFile(const std::string& logFilename, const std::string& working_dir)
 {
-  std::string key = logFilename; if( logFilename.empty()) { key = "biogears_logger"; }
+  std::string key = logFilename;
+  if (logFilename.empty()) {
+    key = "biogears_logger";
+  }
   log4cpp::Category& category = log4cpp::Category::getInstance(key);
   m_Log = &category;
   m_Log->removeAllAppenders();
@@ -115,7 +124,18 @@ void Logger::SetConsoleLogLevel(log4cpp::Priority::Value priority)
     m_ConsoleAppender->setThreshold(priority);
   }
 }
-
+void Logger::SetsetConversionPattern(const std::string& layout)
+{
+  log4cpp::PatternLayout* cLayout = new log4cpp::PatternLayout();
+  cLayout->setConversionPattern(layout);
+  m_FileAppender->setLayout(cLayout);
+}
+void Logger::SetConsolesetConversionPattern(const std::string& layout)
+{
+  log4cpp::PatternLayout* cLayout = new log4cpp::PatternLayout();
+  cLayout->setConversionPattern(layout);
+  m_ConsoleAppender->setLayout(cLayout);
+}
 // This function will return the priority of the logger
 log4cpp::Priority::Value Logger::GetLogLevel()
 {
@@ -129,15 +149,19 @@ bool Logger::HasForward() { return m_Forward == nullptr ? false : true; }
 std::string Logger::FormatLogMessage(const std::string& msg,
                                      const std::string& origin)
 {
-  m_ss.str("");
-  m_ss.clear();
-  if (m_time != nullptr && m_time->IsValid())
-    m_ss << "[" << *m_time << "] " << msg;
-  else
-    m_ss << msg;
-  if (msg.empty())
-    return origin;
-  return origin + " : " + m_ss.str();
+  if (m_FormatMessages) {
+    m_ss.str("");
+    m_ss.clear();
+    if (m_time != nullptr && m_time->IsValid())
+      m_ss << "[" << *m_time << "] " << msg;
+    else
+      m_ss << msg;
+    if (msg.empty())
+      return origin;
+    return origin + " : " + m_ss.str();
+  } else {
+    return msg;
+  }
 }
 
 void Logger::Debug(const std::string& msg, const std::string& origin)

projects/cmd_bio/src/exec/Driver.cpp

@@ -146,6 +146,9 @@ void Driver::queue_Scenario(Executor exec)
       }
     }
 
+    if (multi_patient_run) {
+      ex.Name(ex.Name() + "-" + patient_no_extension);
+    }
     std::string base_file_name = (multi_patient_run) ? scenario_no_extension + "-" + patient_no_extension : scenario_no_extension;
     std::string console_file = base_file_name + ".log";
     std::string log_file = base_file_name + "Results.log";
@@ -156,6 +159,10 @@ void Driver::queue_Scenario(Executor exec)
     Logger file_logger(ex.Computed() + parent_dir + console_file);
     try {
       file_logger.SetConsoleLogLevel(log4cpp::Priority::WARN);
+      file_logger.SetConsolesetConversionPattern("%d{%H:%M} [%p] " + ex.Name() + " %m%n");
+      console_logger.SetConsolesetConversionPattern("%d{%H:%M} [%p] %m%n");
+      console_logger.FormatMessages(false);
+
       eng = CreateBioGearsEngine(&file_logger);
     } catch (std::exception e) {
       std::cout << e.what();
@@ -168,14 +175,13 @@ void Driver::queue_Scenario(Executor exec)
 
     //NOTE:Assuming a Patient File
     sce.GetInitialParameters().SetPatientFile(ex.Patient());
-    console_logger.Info("Starting Scenario: " + trimed_scenario_path);
-    try
-    {
-      BioGearsScenarioExec bse{*eng};
+    console_logger.Info("Starting "+ ex.Name());
+    try {
+      BioGearsScenarioExec bse{ *eng };
       bse.Execute(sce, ex.Computed() + parent_dir + results_file, nullptr);
-      console_logger.Info("Completed Scenario: " + trimed_scenario_path);
-    } catch (...){
-      console_logger.Info("Scenario: " + trimed_scenario_path + " Failed.");
+      console_logger.Info("Completed "+ ex.Name());
+    } catch (...) {
+      console_logger.Error("Failed "+ ex.Name());
     }
   };
 
@@ -188,19 +194,16 @@ void Driver::queue_Scenario(Executor exec)
     }
   }
   std::unique_ptr<mil::tatrc::physiology::datamodel::ScenarioData> scenario;
-  try
-  {
+  try {
     xml_schema::flags xml_flags;
     xml_schema::properties xml_properties;
 
-    xml_properties.schema_location("uri:/mil/tatrc/physiology/datamodel","xsd/BioGearsDataModel.xsd");
-    scenario = mil::tatrc::physiology::datamodel::Scenario(ifs,xml_flags, xml_properties);
-  } catch ( std::runtime_error e)
-  {
+    xml_properties.schema_location("uri:/mil/tatrc/physiology/datamodel", "xsd/BioGearsDataModel.xsd");
+    scenario = mil::tatrc::physiology::datamodel::Scenario(ifs, xml_flags, xml_properties);
+  } catch (std::runtime_error e) {
     std::cout << e.what();
     return;
-  } catch (xsd::cxx::tree::parsing<char> e )
-  {
+  } catch (xsd::cxx::tree::parsing<char> e) {
     std::cout << e;
     return;
   }