MxLog

简介

MxLog是一个基于C++的轻量级日志库

同时包含了C++接口和Python接口

实现了多种级别的不同日志输出，支持不同颜色打印，支持异步输出

日志等级分为

• Debug
• Info
• Warning
• Error
• Fatal
• SystemLevel

特性说明

• 支持多线程日志(文件+控制台)输出
• 支持异步日志输出
• 当日志类析构的时候，它会自动将缓冲区中的日志输出到控制台，避免丢失。

使用建议

• 请根据实际的日志大小来决定使用的缓冲区大小，过小或者过大的缓冲区都会导致日志输出的效率降低
• 如果需要及时看到所有输入，请调用接口cmx::clearConsoleBuffer()
• 由于日志库采用单独的线程运作，它是可以和std::cout同时进行输出的。

使用方法

#include <LogManager.hpp>
#include <LogLevel.hpp>

int main() {
    // 设置文件日志记录器
    cmx::logManager.setFileAppender("log.txt");
    // 设置控制台日志记录器
    cmx::logManager.setConsoleAppender();
    std::string message = "It's Cmx's LOG SYSTEM!";
    cmx::logManager.log(message, cmx::Log::LogLevel::Info);

    // 更多测试消息
    std::string testMessages[] = {
            "This is a Debug message",
    };

    for (const auto& msg : testMessages) {
        cmx::logManager.log(msg, cmx::LogLevel::Debug);
        cmx::logManager.log(msg, cmx::LogLevel::Info);
        cmx::logManager.log(msg, cmx::LogLevel::Warning);
        cmx::logManager.log(msg, cmx::LogLevel::Error);
        cmx::logManager.log(msg, cmx::LogLevel::Fatal);
    }

    return 0;
}

测试案例

#include <LogLevel.hpp>
#include <LogManager.hpp>
#include <chrono>
#include <thread>
#include <iostream>


void benchmarkTest() {
    cmx::logger.log("LogManager Init");
    cmx::logger.log("BenchMarkTest Start", LogLevel::Info);
    cmx::logger.setFileAppender("BenchMarkTest.txt");
    cmx::logger.setConsoleAppender();

    constexpr size_t test_epoch = 1000000;

    auto start = std::chrono::high_resolution_clock::now();
    cmx::logger.log("Benchmark test");
    cmx::logger.setBufferSize(test_epoch / 10);
    cmx::logger.setOutBufferSize(test_epoch / 10);

    cmx::logger.setCurrentLevel(LogLevel::Info);
    for (int i = 0; i < test_epoch; i++) {
        cmx::logger.log("Benchmark test");
    }

    cmx::logger.log("End of Benchmark test");
    auto stop = std::chrono::high_resolution_clock::now();
    auto duration = std::chrono::duration_cast<std::chrono::milliseconds>(stop - start).count();
    auto time1 = std::to_string(duration);


    start = std::chrono::high_resolution_clock::now();
    for (int i = 0; i < test_epoch; i++) {
        std::cout << "Benchmark test" << i << "\n";
        if (i % 100 == 0) {
            std::cout.flush();
        }
    }
    std::cout << std::endl;
    stop = std::chrono::high_resolution_clock::now();
    duration = std::chrono::duration_cast<std::chrono::milliseconds>(stop - start).count();
    cmx::logger.log("std::cout test took " + std::to_string(duration) + " milliseconds with " + std::to_string(test_epoch) + " logs");

    cmx::logger.log("Benchmark test took " + time1 + " milliseconds with " + std::to_string(test_epoch) + " logs");
}

void manualTest() {
    cmx::logger.setCurrentLevel(LogLevel::Info);
    cmx::logger.log("manualTest");

    cmx::logger.setFileAppender("logAuto.txt");
    cmx::logger.setConsoleAppender();
    cmx::logger.setCurrentLevel(LogLevel::Debug);
    std::string message = "Debug message";
    cmx::logger.log(message);
    cmx::logger.setCurrentLevel(LogLevel::Error);
    cmx::logger.log("Error message");
    cmx::logger.setCurrentLevel(LogLevel::Fatal);
    cmx::logger.log("Fatal message");
    cmx::logger.setCurrentLevel(LogLevel::Info);
    cmx::logger.log("Info message");
    cmx::logger.setCurrentLevel(LogLevel::Warning);
    cmx::logger.log("Warning message");
}

