Brayns 258 create a proper logging system for brayns

.gitmodules

@@ -29,3 +29,6 @@
 [submodule "deps/MorphIO"]
 	path = deps/MorphIO
 	url = https://github.com/BlueBrain/MorphIO
+[submodule "deps/spdlog"]
+	path = deps/spdlog
+	url = https://github.com/gabime/spdlog.git

apps/BraynsBenchmark/main.cpp

@@ -19,8 +19,8 @@
  */
 
 #include <brayns/Brayns.h>
+#include <brayns/common/Log.h>
 #include <brayns/common/Timer.h>
-#include <brayns/common/log.h>
 #include <brayns/common/types.h>
 #include <brayns/engine/Camera.h>
 #include <brayns/engine/Engine.h>
@@ -38,8 +38,8 @@ int main(int argc, const char** argv)
         brayns::Brayns brayns(argc, argv);
         timer.stop();
 
-        BRAYNS_INFO << "[PERF] Scene initialization took "
-                    << timer.milliseconds() << " milliseconds" << std::endl;
+        brayns::Log::info("[PERF] Scene initialization took {} milliseconds",
+                          timer.milliseconds());
 
         auto& engine = brayns.getEngine();
         auto& scene = engine.getScene();
@@ -58,14 +58,14 @@ int main(int argc, const char** argv)
         }
         timer.stop();
 
-        BRAYNS_INFO << "[PERF] Rendering " << nbFrames << " frames took "
-                    << timer.milliseconds() << " milliseconds" << std::endl;
-        BRAYNS_INFO << "[PERF] Frames per second: "
-                    << nbFrames / timer.seconds() << std::endl;
+        brayns::Log::info("[PERF] Rendering {} frames took {} milliseconds.",
+                          nbFrames, timer.milliseconds());
+        brayns::Log::info("[PERF] Frames per second: {}.",
+                          nbFrames / timer.seconds());
     }
     catch (const std::runtime_error& e)
     {
-        BRAYNS_ERROR << e.what() << std::endl;
+        brayns::Log::error(e.what());
         return 1;
     }
     return 0;

apps/BraynsService/main.cpp

@@ -19,8 +19,8 @@
  */
 
 #include <brayns/Brayns.h>
+#include <brayns/common/Log.h>
 #include <brayns/common/Timer.h>
-#include <brayns/common/log.h>
 #include <brayns/engine/Engine.h>
 #include <brayns/network/interface/ActionInterface.h>
 
@@ -83,12 +83,12 @@ int main(int argc, const char** argv)
         service.run();
 
         timer.stop();
-        BRAYNS_INFO << "Service was running for " << timer.seconds()
-                    << " seconds" << std::endl;
+        brayns::Log::info("Service was running for {} seconds.",
+                          timer.seconds());
     }
     catch (const std::runtime_error& e)
     {
-        BRAYNS_ERROR << e.what() << std::endl;
+        brayns::Log::error(e.what());
         return 1;
     }
     return 0;

apps/BraynsViewer/main.cpp

@@ -21,7 +21,7 @@
 
 #include <apps/ui/Application.h>
 #include <brayns/Brayns.h>
-#include <brayns/common/log.h>
+#include <brayns/common/Log.h>
 
 #include <brayns/parameters/ApplicationParameters.h>
 #include <brayns/parameters/ParametersManager.h>
@@ -45,7 +45,7 @@ int main(int argc, const char** argv)
     }
     catch (const std::runtime_error& e)
     {
-        BRAYNS_ERROR << e.what() << std::endl;
+        brayns::Log::error(e.what());
         return EXIT_FAILURE;
     }
     return EXIT_SUCCESS;

apps/ui/Application.cpp

@@ -41,6 +41,7 @@
 
 #include <algorithm>
 #include <cassert>
