Replace Logging with spdlog library for log rotation and better file system logging (#42)

* WIP replacing logging with spdlog library

* added ringbuffer sink for debug overlay

* set logging level to debug

* Set custom log patterns for spdlog

Author: ClemensElflein

CMakeLists.txt

@@ -43,6 +43,8 @@ OPTION (SERVED_BUILD_TESTS "Build served unit test suite" OFF)
 OPTION (SERVED_BUILD_EXAMPLES "Build served  examples" OFF)
 add_subdirectory(dependencies/served)
 
+add_subdirectory(dependencies/spdlog)
+
 if(USE_SPI)
     message("We have wiring pi!")
 
@@ -51,30 +53,43 @@ else()
     message("We don't have wiring pi!")
 endif()
 
-add_executable(self_o_mat.app src/main.cpp src/logic/BoothLogic.cpp src/logic/BoothLogic.h src/ui/BoothGui.cpp src/ui/BoothGui.h
-        src/camera/ICamera.h src/camera/OpenCVCamera.cpp src/camera/OpenCVCamera.h src/camera/GphotoCamera.cpp src/camera/GphotoCamera.h
-        src/ui/FPSCounter.h src/camera/NopCamera.h src/logic/ImageProcessor.cpp src/logic/ImageProcessor.h src/ui/IGui.h src/tools/ILogger.h
-        src/tools/ConsoleLogger.cpp src/tools/ConsoleLogger.h src/tools/buffers.h src/tools/buffers.cpp src/tools/imageinfo.h src/logic/PrinterManager.cpp
-        src/logic/PrinterManager.h src/api/BoothApi.h src/api/BoothApi.cpp src/protobuf/api.pb.cc src/protobuf/api.pb.h src/ui/NopGui.cpp
-        src/ui/NopGui.h src/tools/JpegDecoder.cpp src/tools/JpegDecoder.h src/tools/verbose.h src/tools/blocking_reader.h
-        src/camera/controllers/BaseController.h src/camera/controllers/TriggerController.cpp src/camera/controllers/NikonViewfinderController.h
-        src/camera/controllers/TriggerController.h src/camera/controllers/BaseController.cpp src/camera/controllers/FocusController.cpp
-        src/camera/controllers/FocusController.h src/camera/controllers/InfoController.cpp src/camera/controllers/InfoController.h
-        src/camera/controllers/ApertureController.h src/camera/controllers/ExposureCorrectionController.h src/camera/controllers/ChoiceRangeController.cpp
-        src/camera/controllers/ChoiceRangeController.h src/tools/readfile.h src/tools/readfile.cpp src/tools/cobs.h src/tools/cobs.cpp src/logic/SelfomatController.cpp src/logic/SelfomatController.h src/logic/filters/IImageFilter.h src/logic/filters/BasicImageFilter.cpp src/logic/filters/BasicImageFilter.h src/logic/filters/IImageFilter.cpp src/tools/FilesystemLogger.cpp src/tools/FilesystemLogger.h src/tools/verbose.cpp)
-
-
-
-target_link_libraries(self_o_mat.app ${Boost_LIBRARIES})
-target_link_libraries(self_o_mat.app gphoto2 gphoto2_port)
-target_link_libraries(self_o_mat.app turbojpeg)
-target_link_libraries(self_o_mat.app sfml-system)
-target_link_libraries(self_o_mat.app sfml-graphics)
-target_link_libraries(self_o_mat.app sfml-window)
-target_link_libraries(self_o_mat.app ${OpenCV_LIBS})
-target_link_libraries(self_o_mat.app ${CUPS_LIBRARIES})
-target_link_libraries(self_o_mat.app served)
-target_link_libraries(self_o_mat.app protobuf)
+add_executable(self_o_mat.app
+        src/main.cpp
+        src/logic/BoothLogic.cpp
+        src/ui/BoothGui.cpp
+        src/camera/OpenCVCamera.cpp
+        src/camera/GphotoCamera.cpp
+        src/logic/ImageProcessor.cpp
+        src/tools/buffers.cpp
+        src/logic/PrinterManager.cpp
+        src/api/BoothApi.cpp src/protobuf/api.pb.cc
+        src/ui/NopGui.cpp
+        src/tools/JpegDecoder.cpp
+        src/camera/controllers/TriggerController.cpp
+        src/camera/controllers/BaseController.cpp src/camera/controllers/FocusController.cpp
+        src/camera/controllers/InfoController.cpp
+        src/camera/controllers/ChoiceRangeController.cpp
+        src/tools/readfile.cpp
+        src/tools/cobs.cpp src/logic/SelfomatController.cpp
+        src/logic/filters/BasicImageFilter.cpp
+        src/logic/filters/IImageFilter.cpp
+        src/tools/verbose.cpp)
+
+
+
+target_link_libraries(self_o_mat.app ${Boost_LIBRARIES}
+        gphoto2
+        gphoto2_port
+        turbojpeg
+        sfml-system
+        sfml-graphics
+        sfml-window
+        ${OpenCV_LIBS}
+        ${CUPS_LIBRARIES}
+        served
+        protobuf
+        spdlog::spdlog
+)
 
 add_executable(filter_test src/main_filter.cpp src/logic/filters/IImageFilter.h src/logic/filters/BasicImageFilter.cpp src/logic/filters/BasicImageFilter.h src/logic/filters/IImageFilter.cpp)
 target_link_libraries(filter_test ${Boost_LIBRARIES})

dependencies/spdlog/CMakeLists.txt

@@ -0,0 +1,10 @@
+
+Include(FetchContent)
+
+FetchContent_Declare(
+        spdlog
+        GIT_REPOSITORY https://github.com/gabime/spdlog
+        GIT_TAG v1.14.0
+)
+
+FetchContent_MakeAvailable(spdlog)

src/camera/NopCamera.h

@@ -60,7 +60,7 @@ namespace selfomat {
                 // Load assets
                 video = cv::VideoCapture("/opt/assets/nop.mov");
                 if (!video.isOpened()) {
-                    cerr << "Could not load nop video." << endl;
+                    spdlog::error("Could not load nop video.");
                 } else {
                     fpsClock.restart();
                 }

src/camera/controllers/BaseController.cpp

@@ -4,6 +4,7 @@
 
 
 #include "BaseController.h"
+#include <sstream>
 
 using namespace selfomat::camera::gphoto;
 using namespace selfomat::tools;

src/logic/BoothLogic.cpp

@@ -3,6 +3,8 @@
 //
 #include "BoothLogic.h"
 
+#include "spdlog/sinks/dist_sink.h"
+
 using namespace std;
 using namespace selfomat::logic;
 using namespace selfomat::camera;
@@ -763,6 +765,10 @@ int BoothLogic::getTriggerCounter() {
     return triggerCounter;
 }
 
+bool BoothLogic::isAgreementVisible() {
+    return showAgreement;
+}
+
 void BoothLogic::incTriggerCounter() {
     this->triggerCounter++;
 }
@@ -968,19 +974,25 @@ void BoothLogic::setDebugLogEnabled(bool newValue, bool persist) {
             return;
         }
 
-        FilesystemLogger::INSTANCE.enableLogToFile(imageDir);
+        if(!file_logger) {
+            // Create the file logger and add it to the dist_sink
+            file_logger = std::make_shared<spdlog::sinks::rotating_file_sink_mt>(imageDir+"/selfomat.log", 1024*1024*10, 3, false);
+            dynamic_cast<spdlog::sinks::dist_sink<std::mutex>*>(spdlog::default_logger()->sinks().front().get())->add_sink(file_logger);
+        }
     } else {
-        FilesystemLogger::INSTANCE.disableLogToFile();
+        if(file_logger) {
+            // if we have a file logger, remove it from the sink and delete it
+            dynamic_cast<spdlog::sinks::dist_sink<std::mutex>*>(spdlog::default_logger()->sinks().front().get())->remove_sink(file_logger);
+            file_logger = nullptr;
+        }
     }
 
-    gui->setDebugOutput(FilesystemLogger::INSTANCE.getLogToFileState() == FilesystemLogger::ENABLED);
-
     if (persist)
         writeSettings();
 }
 
 bool BoothLogic::getDebugLogEnabled() {
-    return FilesystemLogger::INSTANCE.getLogToFileState() == FilesystemLogger::ENABLED;
+    return file_logger != nullptr;
 }
 
 bool BoothLogic::getAutofocusBeforeTrigger() {

src/logic/BoothLogic.h

@@ -33,8 +33,9 @@
 #include "ILogicController.h"
 
 #include <tools/verbose.h>
+#include <spdlog/spdlog.h>
 
-
+#include "spdlog/sinks/rotating_file_sink.h"
 
 
 using namespace selfomat::camera;
@@ -82,8 +83,8 @@ namespace selfomat {
         public:
             explicit BoothLogic(ICamera *camera, IGui *gui, bool has_button, const string &button_port, bool has_flash,
                                 string imageDir, bool force_image_dir_mountpoint, bool disable_watchdog, bool show_led_setup, bool autofocus_before_trigger) : camera(camera), gui(gui),
-                                                                        imageProcessor(gui),
-                                                                        printerManager(gui),
+                                                                        imageProcessor(),
+                                                                        printerManager(),
                                                                         has_button(has_button),
                                                                         has_flash(has_flash),
                                                                         imageDir(imageDir),
@@ -176,6 +177,8 @@ namespace selfomat {
             boost::thread printThreadHandle;
             boost::thread printMonitoringThreadHandle;
 
+            std::shared_ptr<spdlog::sinks::rotating_file_sink_mt> file_logger{nullptr};
+
             int filterChoice = 0;
             double filterGain = 1.0;
             bool wasSuccessfullyStopped = false;
@@ -253,6 +256,8 @@ namespace selfomat {
             void incTriggerCounter();
             int getTriggerCounter();
 
+            bool isAgreementVisible() override;
+
             void setPrinterEnabled(bool printerEnabled, bool persist = false);
             bool getPrinterEnabled();
 

src/logic/ILogicController.h

@@ -13,6 +13,7 @@ namespace selfomat {
             virtual void confirmPrint() = 0;
             virtual void stop() = 0;
             virtual bool getPrintConfirmationEnabled() = 0;
+            virtual bool isAgreementVisible() = 0;
             virtual std::wstring getTranslation(std::string id) = 0;
         };
     }

src/logic/ImageProcessor.cpp

@@ -49,12 +49,7 @@ void ImageProcessor::loadTemplateImage() {
 
 }
 
-ImageProcessor::ImageProcessor(ILogger *logger) {
-    if (logger != nullptr) {
-        this->logger = logger;
-    } else {
-        this->logger = new ConsoleLogger();
-    }
+ImageProcessor::ImageProcessor() {
 }
 
 ImageProcessor::~ImageProcessor() {

src/logic/ImageProcessor.h

@@ -7,11 +7,9 @@
 
 
 #include <iostream>
-#include <tools/ILogger.h>
 #include <tools/imageinfo.h>
 #include <boost/property_tree/ptree.hpp>
 #include <boost/property_tree/json_parser.hpp>
-#include <tools/ConsoleLogger.h>
 #include <tools/buffers.h>
 #include <tools/verbose.h>
 #include <tools/JpegDecoder.h>
@@ -40,8 +38,6 @@ namespace selfomat {
 
             cv::Rect offset;
 
-            ILogger *logger;
-
             void *latestBuffer = nullptr;
             size_t latestBufferSize = 0;
 
@@ -58,7 +54,7 @@ namespace selfomat {
             void loadTemplateImage();
 
         public:
-            explicit ImageProcessor(ILogger *logger);
+            explicit ImageProcessor();
 
             cv::Mat frameImageForPrint(void *inputImageJpeg, size_t jpegBufferSize, FILTER filter = NO_FILTER, double filterGain = 1.0);
             cv::Mat decodeImageForPrint(void *inputImageJpeg, size_t jpegBufferSize, FILTER filter = NO_FILTER, double filterGain = 1.0);

src/logic/PrinterManager.cpp

@@ -225,7 +225,7 @@ int PrinterManager::printImage() {
     return job_id;
 }
 
-PrinterManager::PrinterManager(ILogger *logger) : logger(logger) {
+PrinterManager::PrinterManager() {
     currentPrinterState = STATE_UNKNOWN;
 }
 

src/logic/PrinterManager.h

@@ -10,7 +10,6 @@
 #include <cups/ipp.h>
 #include <cups/adminutil.h>
 #include <iostream>
-#include "tools/ILogger.h"
 #include <opencv2/opencv.hpp>
 #include "../tools/buffers.h"
 
@@ -53,7 +52,6 @@ namespace selfomat {
             PRINTER_STATE currentPrinterState;
             std::vector<std::string> currentStateReasons;
 
-            ILogger *logger;
             std::string printer_name;
 
             void *imageTmpBuffer = nullptr;
@@ -83,7 +81,7 @@ namespace selfomat {
 
             bool refreshPrinterState();
 
-            PrinterManager(ILogger *logger);
+            PrinterManager();
 
             bool prepareImageForPrint(cv::Mat image);
 

src/main.cpp

@@ -12,6 +12,12 @@
 
 #include <sstream>
 #include <iostream>
+#include <spdlog/spdlog.h>
+#include <spdlog/async.h>
+
+#include "spdlog/sinks/dist_sink.h"
+#include "spdlog/sinks/rotating_file_sink.h"
+#include "spdlog/sinks/stdout_color_sinks.h"
 
 using namespace std;
 using namespace boost;
@@ -84,7 +90,7 @@ void exitfunc(int code) {
 
     LOG_I("main", "Disable filesystem logger");
 
-    selfomat::tools::FilesystemLogger::INSTANCE.disableLogToFile();
+    // TODO: spdlog disable file system logging?
 
     std::cout << "Cleaned up" << endl;
     exitMutex.unlock();
@@ -96,6 +102,22 @@ void exitfunc() {
 
 int main(int argc, char *argv[]) {
 
+    // Setup logging (async logger to file and console)
+    spdlog::init_thread_pool(8192, 1);
+
+    auto stdout_sink = std::make_shared<spdlog::sinks::stdout_color_sink_mt >();
+
+    // create a dist_sink which distributes to other sinks
+    // this allows us to add the file sink later
+    const auto dist_sink = std::make_shared<spdlog::sinks::dist_sink<std::mutex>>();
+    dist_sink->add_sink(stdout_sink);
+    spdlog::set_default_logger(std::make_unique<spdlog::async_logger>("default", dist_sink,
+        spdlog::thread_pool(), spdlog::async_overflow_policy::block));
+
+    spdlog::flush_every(std::chrono::seconds(1));
+
+    spdlog::set_pattern("[%X] [%^%l%$]: %v");
+    spdlog::set_level(spdlog::level::debug);
 
     // Listen to some common signals so that we're able to stop the camera gui etc gracefully
     //^C
@@ -151,7 +173,6 @@ int main(int argc, char *argv[]) {
     } catch (boost::exception &e) {
         LOG_E(TAG, "Error loading properties. Using defaults.");
     }
-
     LOG_D(TAG, "Using camera: ", camera_type);
     LOG_D(TAG, "Has Button: ", std::to_string(has_button));
     LOG_D(TAG, "Button Port Name: ", button_port_name);