!36 feat(main):1.11.14, 为main框架添加log.max_len参数；同时添加/log/max_len终端命令

* feat(main):1.11.14, 为main框架添加log.max_len参数；同时添加/log/max_len终端命令
* fix(base,log):1.11.13, 解决日志内容过长，不输出的问题
* tidy(base): 优化log_impl.cpp格式，加注释
* fix(base): 实现日志过长，进行截断打印的功能，解决日志内容过长丢弃的问题

Author: hevake

modules/base/CMakeLists.txt

@@ -30,7 +30,7 @@ set(TBOX_LIBRARY_NAME tbox_base)
 set(TBOX_BASE_HEADERS
     version.h
     log.h
-    log_imp.h
+    log_impl.h
     log_output.h
     defines.h
     scope_exit.hpp
@@ -50,7 +50,7 @@ set(TBOX_BASE_HEADERS
 
 set(TBOX_BASE_SOURCES
     version.cpp
-    log_imp.cpp
+    log_impl.cpp
     log_output.cpp
     backtrace.cpp
     catch_throw.cpp

modules/base/Makefile

@@ -31,7 +31,7 @@ HAVE_EXECINFO_H ?= yes
 HEAD_FILES = \
 	version.h \
 	log.h \
-	log_imp.h \
+	log_impl.h \
 	log_output.h \
 	defines.h \
 	scope_exit.hpp \
@@ -51,7 +51,7 @@ HEAD_FILES = \
 
 CPP_SRC_FILES = \
 	version.cpp \
-	log_imp.cpp \
+	log_impl.cpp \
 	log_output.cpp \
 	backtrace.cpp \
 	catch_throw.cpp \

modules/base/log_imp.cpp modules/base/log_impl.cpp

@@ -17,7 +17,7 @@
  * project authors may be found in the CONTRIBUTORS.md file in the root
  * of the source tree.
  */
-#include "log_imp.h"
+#include "log_impl.h"
 
 #include <sys/time.h>
 #include <sys/syscall.h>
@@ -29,7 +29,8 @@
 #include <mutex>
 
 namespace {
-constexpr uint32_t LOG_MAX_LEN = (100 << 10);
+
+size_t _LogTextMaxLength = (100 << 10);     //! 限定单条日志最大长度，默认为100KB
 
 std::mutex _lock;
 uint32_t _id_alloc = 0;
@@ -76,8 +77,8 @@ const char  LOG_LEVEL_LEVEL_CODE[LOG_LEVEL_MAX] = {
 };
 
 const char* LOG_LEVEL_COLOR_CODE[LOG_LEVEL_MAX] = {
-    "31",       //! FATAL       红
-    "7;91",     //! ERROR       文字黑，背景亮红
+    "7;91",     //! FATAL       文字黑，背景亮红
+    "31",       //! ERROR       红
     "7;93",     //! WARN        文字黑，背景亮黄
     "93",       //! NOTICE      亮黄
     "7;92",     //! IMPORTANT   文字黑，背景亮绿
@@ -86,6 +87,22 @@ const char* LOG_LEVEL_COLOR_CODE[LOG_LEVEL_MAX] = {
     "35",       //! TRACE       洋葱红
 };
 
+extern "C" {
+
+size_t LogSetMaxLength(size_t max_len)
+{
+    std::lock_guard<std::mutex> lg(_lock);
+    auto origin_len = _LogTextMaxLength;
+    _LogTextMaxLength = max_len;
+    return origin_len;
+}
+
+size_t LogGetMaxLength()
+{
+    std::lock_guard<std::mutex> lg(_lock);
+    return _LogTextMaxLength;
+}
+
 /**
  * \brief   日志格式化打印接口的实现
  *
@@ -120,42 +137,66 @@ void LogPrintfFunc(const char *module_id, const char *func_name, const char *fil
         .level = level,
         .text_len = 0,
         .text_ptr = nullptr,
+        .text_trunc = false,
     };
 
     if (fmt != nullptr) {
         if (with_args) {
-            uint32_t buff_size = 1024;    //! 初始大小，可应对绝大数情况
+            uint32_t buff_size = std::min(2048lu, _LogTextMaxLength) + 1;
+
             for (;;) {
                 va_list args;
                 char buffer[buff_size];
 
                 va_start(args, fmt);
-                size_t len = vsnprintf(buffer, buff_size, fmt, args);
+                size_t len = 0;
+
+                len = ::vsnprintf(buffer, buff_size, fmt, args);
+
+                if (content.text_trunc)
+                    len = _LogTextMaxLength;
+
                 va_end(args);
 
+                //! 如果buffer的空间够用，则正常派发日志
+                //! 否则要对buffer空间进行扩张，或是对内容进行截断
                 if (len < buff_size) {
                     content.text_len = len;
                     content.text_ptr = buffer;
                     Dispatch(content);
                     break;
                 }
 
-                buff_size = len + 1;    //! 要多留一个结束符 \0，否则 vsnprintf() 会少一个字符
-                if (buff_size > LOG_MAX_LEN) {
-                    std::cerr << "WARN: log text length " << buff_size << ", too long!" << std::endl;
-                    break;
+                //! 没有超过MaxLength，则进行扩张
+                if (len <= _LogTextMaxLength) {
+                    buff_size = len + 1;    //! 要多留一个结束符 \0，否则 vsnprintf() 会少一个字符
+
+                } else {    //! 否则进行截断处理
+                    buff_size = _LogTextMaxLength + 1;  //! 同上
+                    content.text_trunc = true;
                 }
             }
+
         } else {
             content.text_len = ::strlen(fmt);
+
+            //! 如果超出最大长度，要限制
+            if (content.text_len > _LogTextMaxLength) {
+                content.text_len = _LogTextMaxLength;
+                content.text_trunc = true;
+            }
+
             content.text_ptr = fmt;
             Dispatch(content);
         }
+
     } else {
         Dispatch(content);
     }
 }
 
+}
+
 uint32_t LogAddPrintfFunc(LogPrintfFuncType func, void *ptr)
 {
     std::lock_guard<std::mutex> lg(_lock);

modules/base/log_imp.h modules/base/log_impl.h

@@ -17,8 +17,8 @@
  * project authors may be found in the CONTRIBUTORS.md file in the root
  * of the source tree.
  */
-#ifndef TBOX_BASE_LOG_IMP_20180201
-#define TBOX_BASE_LOG_IMP_20180201
+#ifndef TBOX_BASE_LOG_IMPL_20180201
+#define TBOX_BASE_LOG_IMPL_20180201
 
 /**
  * 本文件只声明了函数 LogSetPrintfFunc() 该函数用于指定日志输出函数
@@ -27,6 +27,7 @@
 
 #include <stdarg.h>
 #include <stdint.h>
+#include <stddef.h>
 
 #include "log.h"
 
@@ -49,6 +50,7 @@ struct LogContent {
     int         level;      //!< 日志等级
     uint32_t    text_len;   //!< 内容大小
     const char *text_ptr;   //!< 内容地址
+    bool        text_trunc; //!< 是否截断
 };
 
 //! 日志等级颜色表
@@ -58,6 +60,11 @@ extern const char*  LOG_LEVEL_COLOR_CODE[LOG_LEVEL_MAX];
 //! 定义日志输出函数
 typedef void (*LogPrintfFuncType)(const LogContent *content, void *ptr);
 
+//! 设置最大长度
+size_t   LogSetMaxLength(size_t max_len);
+//! 获取最大长度
+size_t   LogGetMaxLength();
+
 //! 添加与删除日志输出函数
 uint32_t LogAddPrintfFunc(LogPrintfFuncType func, void *ptr);
 bool     LogRemovePrintfFunc(uint32_t id);
@@ -66,4 +73,4 @@ bool     LogRemovePrintfFunc(uint32_t id);
 }
 #endif
 
-#endif //TBOX_BASE_LOG_IMP_20180201
+#endif //TBOX_BASE_LOG_IMPL_20180201

modules/base/log_output.cpp

@@ -30,7 +30,7 @@
 #include <mutex>
 #include <iostream>
 
-#include "log_imp.h"
+#include "log_impl.h"
 
 #define TIMESTAMP_STRING_SIZE   27
 
@@ -64,7 +64,10 @@ namespace {
             printf("%s() ", content->func_name);
 
         if (content->text_len > 0)
-            printf("%s ", content->text_ptr);
+            printf("%.*s ", content->text_len, content->text_ptr);
+
+        if (content->text_trunc == 1)
+            printf("(TRUNCATED) ");
 
         if (content->file_name != nullptr)
             printf("-- %s:%d", content->file_name, content->line);

modules/base/log_output_test.cpp

@@ -19,6 +19,7 @@
  */
 #include <gtest/gtest.h>
 #include "log.h"
+#include "log_impl.h"
 #include "log_output.h"
 
 TEST(Log, AllLevel)
@@ -60,3 +61,21 @@ TEST(Log, error)
     LogErrno(1, "has value:%d", 123);
     LogOutput_Disable();
 }
+
+TEST(Log, Truncate)
+{
+    LogOutput_Enable();
+
+    std::string long_str(1025, 'l');
+    std::string normal_str(1024, 'n');
+
+    auto origin_len = LogSetMaxLength(1024);
+
+    LogInfo(normal_str.c_str());
+    LogNotice(long_str.c_str());
+    LogInfo("%s", normal_str.c_str());
+    LogNotice("%s", long_str.c_str());
+
+    LogSetMaxLength(origin_len);
+    LogOutput_Disable();
+}

modules/log/async_file_sink.cpp

@@ -91,30 +91,28 @@ void AsyncFileSink::updateInnerValues()
     CHECK_CLOSE_RESET_FD(fd_);
 }
 
-void AsyncFileSink::appendLog(const char *str, size_t len)
+void AsyncFileSink::endline()
 {
-    buffer_.reserve(buffer_.size() + len - 1);
-    std::back_insert_iterator<std::vector<char>>  back_insert_iter(buffer_);
-    std::copy(str, str + len - 1, back_insert_iter);
+    cache_.push_back('\n');
 }
 
-void AsyncFileSink::flushLog()
+void AsyncFileSink::flush()
 {
     if (pid_ == 0 || !checkAndCreateLogFile())
         return;
 
-    auto wsize = ::write(fd_, buffer_.data(), buffer_.size());
-    if (wsize != static_cast<ssize_t>(buffer_.size())) {
+    auto wsize = ::write(fd_, cache_.data(), cache_.size());
+    if (wsize != static_cast<ssize_t>(cache_.size())) {
         cerr << "Err: write file error." << endl;
         return;
     }
 
-    total_write_size_ += buffer_.size();
-
-    buffer_.clear();
+    total_write_size_ += cache_.size();
 
     if (total_write_size_ >= file_max_size_)
         CHECK_CLOSE_RESET_FD(fd_);
+
+    cache_.clear();
 }
 
 bool AsyncFileSink::checkAndCreateLogFile()

modules/log/async_file_sink.h

@@ -44,8 +44,8 @@ class AsyncFileSink : public AsyncSink {
   protected:
     void updateInnerValues();
 
-    virtual void appendLog(const char *str, size_t len) override;
-    virtual void flushLog() override;
+    virtual void endline() override;
+    virtual void flush() override;
 
     bool checkAndCreateLogFile();
 

modules/log/async_file_sink_test.cpp

@@ -66,25 +66,6 @@ TEST(AsyncFileSink, AllLevel)
     ch.cleanup();
 }
 
-TEST(AsyncFileSink, LongString)
-{
-    AsyncFileSink ch;
-
-    ch.setFilePath("/tmp/tbox");
-    ch.setFilePrefix("test");
-    ch.enable();
-
-    for (size_t s = 900; s < 1200; ++s) {
-        std::string tmp(s, 'z');
-        LogInfo("%s", tmp.c_str());
-    }
-
-    std::string tmp(4096, 'x');
-    LogInfo("%s", tmp.c_str());
-
-    ch.cleanup();
-}
-
 TEST(AsyncFileSink, FileDivide)
 {
     AsyncFileSink ch;
@@ -116,28 +97,34 @@ TEST(AsyncFileSink, ParamNormalize)
     ch.cleanup();
 }
 
-TEST(AsyncFileSink, CreateFileInInit)
+TEST(AsyncFileSink, RemoveLogFileDuringWriting)
 {
     AsyncFileSink ch;
     ch.setFilePath("/tmp/tbox");
-    ch.setFilePrefix("create_file_init");
+    ch.setFilePrefix("remove_log_file_during_writing");
     ch.enable();
-    std::string name = ch.currentFilename();
-    EXPECT_TRUE(util::fs::IsFileExist(name));
+    util::fs::RemoveFile(ch.currentFilename());
+    LogInfo("Hello");
+    std::this_thread::sleep_for(std::chrono::seconds(1));
+    EXPECT_TRUE(util::fs::IsFileExist(ch.currentFilename()));
     ch.cleanup();
 }
 
-TEST(AsyncFileSink, RemoveLogFileDuringWriting)
+TEST(AsyncFileSink, Truncate)
 {
+    auto origin_len = LogSetMaxLength(100);
+
     AsyncFileSink ch;
     ch.setFilePath("/tmp/tbox");
-    ch.setFilePrefix("remove_log_file_during_writing");
+    ch.setFilePrefix("truncate");
     ch.enable();
     util::fs::RemoveFile(ch.currentFilename());
-    LogInfo("Hello");
-    std::this_thread::sleep_for(std::chrono::seconds(1));
-    EXPECT_TRUE(util::fs::IsFileExist(ch.currentFilename()));
+
+    std::string tmp(200, 'x');
+    LogInfo("%s", tmp.c_str());
+
     ch.cleanup();
+    LogSetMaxLength(origin_len);
 }
 
 #include <tbox/event/loop.h>
@@ -157,10 +144,10 @@ TEST(AsyncFileSink, Benchmark)
     function<void()> func = [&] {
         for (int i = 0; i < 100; ++i)
             LogInfo("%d %s", i, tmp.c_str());
-        sp_loop->run(func);
+        sp_loop->runNext(func);
         counter += 100;
     };
-    sp_loop->run(func);
+    sp_loop->runNext(func);
 
     sp_loop->exitLoop(chrono::seconds(10));
     sp_loop->runLoop();