+#include <iostream>
 
 namespace
 {

brayns/Brayns.cpp

@@ -23,10 +23,10 @@
 #include "EngineFactory.h"
 #include "PluginManager.h"
 
+#include <brayns/common/Log.h>
 #include <brayns/common/Timer.h>
 #include <brayns/common/input/KeyboardHandler.h>
 #include <brayns/common/light/Light.h>
-#include <brayns/common/log.h>
 #include <brayns/common/mathTypes.h>
 #include <brayns/utils/DynamicLib.h>
 #include <brayns/utils/StringUtils.h>
@@ -75,27 +75,21 @@ struct Brayns::Impl : public PluginAPI
         , _engineFactory{argc, argv, _parametersManager}
         , _pluginManager{argc, argv}
     {
-        BRAYNS_INFO << std::endl;
-        BRAYNS_INFO << " _|_|_|" << std::endl;
-        BRAYNS_INFO
-            << " _|    _|  _|  _|_|    _|_|_|  _|    _|  _|_|_|      _|_|_|  "
-            << std::endl;
-        BRAYNS_INFO
-            << " _|_|_|    _|_|      _|    _|  _|    _|  _|    _|  _|_|     "
-            << std::endl;
-        BRAYNS_INFO
-            << " _|    _|  _|        _|    _|  _|    _|  _|    _|      _|_| "
-            << std::endl;
-        BRAYNS_INFO
-            << " _|_|_|    _|          _|_|_|    _|_|_|  _|    _|  _|_|_|   "
-            << std::endl;
-        BRAYNS_INFO
-            << "                                    _|                     "
-            << std::endl;
-        BRAYNS_INFO
-            << "                                  _|_|                       "
-            << std::endl;
-        BRAYNS_INFO << std::endl;
+        Log::info("");
+        Log::info(" _|_|_|");
+        Log::info(
+            " _|    _|  _|  _|_|    _|_|_|  _|    _|  _|_|_|      _|_|_|  ");
+        Log::info(
+            " _|_|_|    _|_|      _|    _|  _|    _|  _|    _|  _|_|     ");
+        Log::info(
+            " _|    _|  _|        _|    _|  _|    _|  _|    _|      _|_| ");
+        Log::info(
+            " _|_|_|    _|          _|_|_|    _|_|_|  _|    _|  _|_|_|   ");
+        Log::info(
+            "                                    _|                     ");
+        Log::info(
+            "                                  _|_|                       ");
+        Log::info("");
 
         // This initialization must happen before plugin intialization.
         _createEngine();
@@ -379,7 +373,7 @@ struct Brayns::Impl : public PluginAPI
                 std::string msgLast;
                 auto timeLast = std::chrono::steady_clock::now();
 
-                BRAYNS_INFO << "Loading '" << path << "'" << std::endl;
+                Log::info("Loading '{}'.", path);
 
                 auto progress = [&](const std::string& msg, float t) {
                     constexpr auto MIN_SECS = 5;
@@ -400,7 +394,7 @@ struct Brayns::Impl : public PluginAPI
                         std::string p = std::to_string(percentage);
                         p.insert(p.begin(), 3 - p.size(), ' ');
 
-                        BRAYNS_INFO << "[" << p << "%] " << msg << std::endl;
+                        Log::info("[{}%] {}.", p, msg);
                         msgLast = msg;
                         percentageLast = percentage;
                         timeLast = time;
@@ -717,7 +711,7 @@ struct Brayns::Impl : public PluginAPI
         auto fovy = camera.getProperty<double>("fovy");
         fovy += delta;
         camera.updateProperty("fovy", fovy);
-        BRAYNS_INFO << "Field of view: " << fovy << std::endl;
+        Log::info("Field of view: {}.", fovy);
     }
 
     void _changeEyeSeparation(const double delta)
@@ -729,7 +723,7 @@ struct Brayns::Impl : public PluginAPI
             camera.getProperty<double>("interpupillaryDistance");
         eyeSeparation += delta;
         camera.updateProperty("interpupillaryDistance", eyeSeparation);
-        BRAYNS_INFO << "Eye separation: " << eyeSeparation << std::endl;
+        Log::info("Eye separation: {}.", eyeSeparation);
     }
 
     void _gradientMaterials()
@@ -766,7 +760,8 @@ struct Brayns::Impl : public PluginAPI
 
     void _displayCameraInformation()
     {
-        BRAYNS_INFO << _engine->getCamera() << std::endl;
+        auto& camera = _engine->getCamera();
+        Log::info("{}, {}", camera.getPosition(), camera.getOrientation());
     }
 
     ParametersManager _parametersManager;

brayns/EngineFactory.cpp

@@ -20,7 +20,7 @@
 
 #include "EngineFactory.h"
 
-#include <brayns/common/log.h>
+#include <brayns/common/Log.h>
 #include <brayns/engine/Engine.h>
 #include <brayns/parameters/ParametersManager.h>
 
@@ -67,14 +67,13 @@ Engine* EngineFactory::_loadEngine(const std::string& name, int argc,
         {
             _engines.emplace(name, std::unique_ptr<Engine>(plugin));
             _libs.push_back(std::move(library));
-            BRAYNS_INFO << "Loaded engine '" << name << "'" << std::endl;
+            Log::info("Loaded engine '{}'.", name);
             return plugin;
         }
     }
     catch (const std::runtime_error& exc)
     {
-        BRAYNS_ERROR << "Failed to load engine " << std::quoted(name) << ": "
-                     << exc.what() << std::endl;
+        Log::error("Failed to load engine '{}': {}", name, exc.what());
     }
     return nullptr;
 }