// 手动版本
void autoTest() {
    // 设置文件日志记录器
    cmx::logger.setFileAppender("log.txt");
    // 设置控制台日志记录器
    cmx::logger.setConsoleAppender();
    std::string message = "AUTO TEST";
    cmx::logger.log(message, LogLevel::Info);

    // 更多测试消息
    std::string testMessages[] = {
        "This is a Debug message",
    };

    for (const auto &msg : testMessages) {
        cmx::logger.log(msg, LogLevel::Debug);
        cmx::logger.log(msg, LogLevel::Info);
        cmx::logger.log(msg, LogLevel::Warning);
        cmx::logger.log(msg, LogLevel::Error);
        cmx::logger.log(msg, LogLevel::Fatal);
    }
}

int main() {
    autoTest();
    cmx::logger.setOutBufferSize(10);
    cmx::logger.setBufferSize(10);
    cmx::logger.setCurrentLevel(LogLevel::LogSystem);
    cmx::logger.log("End of Autotest\t\t\n ************************************************");
    manualTest();
    cmx::logger.log("End of Manual test\t\t\n ************************************************");
    benchmarkTest();
}

构建案例

• 假设你在Libtorch与QT环境下编译，引入mxLog

cmake_minimum_required(VERSION 3.5 FATAL_ERROR)
project(custom_ops)

# 设置 CMAKE_PREFIX_PATH
set(CMAKE_PREFIX_PATH "D:/MyLibs/libtorch-win-shared-with-deps-2.5.0+cu124/libtorch")
find_package(Torch REQUIRED)

# 设置 C++17 标准
set(CMAKE_CXX_STANDARD 17)

# 设置 mxLogLib 的路径
set(MXLOGLIB_LIB_PATH "D:/study/libTorchProject/lib")

# 添加可执行文件
add_executable(main src/simpleModel.cpp)

#设置QT6路径D:\QT_6\6.8.0\msvc2022_64
set(QT_DIR "D:/QT_6/6.8.0/msvc2022_64")
find_package(Qt6 COMPONENTS Core Charts REQUIRED)

# 包含 mxLogLib 和 Qt 的头文件路径
target_include_directories(main PRIVATE include)

# 链接 libtorch 库
target_link_libraries(main PRIVATE "${TORCH_LIBRARIES}")

# 链接 mxLogLib 库
target_link_libraries(main PRIVATE ${MXLOGLIB_LIB_PATH}/mxLogLib.lib)

target_link_libraries(main PRIVATE Qt6::Core Qt6::Charts)


# 查找 lib 文件夹下的所有 .dll 文件
file(GLOB_RECURSE DLL_FILES "${CMAKE_PREFIX_PATH}/lib/*.dll")
file(GLOB MXLOGLIB_DLL_FILES "${MXLOGLIB_LIB_PATH}/*.dll")

# 将找到的 .dll 文件复制到构建目录
foreach(DLL_FILE IN LISTS DLL_FILES MXLOGLIB_DLL_FILES)
    get_filename_component(DLL_NAME ${DLL_FILE} NAME)
    add_custom_command(TARGET main POST_BUILD
            COMMAND ${CMAKE_COMMAND} -E copy_if_different
            ${DLL_FILE}
            $<TARGET_FILE_DIR:main>
    )
endforeach()

# 手动 install dll 到安装目录
install(TARGETS main DESTINATION bin)
install(FILES ${DLL_FILES} ${MXLOGLIB_DLL_FILES} DESTINATION bin)

python接口

编译方式

   cd mxLog_Py
   python setup.py build_ext --inplace
   python setup.py install