improved logger class

Author: tomasmark79

application/src/Application.cpp

@@ -43,8 +43,7 @@ int main (int argc, char** argv) {
     auto logger = UtilsFactory::createLogger (LoggerType::Console, loggerConfig);
 
     // Initialize assets
-    auto assetManager =
-      UtilsFactory::createAssetManager (execPathResult.value (), appName);
+    auto assetManager = UtilsFactory::createAssetManager (execPathResult.value (), appName);
 
     if (!assetManager->validate ()) {
       logger->errorStream () << "Failed to validate assets: " << assetManager->getAssetsPath ();

src/Utils/Logger/ConsoleLogger.hpp

@@ -24,6 +24,7 @@ class ConsoleLogger : public dotnamecpp::logging::ILogger {
   std::mutex logMutex_;
   std::ofstream logFile_;
   bool addNewLine_ = true;
+  std::string appPrefix_;
 
 /**
   * @brief Current logging level for the console logger defined at compile time.
@@ -47,7 +48,9 @@ class ConsoleLogger : public dotnamecpp::logging::ILogger {
   ConsoleLogger (const ConsoleLogger&) = delete;
   ConsoleLogger& operator= (const ConsoleLogger&) = delete;
   ConsoleLogger (ConsoleLogger&& other) noexcept : logFile_ (std::move (other.logFile_)),
-                                                   addNewLine_ (other.addNewLine_) {
+                                                   addNewLine_ (other.addNewLine_),
+                                                   appPrefix_ (std::move (other.appPrefix_)),
+                                                   currentLevel_ (other.currentLevel_) {
   }
 
   ConsoleLogger& operator= (ConsoleLogger&& other) noexcept {
@@ -59,6 +62,7 @@ class ConsoleLogger : public dotnamecpp::logging::ILogger {
 
       logFile_ = std::move (other.logFile_);
       addNewLine_ = other.addNewLine_;
+      appPrefix_ = std::move (other.appPrefix_);
       currentLevel_ = other.currentLevel_;
     }
     return *this;
@@ -109,6 +113,9 @@ class ConsoleLogger : public dotnamecpp::logging::ILogger {
 
     // Create log header
     std::ostringstream header;
+    if (!appPrefix_.empty ()) {
+      header << "[" << appPrefix_ << "]";
+    }
     header << "[" << std::put_time (&now_tm, "%Y-%m-%d %H:%M:%S") << "]";
     header << "[" << levelToString (level) << "]";
     if (!caller.empty ()) {
@@ -144,6 +151,16 @@ class ConsoleLogger : public dotnamecpp::logging::ILogger {
     return currentLevel_;
   };
 
+  void setAppPrefix (const std::string& prefix) override {
+    std::lock_guard<std::mutex> lock (logMutex_);
+    appPrefix_ = prefix;
+  };
+
+  [[nodiscard]]
+  std::string getAppPrefix () const override {
+    return appPrefix_;
+  };
+
   bool enableFileLogging (const std::string& filename) override {
     std::lock_guard<std::mutex> lock (logMutex_);
     try {
@@ -391,7 +408,6 @@ class ConsoleLogger : public dotnamecpp::logging::ILogger {
     showHeaderCaller (incCaller);
     showHeaderLevel (incLevel);
   }
-
 }; // class ConsoleLogger
 
 #endif

src/Utils/Logger/ILogger.hpp

@@ -124,6 +124,20 @@ namespace dotnamecpp::logging {
     [[nodiscard]]
     virtual Level getLevel () const = 0;
 
+    /**
+     * @brief Set the application prefix for log messages
+     * 
+     * @param prefix 
+     */
+    virtual void setAppPrefix (const std::string& prefix) = 0;
+
+    /**
+     * @brief Get the App Prefix object 
+     * 
+     * @return std::string 
+     */
+    virtual std::string getAppPrefix () const = 0;
+
     /**
      * @brief Enable logging to a file
      * 

src/Utils/Logger/LoggerFactory.cpp

@@ -20,6 +20,10 @@ namespace dotnamecpp::logging {
     auto logger = std::make_shared<ConsoleLogger> ();
     logger->setLevel (config.level);
 
+    if (!config.appPrefix.empty ()) {
+      logger->setAppPrefix (config.appPrefix);
+    }
+
     if (config.enableFileLogging && !config.logFilePath.empty ()) {
       logger->enableFileLogging (config.logFilePath);
     }

src/Utils/Logger/LoggerFactory.hpp

@@ -15,6 +15,7 @@ namespace dotnamecpp::logging {
     bool enableFileLogging = false;
     std::string logFilePath;
     bool colorOutput = true;
+    std::string appPrefix;
   };
 
   class LoggerFactory {

src/Utils/Logger/NullLogger.hpp

@@ -25,10 +25,17 @@ namespace dotnamecpp::logging {
     Level getLevel () const override {
       return Level::LOG_INFO;
     }
+    void setAppPrefix (const std::string& /*prefix*/) override {
+    }
+
+    std::string getAppPrefix () const override {
+      return "";
+    }
 
     bool enableFileLogging (const std::string& /*filename*/) override {
       return true;
     }
+
     void disableFileLogging () override {
     }
   };

src/Utils/UtilsFactory.cpp

@@ -78,7 +78,8 @@ namespace dotnamecpp::utils {
     LoggerConfig config{ .level = dotnamecpp::logging::Level::LOG_INFO,
                          .enableFileLogging = false,
                          .logFilePath = "",
-                         .colorOutput = true };
+                         .colorOutput = true,
+                         .appPrefix = "" };
     return createLogger (LoggerType::Console, config);
   }