brayns/PluginManager.cpp

@@ -20,7 +20,7 @@
 
 #include "PluginManager.h"
 
-#include <brayns/common/log.h>
+#include <brayns/common/Log.h>
 #include <brayns/parameters/ParametersManager.h>
 #include <brayns/utils/StringUtils.h>
 
@@ -133,12 +133,12 @@ void PluginManager::_loadPlugin(const char* name, int argc, const char* argv[])
         {
             _extensions.emplace_back(plugin);
             _libs.push_back(std::move(library));
-            BRAYNS_INFO << "Loaded plugin '" << name << "'" << std::endl;
+            Log::info("Loaded plugin '{}'.", name);
         }
     }
     catch (const std::runtime_error& exc)
     {
-        BRAYNS_ERROR << exc.what() << std::endl;
+        Log::error(exc.what());
     }
 }
 } // namespace brayns

brayns/common/CMakeLists.txt

@@ -43,7 +43,7 @@ set(BRAYNSCOMMON_PUBLIC_HEADERS
   light/Light.h
   loader/Loader.h
   loader/LoaderRegistry.h
-  log.h
+  Log.h
   material/Texture2D.h
   mathTypes.h
   scene/ClipPlane.h
@@ -59,6 +59,7 @@ set(BRAYNSCOMMON_PUBLIC_HEADERS
 set(BRAYNSCOMMON_INCLUDE_NAME brayns/common)
 set(BRAYNSCOMMON_LINK_LIBRARIES
   PUBLIC glm Async++ ${LibJpegTurbo_LIBRARIES} braynsUtils braynsJson
+  PUBLIC spdlog::spdlog_header_only
   PRIVATE braynsParameters ${Boost_PROGRAM_OPTIONS_LIBRARY}
     ${FREEIMAGE_LIBRARIES}
 )
@@ -70,3 +71,8 @@ target_include_directories(braynsCommon SYSTEM PRIVATE ${FREEIMAGE_INCLUDE_DIRS}
 if(FFMPEG_FOUND)
   target_include_directories(braynsCommon SYSTEM PRIVATE ${FFMPEG_INCLUDE_DIR})
 endif()
+
+target_include_directories(braynsCommon PUBLIC  
+    "$<BUILD_INTERFACE:${CMAKE_SOURCE_DIR}/deps/spdlog/include>"
+    "$<INSTALL_INTERFACE:${CMAKE_INSTALL_PREFIX}/include>"
+)

brayns/common/ImageManager.cpp

@@ -19,7 +19,8 @@
  */
 
 #include "ImageManager.h"
-#include <brayns/common/log.h>
+
+#include <brayns/common/Log.h>
 #include <brayns/utils/Filesystem.h>
 #include <brayns/utils/ImageUtils.h>
 
@@ -155,8 +156,7 @@ Texture2DPtr ImageManager::importTextureFromFile(const std::string& filename,
     }
     return texture;
 #else
-    BRAYNS_ERROR << "FreeImage is required to load images from file"
-                 << std::endl;
+    Log::error("FreeImage is required to load images from file");
     return {};
 #endif
 }