通過 Systemd Journal 收集日志


隨着 systemd 成了主流的 init 系統,systemd 的功能也在不斷的增加,比如對系統日志的管理。Systemd 設計的日志系統好處多多,這里筆者就不再贅述了,本文筆者主要介紹 systemd journal 收集日志的三種方式:

  • 程序使用 libc 庫中的 syslog() 函數輸出的日志
  • 使用 printf() 函數打印的日志
  • 任何服務進程輸出到 STDOUT/STDERR 的所有內容

說明:本文的演示環境為 ubuntu 16.04。

syslog()

該函數的聲明如下:

#include <syslog.h>
void syslog(int priority, const char *message, ... /* argument */);

創建下面的 C 語言代碼,並保存到文件 clog.c 文件中:

#include <syslog.h>

int main(int argc, char *argv[]) {
        syslog(LOG_NOTICE, "C Hello World");
        return 0;
}

用下面的命令編譯程序:

$ gcc -Wall clog.c -o clog

然后執行編譯好的 clog 程序,就可以從 journal -f 的輸出中看到對應的日志:

這里筆者執行了三次 clog 程序,所以日志輸出了三遍。
代碼中的 LOG_NOTICE 代表日志的嚴重等級,我們可以使用下面定義好的等級:

#define    LOG_EMERG    0    /* system is unusable */
#define    LOG_ALERT    1    /* action must be taken immediately */
#define    LOG_CRIT    2    /* critical conditions */
#define    LOG_ERR        3    /* error conditions */
#define    LOG_WARNING    4    /* warning conditions */
#define    LOG_NOTICE    5    /* normal but significant condition */
#define    LOG_INFO    6    /* informational */
#define    LOG_DEBUG    7    /* debug-level messages */

下面嘗試在 python 代碼中做同樣的事情,把下面的代碼保存到文件 plog.py 中:

#!/usr/bin/evn python

import syslog
syslog.syslog('P Hello World')

然后執行下面的命令:

$ python plog.py

筆者同樣執行了三遍,這次輸出的是 python 代碼中的日志。

我們還可以通過 journalctl -o json-pretty -f 命令查看 json 格式的日志:

printf()

journal 可以捕獲服務進程往 STDOUT/STDERR 輸出的所有內容,比如 C 語言中 print 函數打印的內容,Python 中 print 打印的內容,以及 Shell 腳本中 echo 打印的內容等等都可以被 journal 捕獲到並加入到日志中。注意,只有以 service 的方式運行程序時,journal 才會捕獲 STDOUT/STDERR 輸出的內容。
創建下面的 C 語言代碼,並保存到文件 printlog.c 文件中:

#include <stdio.h>

int main(int argc, char *argv[]) {
    printf("C Print Hello World.\n");
    return 0;
}

用下面的命令編譯程序:

$ gcc -Wall printlog.c -o printlog

配置一個簡單的 service,先創建 一個配置文件  /lib/systemd/system/testlog.service,其內容如下:

[Unit]
Description=test log

[Service]
ExecStart=/home/nick/projects/journaldemo/printlog

[Install]
WantedBy=multi-user.target
$ sudo systemctl daemon-reload
$ sudo systemctl start testlog.service

Journal 會捕獲 STDOUT/STDERR 輸出的內容:

默認情況下,這樣輸出的日志等級為 LOG_INFO(6),我們可以通過 json 格式的日志看到日志等級信息:

我們還可以在打印日志時指定日志的等級,比如在每行打印的內容前加上"<N>",N為需要指定的日志等級。看下面的 C 語言示例:

#include<stdio.h>

#define PREFIX_NOTICE "<5>"

int main(void){
  printf(PREFIX_NOTICE "Hello World\n");
  fprintf(stderr, "<3>Hello  Error\n");

  return 0;
}

把上面的代碼編譯為 printlog 程序,再查看下日志,顯示的就是我們自己設置的日志等級:

在 Python 中的用法如下:

#!/usr/bin/env python
print '<5>Hello World'

在 bash 中的用法如下:

#!/bin/bash
echo "<5>Hello World"

Systemd 日志庫

Systemd 提供了原生的 C 語言庫(systemd/sd-journal.h) 用於向 journal 輸出日志(ubuntu 16.04 需要通過 sudo apt install libsystemd-dev 命令安裝 libsystemd-dev 包),相關函數的聲明為:

#include <systemd/sd-journal.h>
int sd_journal_print(int priority, const char *format, ...);
int sd_journal_send(const char *format, ...);

把下面的示例代碼會把日志發送給 journal:

#include <systemd/sd-journal.h>

int main(int argc, char *argv[]) {
        sd_journal_print(LOG_NOTICE, "Hello World");
        return 0;
}

相比上文使用 print() 或者 syslog() 提交的日志,使用 sd_journal_print 可以直觀的指定 LOG 等級、日志內容等等,另外輸出的日志會包含執行代碼的位置信息,例如執行到的函數,代碼文件位置,代碼具體行數,方便開發人員調試。

除了可以包含代碼信息,也可以向提交的日志中加入自定義段包含更多自定義信息,配合 journalctl 工具,可以更方便的過濾日志,如下面的代碼:

#include <systemd/sd-journal.h>
#include <unistd.h>
#include <stdlib.h>

int main(int argc, char *argv[]) {
        sd_journal_send("MESSAGE=Hello World!",
                        "MESSAGE_ID=52fb62f99e2c49d89cfbf9d6de5e3555",
                        "PRIORITY=5",
                        "HOME=%s", getenv("HOME"),
                        "TERM=%s", getenv("TERM"),
                        "PAGE_SIZE=%li", sysconf(_SC_PAGESIZE),
                        "N_CPUS=%li", sysconf(_SC_NPROCESSORS_ONLN),
                        NULL);
        return 0;
}

我們在日志中添加了自定義的字段,並且可以通過 journalctl 過濾這些字段。

除了 systemd 提供的一套C語言庫,目前其他個別語言也衍生了 systemd 的相關擴展,其中就包含了和 journald 相關的擴展。下面是段 python 的演示代碼:

from systemd import journal
journal.send('Hello world')
journal.send('Hello, again, world', FIELD2='Greetings!', FIELD3='Guten tag')

在運行上面的代碼前你需要先通過 pip 安裝 python 的 systemd 模塊(pip install systemd ),然后運行這段代碼,你就可以從日志中看到它輸出的信息了:

展開成 json 格式看下:

我們自定義的字段 FIELD2 和 FIELD3 也都輸出到日志中了。

總結

本文介紹了常見的一些往 systemd journal 中寫入日志的方式,了解這些日志的寫入方式可以幫助我們更好的設計應用的日志輸出,並有助於我們通過日志解決問題。

參考:
Systemd 日志管理相關
systemd for Developers III


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM