Merge pull request #214 from uorocketry/fernando_n.logger_timestamp

Add Custom logging formatter

Author: seofernando25

src/IO/ArduinoEncoder.h

@@ -1,15 +1,14 @@
 #pragma once
 
 #include "cobs.h"
-#include "helpers/Helper.h"
 #include <memory>
 #include <spdlog/spdlog.h>
 
 class ArduinoEncoder
 {
   public:
     template <typename T>
-    static helper::SharedArray<char> encode(const T &dataOut);
+    static SharedArray<char> encode(const T &dataOut);
 
     template <typename T>
     static T decode(const char *buffer, int length);
@@ -20,7 +19,7 @@ class ArduinoEncoder
  * applied to it, and INCLUDES the ending 0x0 byte, so it can be sent as is.
  */
 template <typename T>
-helper::SharedArray<char> ArduinoEncoder::encode(const T &dataOut)
+SharedArray<char> ArduinoEncoder::encode(const T &dataOut)
 {
     // Convert from Protobuf to byte array
     size_t protoSize = dataOut.ByteSizeLong();
@@ -37,7 +36,7 @@ helper::SharedArray<char> ArduinoEncoder::encode(const T &dataOut)
     cobs_encode(&cobsData[0], cobsSize, &protoData[0], protoSize);
     cobsData[cobsSize - 1] = 0x0;
 
-    return helper::SharedArray<char>{cobsData, static_cast<size_t>(cobsSize)};
+    return SharedArray<char>{cobsData, static_cast<size_t>(cobsSize)};
 }
 
 /**

src/IO/ArduinoProxy.cpp

@@ -120,7 +120,7 @@ void ArduinoProxy::send(const RocketryProto::ArduinoIn &data)
     {
         std::lock_guard<std::mutex> lockGuard(serialMutex);
 
-        helper::SharedArray<char> encodedData = ArduinoEncoder::encode(data);
+        SharedArray<char> encodedData = ArduinoEncoder::encode(data);
 
         serialPutchar(fd, 0);
         for (int i = 0; i < encodedData.length; i++)

src/IO/InterfaceImpl.cpp

@@ -5,6 +5,7 @@
 #include "IO/TestingSensors.h"
 #include "InterfaceImpl.h"
 #include "common/pch.h"
+#include "common/utils.h"
 #include "data/UOSMData.h"
 #include <chrono>
 #include <iostream>
@@ -88,8 +89,7 @@ bool InterfaceImpl::updateInputs()
 {
     latestState = std::make_shared<StateData>();
 
-    latestState->timeStamp =
-        std::chrono::duration_cast<time_point::duration>(std::chrono::steady_clock::now().time_since_epoch()).count();
+    latestState->timeStamp = utils::getMonotonicTimeStamp();
 
 #if USE_SBG == 1
     latestState->sbg = mySbgSensor.getData();

src/IO/SensorLogger.cpp

@@ -3,9 +3,8 @@
 
 #include "SensorLogger.h"
 
-#include "helpers/Helper.h"
-
 #include "boost/filesystem.hpp"
+#include "common/utils.h"
 #include <iostream>
 #include <mutex>
 #include <spdlog/spdlog.h>
@@ -28,7 +27,7 @@ bool SensorLogger::isInitialized()
 
 void SensorLogger::run()
 {
-    auto path = helper::getEnvOrDefault<std::string>("LOG_PATH", "./sensor-data");
+    auto path = utils::getEnvOrDefault<std::string>("LOG_PATH", "./sensor-data");
     std::string ext = ".uorocketlog";
     if (path.back() != '/')
         path += "/";

src/IO/TestingSensors.cpp

@@ -2,8 +2,8 @@
 #if TESTING == 1
 
 #include "TestingSensors.h"
+#include "common/utils.h"
 #include "data/StateData.h"
-#include "helpers/Helper.h"
 
 #include <boost/algorithm/string.hpp>
 #include <boost/lexical_cast.hpp>
@@ -16,7 +16,7 @@ void TestingSensors::run()
 void TestingSensors::initialize()
 {
     createThread = false;
-    auto fileName = helper::getEnvOrDefault<std::string>("TESTING_INPUT_FILE", "./data/test-data.csv");
+    auto fileName = utils::getEnvOrDefault<std::string>("TESTING_INPUT_FILE", "./data/test-data.csv");
     std::ifstream logFile(fileName.c_str());
 
     std::string line;

src/IO/gpio/Gpio.cpp

@@ -3,7 +3,6 @@
 
 #include "Gpio.h"
 
-#include "helpers/Helper.h"
 #include <iostream>
 #include <string>
 

src/common/FileLogFormatter.h

@@ -0,0 +1,30 @@
+#pragma once
+#include "pch.h"
+#include "spdlog/pattern_formatter.h"
+#include "utils.h"
+
+/**
+ * Custom formatter for spdlog. Same as default but using the getTimeStamp() function
+ */
+class FileLogFormatter : public spdlog::formatter
+{
+  private:
+    spdlog::pattern_formatter f; // Separate formatter for rest of the log messages
+  public:
+    FileLogFormatter()
+    {
+        auto format = "[%n] [%^%l%$] [%s:%#] %v";
+        f.set_pattern(format);
+    }
+    void format(const spdlog::details::log_msg &msg, spdlog::memory_buf_t &dest) override
+    {
+        auto timeStamp = utils::getMonotonicTimeStamp();
+        dest.append("[" + std::to_string(timeStamp) + "] "); // The only thing we need to change is the time stamp
+        f.format(msg, dest);
+    }
+
+    std::unique_ptr<formatter> clone() const override
+    {
+        return std::make_unique<FileLogFormatter>();
+    }
+};

src/common/types.h

@@ -5,4 +5,11 @@ using time_point = std::chrono::time_point<std::chrono::steady_clock>;
 using duration_ns = std::chrono::duration<int64_t, std::nano>;
 using duration_ms = std::chrono::duration<int64_t, std::milli>;
 
-using eventType = long;
+using eventType = long;
+
+template <class T>
+struct SharedArray
+{
+    std::shared_ptr<T[]> data;
+    size_t length;
+};

src/common/utils.cpp

@@ -0,0 +1,7 @@
+#include "common/utils.h"
+
+uint64_t utils::getMonotonicTimeStamp()
+{
+    return std::chrono::duration_cast<time_point::duration>(std::chrono::steady_clock::now().time_since_epoch())
+        .count();
+}

src/helpers/Helper.h renamed to src/common/utils.h

@@ -2,21 +2,16 @@
 #include "common/pch.h"
 #include <boost/lexical_cast.hpp>
 
-namespace helper
+namespace utils
 {
 
+uint64_t getMonotonicTimeStamp();
+
 template <typename T>
 T getEnvOrDefault(const std::string &envName, T defaultValue)
 {
     const char *value = std::getenv(envName.c_str());
     return value ? boost::lexical_cast<T>(value) : defaultValue;
 }
 
-template <class T>
-struct SharedArray
-{
-    std::shared_ptr<T[]> data;
-    size_t length;
-};
-
-} // namespace helper
+} // namespace utils