Optimize: Modify cls log module

Author: raylchen

trpc/logging/cls/cls_log.cc

@@ -26,15 +26,15 @@ namespace trpc::cls {
 
 std::unordered_map<std::string, uint32_t> logger_plungin_id_map;
 
-void SetLoggerPlunginId(const std::string& logger_name, uint32_t plugin_id) {
+void SetLoggerPluginId(const std::string& logger_name, uint32_t plugin_id) {
   logger_plungin_id_map[logger_name] = plugin_id;
 }
 
-uint32_t GetPlunginIdFromLogger(const std::string& logger_name) { return logger_plungin_id_map[logger_name]; }
+uint32_t GetPluginIdFromLogger(const std::string& logger_name) { return logger_plungin_id_map[logger_name]; }
 
-std::unordered_map<std::string, uint32_t>& GetLoggerPlunginIdMap() { return logger_plungin_id_map; }
+std::unordered_map<std::string, uint32_t>& GetLoggerPluginIdMap() { return logger_plungin_id_map; }
 
-void ClsLog::initSDK() {
+void ClsLog::InitSDK() {
   // Init cls-sdk client.
   sdk_config_.set_maxsendworkercount(1);
   sdk_config_.set_endpoint(endpoint_);
@@ -49,7 +49,7 @@ void ClsLog::initSDK() {
   cls_sink_->Start();
 }
 
-bool ClsLog::initSpdLogger() {
+bool ClsLog::InitSpdLogger() {
   auto formatter =
       std::make_unique<spdlog::pattern_formatter>(spdlog::pattern_time_type::local, spdlog::details::os::default_eol);
   cls_sink_->set_formatter(std::move(formatter));
@@ -81,13 +81,13 @@ int ClsLog::Init() noexcept {
   cls_sink_ = std::make_shared<ClsSinkMt>();
 
   // Initialize spdlog logger configuration
-  if (!initSpdLogger()) {
+  if (!InitSpdLogger()) {
     TRPC_FMT_ERROR("Init spdlog logger fail!");
     return -1;
   }
 
   // Initialize the cls-sdk configuration
-  initSDK();
+  InitSDK();
 
   return 0;
 }

trpc/logging/cls/cls_log.h

@@ -36,16 +36,16 @@ namespace trpc::cls {
 /// @brief Set the plugin ID for a given logger name.
 /// @param logger_name The name of the logger.
 /// @param plugin_id The ID of the plugin associated with the logger.
-void SetLoggerPlunginId(const std::string& logger_name, uint32_t plugin_id);
+void SetLoggerPluginId(const std::string& logger_name, uint32_t plugin_id);
 
 /// @brief Get the plugin ID associated with a given logger name.
 /// @param logger_name The name of the logger.
 /// @return The plugin ID associated with the logger name.
-uint32_t GetPlunginIdFromLogger(const std::string& logger_name);
+uint32_t GetPluginIdFromLogger(const std::string& logger_name);
 
 /// @brief Get the map of logger names to plugin IDs.
 /// @return A reference to the unordered_map containing logger names as keys and plugin IDs as values.
-std::unordered_map<std::string, uint32_t>& GetLoggerPlunginIdMap();
+std::unordered_map<std::string, uint32_t>& GetLoggerPluginIdMap();
 
 /// @brief Adds key-value pairs to the context's filter data for each logger plugin.
 /// @tparam T The type of the context object.
@@ -63,14 +63,14 @@ std::unordered_map<std::string, uint32_t>& GetLoggerPlunginIdMap();
 /// @endcode
 template <typename T, typename... Args>
 void WithFields(T& context, Args&&... key_value_pairs) {
-  auto plugin_id_map = GetLoggerPlunginIdMap();
+  auto plugin_id_map = GetLoggerPluginIdMap();
   for (const auto& [logger_name, plugin_id] : plugin_id_map) {
     auto* data_map = context->template GetFilterData<std::unordered_map<std::string, std::string>>(
-        GetPlunginIdFromLogger(logger_name.c_str()));
+        GetPluginIdFromLogger(logger_name.c_str()));
     if (!data_map) {
       std::unordered_map<std::string, std::string> new_data_map;
       (new_data_map.emplace(std::forward<Args>(key_value_pairs)), ...);
-      context->SetFilterData(GetPlunginIdFromLogger(logger_name.c_str()), std::move(new_data_map));
+      context->SetFilterData(GetPluginIdFromLogger(logger_name.c_str()), std::move(new_data_map));
     } else {
       (data_map->emplace(std::forward<Args>(key_value_pairs)), ...);
     }
@@ -79,11 +79,11 @@ void WithFields(T& context, Args&&... key_value_pairs) {
 
 class ClsLog : public Logging {
  public:
-  std::string Name() const { return "cls-log"; }
+  std::string Name() const override { return "cls-log"; }
 
-  std::string LoggerName() const { return logger_name_; }
+  const std::string& LoggerName() const override { return logger_name_; }
 
-  std::string Version() const { return "1.0.0"; }
+  std::string Version() const  { return "1.0.0"; }
 
   explicit ClsLog(const ClsLogSinkConfig& sink_config)
       : logger_name_(sink_config.logger_name),
@@ -92,7 +92,7 @@ class ClsLog : public Logging {
         endpoint_(sink_config.endpoint),
         secret_id_(sink_config.secret_id),
         secret_key_(sink_config.secret_key) {
-    SetLoggerPlunginId(logger_name_, this->GetPluginID());
+    SetLoggerPluginId(logger_name_, this->GetPluginID());
     Init();
   }
 
@@ -154,10 +154,10 @@ class ClsLog : public Logging {
 
  private:
   // Initialize the CLS SDK
-  void initSDK();
+  void InitSDK();
 
   // Initialize the spdlog logger instance
-  bool initSpdLogger();
+  bool InitSpdLogger();
 
  private:
   // logger configuration
@@ -181,4 +181,4 @@ class ClsLog : public Logging {
 
 using ClsLogPtr = RefPtr<ClsLog>;
 
-}  // namespace trpc::cls
+}  // namespace trpc::cls

trpc/logging/cls/cls_log_api.cc

@@ -24,7 +24,7 @@ bool Init() {
     return -1;
   }
   for (const auto& config : config_list) {
-    TrpcPlugin::GetInstance()->RegisterLogging(MakeRefCounted<ClsLog>(std::move(config)));
+    TrpcPlugin::GetInstance()->RegisterLogging(MakeRefCounted<ClsLog>(config));
   }
 
   return true;

trpc/logging/cls/cls_log_test.cc

@@ -37,6 +37,24 @@ class ClsLogTest : public ::testing::Test {
       return;
     }
 
+    ASSERT_TRUE(config_list.size() == 1);
+
+    auto& cls_conf = config_list[0];
+    cls_conf.Display();
+    ASSERT_STREQ(cls_conf.logger_name.c_str(), "default");
+    ASSERT_TRUE(cls_conf.mode == 2);
+    ASSERT_TRUE(cls_conf.logs_per_request == 100);
+    ASSERT_TRUE(cls_conf.request_timeout == 50);
+    ASSERT_TRUE(cls_conf.connect_timeout == 5);
+
+    ASSERT_STREQ(cls_conf.topic_id.c_str(), "0***********e");
+    ASSERT_STREQ(cls_conf.cls_region.c_str(), "a***********u");
+    ASSERT_STREQ(cls_conf.cls_domain.c_str(), "tencentyun");
+    ASSERT_STREQ(cls_conf.secret_id.c_str(), "A***********t");
+    ASSERT_STREQ(cls_conf.secret_key.c_str(), "J***********x");
+    ASSERT_STREQ(cls_conf.key_message.c_str(), "msg");
+    ASSERT_STREQ(cls_conf.endpoint.c_str(), "a***********u.cls.tencentyun.com");
+
     cls_default_ = MakeRefCounted<ClsLog>(config_list[0]);
     default_log_->RegisterRawSink(cls_default_);
   }

trpc/logging/cls/cls_sink_test.cc

@@ -12,6 +12,7 @@
 //
 
 #include "trpc/logging/cls/cls_sink.h"
+
 #include "gmock/gmock.h"
 #include "gtest/gtest.h"
 
@@ -90,4 +91,4 @@ TEST_F(ClsSinkTest, FlushTest) {
   ASSERT_TRUE(HasClsKV(cls_log_after_flush, "key", "value"));
 }
 
-}  // namespace trpc::cls
+}  // namespace trpc::cls