Linux C++程序如何日志记录

在Linux环境下使用C++进行日志记录，有多种方法和库可供选择。以下介绍几种常用的方法，并提供相应的示例代码，帮助你在C++程序中实现日志功能。

1. 使用标准I/O函数（如printf, fprintf）

这是最基础的方法，利用C++的标准输入输出函数将日志信息写入文件或控制台。

示例代码

#include <cstdio>
#include <ctime>

void log_message(const char* filename, const char* message) {
    FILE* file = fopen(filename, "a"); // 以追加模式打开文件
    if (file == nullptr) {
        perror("Failed to open log file");
        return;
    }

    time_t now = time(nullptr);
    char timestamp[20];
    strftime(timestamp, sizeof(timestamp), "%Y-%m-%d %H:%M:%S", localtime(&now));

    fprintf(file, "[%s] %s\n", timestamp, message);
    fclose(file);
}

int main() {
    log_message("app.log", "程序启动");
    // 程序逻辑
    log_message("app.log", "程序结束");
    return 0;
}

优点

• 简单易用，无需额外依赖。

缺点

• 功能有限，缺乏日志级别、多线程支持等高级特性。
• 需要手动管理日志文件的打开和关闭。

2. 使用第三方日志库

为了实现更强大的日志功能，推荐使用成熟的第三方日志库。以下介绍几个流行的C++日志库：

a. spdlog

spdlog 是一个非常快速且功能丰富的C++日志库，支持异步日志记录、多种日志格式和目标（控制台、文件、日志轮转等）。

安装

可以通过包管理器安装（如vcpkg），或者从GitHub克隆并编译：

git clone https://github.com/gabime/spdlog.git
cd spdlog
mkdir build && cd build
cmake ..
make -j$(nproc)
sudo make install

示例代码

#include "spdlog/spdlog.h"
#include "spdlog/sinks/stdout_color_sinks.h"
#include "spdlog/sinks/basic_file_sink.h"

int main() {
    // 创建控制台日志记录器，设置日志级别为info，并使用彩色输出
    auto console = spdlog::stdout_color_mt("console");
    console->set_level(spdlog::level::info);

    // 创建文件日志记录器，设置日志级别为debug，并启用日志轮转（每天一个文件）
    auto file = spdlog::basic_logger_mt("file_logger", "logs/app.log");
    file->set_level(spdlog::level::debug);
    file->set_pattern("[%Y-%m-%d %H:%M:%S] [%l] %v");

    // 设置默认日志记录器
    spdlog::set_default_logger(file);

    SPDLOG_INFO("程序启动");
    // 程序逻辑
    SPDLOG_DEBUG("调试信息");
    SPDLOG_ERROR("错误信息");

    // 可以同时使用多个日志记录器
    console->info("这是控制台的信息");

    return 0;
}

优点

• 高性能，支持异步日志。
• 支持多种日志格式和目标。
• 易于集成和使用。

b. log4cpp

log4cpp 是另一个流行的C++日志库，受Java的Log4j启发，功能丰富，但相对较老，社区活跃度不如spdlog。

安装

可以通过包管理器安装（如apt）：

sudo apt-get install liblog4cpp5-dev

示例代码

#include <log4cpp/Category.hh>
#include <log4cpp/FileAppender.hh>
#include <log4cpp/OstreamAppender.hh>
#include <log4cpp/BasicLayout.hh>

int main() {
    // 创建布局
    log4cpp::BasicLayout* layout = new log4cpp::BasicLayout();
    
    // 创建文件追加器，并设置布局
    log4cpp::FileAppender* fileAppender = new log4cpp::FileAppender("fileAppender", "app.log");
    fileAppender->setLayout(layout);
    
    // 创建控制台追加器，并设置布局
    log4cpp::OstreamAppender* consoleAppender = new log4cpp::OstreamAppender("consoleAppender", &std::cout);
    consoleAppender->setLayout(layout);
    
    // 创建类别并添加追加器
    log4cpp::Category& root = log4cpp::Category::getRoot();
    root.addAppender(fileAppender);
    root.addAppender(consoleAppender);
    
    // 设置日志级别
    root.setPriority(log4cpp::Priority::INFO);
    
    root.info("程序启动");
    // 程序逻辑
    root.error("错误信息");
    
    // 清理资源
    delete layout;
    delete fileAppender;
    delete consoleAppender;
    
    return 0;
}

