proto_logger.h

#pragma once
 
#include <google/protobuf/message.h>
 
#include <functional>
#include <string>
#include <thread>
 
#include "software/multithreading/thread_safe_buffer.hpp"
 
class ProtoLogger
{
    struct SerializedProtoLog
    {
        std::string protobuf_type_full_name;
        std::string serialized_proto;
        double receive_time_sec;
    };
 
   public:
    explicit ProtoLogger(const std::string& log_path,
                         std::function<double()> time_provider,
                         bool friendly_colour_yellow);
 
    ProtoLogger() = delete;
 
    ProtoLogger(const ProtoLogger&) = delete;
    ProtoLogger& operator=(const ProtoLogger&) = delete;
 
    ~ProtoLogger();
 
    void saveSerializedProto(const std::string& protobuf_type_full_name,
                             const std::string& serialized_proto);
 
    template <typename ProtoType>
    inline void saveSerializedProto(const std::string& serialized_proto)
    {
        static_assert(std::is_base_of<google::protobuf::Message, ProtoType>::value,
                      "ProtoType has to be a protobuf message type");
 
        saveSerializedProto(ProtoType::GetDescriptor()->full_name(), serialized_proto);
    };
 
    void updateTimeProvider(std::function<double()> time_provider);
 
    void flushAndStopLogging();
 
    static std::string createLogEntry(const std::string& proto_full_name,
                                      const std::string& serialized_proto,
                                      double receive_time_sec);
 
   private:
    void logProtobufs();
 
    bool shouldStopLogging() const;
 
    std::string log_path_;
    std::string log_folder_;
    std::function<double()> time_provider_;
    double start_time_;
    bool friendly_colour_yellow_;
    unsigned int failed_logs_frequency_counter_ = 0;
 
    std::thread log_thread_;
    std::atomic<bool> stop_logging_;
    double destructor_called_time_sec_;
 
    ThreadSafeBuffer<SerializedProtoLog> buffer_;
 
    const Duration BUFFER_BLOCK_TIMEOUT                = Duration::fromSeconds(0.1);
    const std::string REPLAY_FILE_PREFIX               = "proto_";
    const std::string REPLAY_FILE_TIME_FORMAT          = "%Y_%m_%d_%H_%M_%S";
    static constexpr unsigned int PROTOBUF_BUFFER_SIZE = 1000;
    static constexpr unsigned int REPLAY_MAX_CHUNK_SIZE_BYTES = 1024 * 1024;  // 1 MB
    static constexpr unsigned int FAILED_LOG_PRINT_FREQUENCY  = 100;
};