C++ `systemd` 与 `journald` 集成：服务管理与日志收集 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

哈喽，各位好！今天咱们来聊聊C++跟 systemd 和 journald 这对好基友的那些事儿。别害怕，虽然 systemd 听起来有点儿高大上，但其实用起来也没那么难，尤其是在C++的世界里。我们要讲的是如何让你的C++程序更好地融入Linux系统，让它能被 systemd 管理，并且把日志好好地交给 journald 集中管理。

为什么要跟 systemd 和 journald 玩？

想象一下，你写了一个很棒的C++服务，但是它老是崩溃，或者启动失败了你都不知道为啥。如果你手动管理它，那简直就是噩梦！幸好有 systemd，它可以帮你：

自动重启： 崩溃了？ systemd 帮你拉起来！
依赖管理： 确保你的服务在需要的依赖服务启动之后才启动。
资源限制： 限制CPU、内存，防止你的服务变成资源怪兽。
状态监控： 可以随时查看服务的状态，例如是否运行、运行了多长时间等。

而 journald 就像一个中央情报局，负责收集所有服务的日志。它可以帮你：

集中管理日志： 不用再满世界找日志文件了！
结构化日志： 日志不再是乱七八糟的文本，而是可以查询的结构化数据。
持久化存储： 日志可以持久化存储，方便你以后分析问题。
统一的时间戳： 所有日志都有统一的时间戳，方便你关联事件。

总而言之，跟 systemd 和 journald 集成，能让你的C++服务更可靠、更易管理、更易调试。

systemd 集成：让你的C++服务被“驯服”

systemd 通过 .service 文件来管理服务。这个文件描述了如何启动、停止、重启你的服务。

创建 .service 文件

首先，你需要创建一个 .service 文件，放在 /etc/systemd/system/ 目录下。文件名就是你的服务名，比如 my-awesome-service.service。
```
[Unit]
Description=My Awesome C++ Service
After=network.target  # 依赖网络服务启动

[Service]
ExecStart=/usr/local/bin/my-awesome-service  # 你的C++程序路径
Restart=on-failure  # 失败时重启
User=myuser  # 以哪个用户运行
Group=mygroup #以哪个用户组运行

[Install]
WantedBy=multi-user.target  # 开机启动
```
- [Unit] 部分描述了服务的元数据，例如描述和依赖关系。
- [Service] 部分描述了如何启动、停止和重启服务。
- [Install] 部分描述了如何启用服务。
让 systemd 知道你的服务

运行以下命令，让 systemd 重新加载配置文件：
```
sudo systemctl daemon-reload
```

启动、停止、重启你的服务

现在你可以使用 systemctl 命令来管理你的服务了：

sudo systemctl start my-awesome-service  # 启动服务
sudo systemctl stop my-awesome-service  # 停止服务
sudo systemctl restart my-awesome-service  # 重启服务
sudo systemctl status my-awesome-service  # 查看服务状态
sudo systemctl enable my-awesome-service  # 开机启动
sudo systemctl disable my-awesome-service #禁止开机启动

journald 集成：让你的C++服务“说话”

现在你的服务可以被 systemd 管理了，接下来我们要让它能跟 journald “说话”，也就是把日志交给 journald 统一管理。

使用 sd-journal 库

sd-journal 是 systemd 提供的一个 C API，可以用来写入日志到 journald。大部分Linux发行版都已经默认安装了systemd，你需要包含头文件 <systemd/sd-journal.h>，并链接 libsystemd 库。
- 安装 libsystemd (如果还没有安装):
  
  在Debian/Ubuntu上:
```
sudo apt-get update
sudo apt-get install libsystemd-dev
```
  在Fedora/CentOS/RHEL上:
```
sudo yum install systemd-devel
```

编写C++代码

下面是一个简单的例子，演示了如何使用 sd-journal 写入日志：

#include <iostream>
#include <systemd/sd-journal.h>

int main() {
   // 写入一条简单的日志
   sd_journal_send("MESSAGE=%s", "Hello, journald!",
                   "PRIORITY=%i", LOG_INFO,
                   NULL);

   // 写入一条带有结构化数据的日志
   sd_journal_send("MESSAGE=%s", "Temperature is too high!",
                   "PRIORITY=%i", LOG_WARNING,
                   "TEMPERATURE=%f", 90.5,
                   "LOCATION=%s", "Server Room",
                   NULL);

   std::cout << "Log message sent to journald." << std::endl;
   return 0;
}

sd_journal_send() 函数用于写入日志。
MESSAGE 是日志内容。
PRIORITY 是日志优先级（LOG_INFO、LOG_WARNING、LOG_ERROR 等）。
其他键值对可以用来添加结构化数据。

编译你的C++代码

编译时需要链接 libsystemd 库：
```
g++ your_program.cpp -o your_program -lsystemd
```
运行你的C++程序

运行你的程序，日志就会被写入到 journald。

查看日志

使用 journalctl 命令可以查看 journald 中的日志：