优点

• 功能全面，支持多种日志级别、格式和输出目标。
• 社区支持较好，文档齐全。

缺点

• 相较于spdlog，性能较低。
• 更新不如spdlog频繁。

c. Boost.Log

Boost.Log 是Boost库的一部分，功能强大，适合需要高度定制化日志系统的应用。

安装

需要安装Boost库，具体方法取决于你的Linux发行版。例如，在Ubuntu上：

sudo apt-get install libboost-all-dev

示例代码

#include <boost/log/trivial.hpp>
#include <boost/log/utility/setup/file.hpp>
#include <boost/log/utility/setup/console.hpp>
#include <boost/log/sources/severity_logger.hpp>
#include <boost/log/sources/record_ostream.hpp>

namespace logging = boost::log;
namespace src = boost::log::sources;
namespace sinks = boost::log::sinks;

void init_logging() {
    // 设置日志格式
    logging::add_console_log(
        std::cout,
        logging::keywords::format = "%TimeStamp%: %Severity%: %Message%"
    );

    // 设置文件日志
    typedef sinks::text_file_backend<> file_backend;
    file_backend::rotation_size rotation_size(10 * 1024 * 1024); // 10MB
    file_backend::time_based_rotation sink_file_backend(
        sinks::file::rotation_at_time_point(0, 0, 0),
        rotation_size
    );
    typedef sinks::synchronous_sink<file_backend> sink_file;
    sink_file sink;
    sink.set_backend(sink_file_backend);
    sink.set_filter(logging::trivial::severity >= logging::trivial::info);
    logging::add_sink(sink);
}

int main() {
    init_logging();

    BOOST_LOG_TRIVIAL(info) << "程序启动";
    // 程序逻辑
    BOOST_LOG_TRIVIAL(error) << "错误信息";

    return 0;
}

优点

• 高度可定制，支持复杂的日志处理流程。
• 与Boost生态系统集成良好。

缺点

• 学习曲线较陡，配置相对复杂。
• 依赖Boost库，增加了项目的依赖性。

3. 使用系统日志（Syslog）

对于需要将日志发送到系统日志的应用，可以使用C++调用系统日志接口，如syslog或systemd-cat。

示例代码（使用syslog）

#include <syslog.h>

int main() {
    // 打开日志连接，标识为"myapp"，日志选项为LOG_PID
    openlog("myapp", LOG_PID | LOG_CONS, LOG_USER);

    syslog(LOG_INFO, "程序启动");
    // 程序逻辑
    syslog(LOG_ERR, "错误信息");

    closelog();
    return 0;
}

优点

• 日志直接发送到系统日志，便于集中管理和监控。
• 适用于需要与系统日志集成的应用。

缺点

• 功能相对有限，无法实现复杂的日志格式和多目标输出。
• 需要处理系统日志的权限和配置。

4. 使用日志轮转（Log Rotation）

对于长期运行的应用，日志文件可能会变得非常大，因此需要实现日志轮转，定期分割和压缩旧日志文件。许多日志库（如spdlog、log4cpp）内置了对日志轮转的支持。

示例（使用spdlog的日志轮转）

#include "spdlog/spdlog.h"
#include "spdlog/sinks/rotating_file_sink.h"

int main() {
    // 创建一个支持日志轮转的文件记录器，最大10MB，保留3个备份
    auto rotating_file = spdlog::rotating_logger_mt("rotating_file", "logs/app.log", 10*1024*1024, 3);
    rotating_file->set_level(spdlog::level::debug);
    rotating_file->set_pattern("[%Y-%m-%d %H:%M:%S] [%l] %v");

    spdlog::set_default_logger(rotating_file);

    for(int i=0; i<100000; ++i){
        SPDLOG_DEBUG("调试信息 {}", i);
    }

    return 0;
}

总结

在Linux环境下使用C++进行日志记录，可以根据项目需求选择合适的方法：

• 简单项目：使用标准I/O函数。
• 需要高性能和丰富功能：推荐使用spdlog等第三方日志库。
• 需要与系统日志集成：使用系统日志接口（如syslog）。
• 高度定制化需求：考虑使用Boost.Log。

通过合理选择和使用日志库，可以有效提升程序的可维护性和调试效率。