journalctl  # 查看所有日志
journalctl -u my-awesome-service  # 查看特定服务的日志
journalctl -p err  # 查看错误级别的日志
journalctl _PID=1234  # 查看特定进程的日志（假设进程ID是1234）
journalctl --since "2023-10-26 10:00:00" --until "2023-10-26 11:00:00" # 查看特定时间段的日志
journalctl -o json # 以json格式输出日志

更高级的用法

手动打开和关闭 journal:

有时候你可能需要手动打开和关闭journal连接，例如在长时间运行的服务中。

#include <iostream>
#include <systemd/sd-journal.h>

int main() {
   sd_journal *journal = nullptr;
   int ret = sd_journal_open(&journal, SD_JOURNAL_CURRENT);

   if (ret < 0) {
       std::cerr << "Failed to open journal: " << strerror(-ret) << std::endl;
       return 1;
   }

   // 写入日志
   ret = sd_journal_send("MESSAGE=%s", "Log message using journal object",
                         "PRIORITY=%i", LOG_INFO,
                         NULL);

   if (ret < 0) {
       std::cerr << "Failed to send journal entry: " << strerror(-ret) << std::endl;
   }

   // 关闭 journal
   sd_journal_close(journal);

   return 0;
}

使用 sd_journal_print() 函数

sd_journal_print() 是一个更方便的函数，可以像 printf() 一样格式化日志消息：
```
#include <systemd/sd-journal.h>

int main() {
   sd_journal_print(LOG_INFO, "The answer is %d", 42);
   return 0;
}
```

传递结构化数据

除了简单的键值对，你还可以传递更复杂的结构化数据。例如，你可以定义一个结构体，然后将结构体的内容写入日志：

#include <iostream>
#include <systemd/sd-journal.h>

struct MyData {
   int id;
   float value;
   char name[32];
};

int main() {
   MyData data = {123, 3.14, "My Object"};

   sd_journal_send("MESSAGE=%s", "My structured data",
                   "PRIORITY=%i", LOG_INFO,
                   "ID=%i", data.id,
                   "VALUE=%f", data.value,
                   "NAME=%s", data.name,
                   NULL);

   return 0;
}

设置日志字段

除了 MESSAGE 和 PRIORITY，你还可以设置其他日志字段，例如 SYSLOG_IDENTIFIER（服务名称）、CODE_FILE（代码文件）、CODE_LINE（代码行号）等。这可以帮助你更好地组织和过滤日志。

#include <systemd/sd-journal.h>

int main() {
   sd_journal_send("MESSAGE=%s", "Log message with custom fields",
                   "PRIORITY=%i", LOG_INFO,
                   "SYSLOG_IDENTIFIER=%s", "my-awesome-service",
                   "CODE_FILE=%s", __FILE__,
                   "CODE_LINE=%i", __LINE__,
                   NULL);

   return 0;
}

最佳实践

使用合适的日志级别： 根据日志的重要性选择合适的级别（LOG_DEBUG、LOG_INFO、LOG_WARNING、LOG_ERROR、LOG_CRIT、LOG_ALERT、LOG_EMERG）。
包含足够的信息： 日志应该包含足够的信息，方便你诊断问题。例如，可以包含时间戳、服务名称、进程ID、线程ID、文件名、行号等。
使用结构化数据： 尽量使用结构化数据，方便你查询和分析日志。
避免敏感信息： 不要将敏感信息（例如密码、密钥）写入日志。
定期清理日志： 定期清理 journald 中的日志，防止磁盘空间被占满。可以通过修改 /etc/systemd/journald.conf 文件来配置日志的保留策略。

一些常见问题

为什么我的日志没有显示出来？
- 检查你的 .service 文件是否正确配置。
- 检查你的 C++ 代码是否正确使用了 sd-journal 库。
- 检查 journald 是否正在运行 (systemctl status systemd-journald)。
- 检查你的用户是否有权限写入 journald。
如何过滤特定用户的日志？

你可以使用 journalctl _UID=1000 来过滤用户ID为1000的日志。
如何将日志发送到远程服务器？

你可以使用 systemd-journal-upload 命令将日志上传到远程服务器。

总结

systemd 和 journald 是Linux系统中非常强大的工具，可以帮助你更好地管理和监控你的C++服务。通过与它们集成，你可以让你的服务更可靠、更易管理、更易调试。希望今天的讲解能够帮助你更好地理解和使用 systemd 和 journald。

表格：systemd 和 journald 常用命令对比

命令	描述
`systemctl`	管理 `systemd` 服务的命令
`journalctl`	查看和管理 `journald` 日志的命令

表格：sd-journal 常用函数

函数	描述
`sd_journal_send()`	发送一条日志消息
`sd_journal_print()`	使用 `printf` 风格的格式化字符串发送日志消息
`sd_journal_open()`	打开一个 journal 连接
`sd_journal_close()`	关闭一个 journal 连接

希望这些内容对你有所帮助！

发表回复 取消回复

发表回复取消回复