基于Yocto和Buildroot平台的Syslog 配置

2. Syslog简介

2.1. 简介
在Unix类操作系统上，syslog广泛应用于系统日志，负责记录内核和应用程序产生的日志信息。syslog日志消息既可以记录在本地文件中，也可以通过网络发送到接收syslog的服务器。接收syslog的服务器可以对多个设备的syslog消息进行统一的存储，或者解析其中的内容做相应的处理。常见的应用场景是网络管理工具、安全管理系统、日志审计系统。
2.2. 日志格式
规定syslog消息的UDP报文不能超过1024字节，并且全部由可打印的字符组成。完整的syslog消息由3部分组成，分别是PRI、HEADER和MSG。大部分syslog都包含PRI和MSG部分，而HEADER可能没有。
如下是一条syslog消息：

<31>Jun 12 19:50:07 zsir syslog_test[3910]: debug-level message.
<31>是PRI部分，其中高5位为Facility，低3位为Severity；
Jun 12 19:50:07 zsir是HEADER部分；
syslog_test[3910]: debug-level message.是MSG部分；

3. Syslog的配置和使用

3.1. 基于yocto平台的syslog使用
3.1.1. 确认系统内有syslog服务
首先我们需要先确认我们的开发板上是否安装了syslog服务，在开发板的文件系统下输入syslogd help命令查看如果不支持就是busybox的版本太低了。

3.1.2. Syslog.conf
对于不同类型的Unix，标准UnixLog系统的设置，实际上除了一些关键词的不同，系统的syslog.conf格式是相同的。syslog采用可配置的、统一的系统登记程序，随时从系统各处接受log请求，然后根据/etc/syslog.conf中的预先设定把log信息写入相应文件中、邮寄给特 定用户或者直接以消息的方式发往控制台。值得注意的是，为了防止入侵者修改、删除messages里的记录信息，可以采用用打印机记录或采用方式来挫败入 侵者的企图。
格式如下所示：

类型facility：
保留字段中的“类型”代表信息产生的源头，可以是：

	auth    认证系统，即询问用户名和口令
    cron    系统定时系统执行定时任务时发出的信息
    daemon  某些系统的守护程序的syslog,如由in.ftpd产生的log
    kern    内核的syslog信息
    lpr     打印机的syslog信息
    mail    邮件系统的syslog信息
    mark    定时发送消息的时标程序
    news    新闻系统的syslog信息
    user    本地用户应用程序的syslog信息
    uucp    uucp子系统的syslog信息
    local0..7 种本地类型的syslog信息,这些信息可以又用户来定义
    \*       代表以上各种设备

级别priority：
保留字段中的“级别”代表信息的重要性，可以是：

	emerg   紧急，处于Panic状态。通常应广播到所有用户； 
	   alert   告警，当前状态必须立即进行纠正。例如，系统数据库崩溃； 
	   crit    关键状态的警告。例如，硬件故障； 
	   err     其它错误； 
	   warning 警告； 
	   notice  注意；非错误状态的报告，但应特别处理； 
	   info    通报信息； 
	   debug   调试程序时的信息； 
	   none    通常调试程序时用，指示带有none级别的类型产生的信息无需送出。如*.debug;mail.none表示调试时除邮件信息外其它信息都送出。

动作action：

“动作”域指示信息发送的目的地。可以是：
    /filename   日志文件。由绝对路径指出的文件名； 
    @host       远程主机； @符号后面可以是ip,也可以是域名，默认在/etc/hosts文件下loghost这个别名已经指定给了本机。
    user1,user2 指定用户。如果指定用户已登录，那么他们将收到信息； 
*           所有用户。所有已登录的用户都将收到信息

Syslog.conf示例：

3.1.3. Syslog编程

openlog函数会分配并打开一个文件描述符，并通过它来写日志。你可以使用closelog函数来关闭它。syslog（）函数主要的是第一个参数priority，后面那些参数就是和printf( )函数用法一样了。
option：用于openlog()的option参数可以是以下几个的组合:

•	LOG_CONS : 如果送到system logger时发生问题，直接写入系统console。
•	LOG_NDELAY : 立即开启连接(通常，连接是在第一次写入讯息时才打开的)。
•	LOG_PERROR : 将讯息也同时送到stderr
•	LOG_PID : 将PID含入所有讯息中

facility：该参数用来指定何种程式在记录讯息，这可让设定档来设定何种讯息如何处理。

•	LOG_AUTH : 安全/授权讯息(别用这个，请改用LOG_AUTHPRIV)
•	LOG_AUTHPRIV : 安全/授权讯息
•	LOG_CRON : 时间守护神专用(cron及at)
•	LOG_DAEMON : 其它系统守护神
•	LOG_KERN : 核心讯息
•	LOG_LOCAL0到LOG_LOCAL7 : 保留
•	LOG_LPR : line printer次系统
•	LOG_MAIL : mail次系统
•	LOG_NEWS : USENET news次系统
•	LOG_SYSLOG : syslogd内部所产生的讯息
•	LOG_USER(default) : 一般使用者等级讯息
•	LOG_UUCP : UUCP次系统

priority：决定讯息的重要性. 以下的等级重要性逐次递减:

•	LOG_EMERG : 系统无法使用
•	LOG_ALERT : 必须要立即采取反应行动
•	LOG_CRIT : 重要状况发生
•	LOG_ERR : 错误状况发生
•	LOG_WARNING : 警告状况发生
•	LOG_NOTICE : 一般状况，但也是重要状况
•	LOG_INFO : 资讯讯息
•	LOG_DEBUG : 调试讯息

3.1.4. 配置syslogd
我们根据syslogd help显示的默认配置文件来查看该配置文件是否存在，如果不存在我们需要创建一个配置文件如：touch /etc/syslog.conf，同时使用syslogd -f /etc/syslog.conf来进行绑定。
1）我们的部分syslog.conf配置如kern.*和user.*已在本地设定，在编译前的yocto配置文件为yocto/meta-asr-ipc/recipes-core/busybox/busybox_%.bbappend，

配置编辑文件，例如增加"local5.*" /var/log/my.log"

也可以在syslog.conf里直接进行编辑,文件目录为/home/sunhelong/work/yocto/poky/meta/recipes-core/busybox/files/syslog.conf
如

重新编译后烧写到开发板。
2）如果开发板系统已经启动，还想保存日志到指定目录，可在开发板系统目录下更改/etc/syslog.conf进行配置，重启客户端syslogd使设置生效。但下次重新烧写系统时配置会失效。
例 local5.* /var/log/my.log

3.1.5. 测试syslog
重新启动syslog：/etc/init.d/syslog restart

运行编译好的程序
查看/var/log/my.log

3.1.6. Syslog测试代码

#include
#include
#include 

void Info(void)
{
	openlog("info",LOG_PID,LOG_LOCAL5);// LOG_LOCAL5表示信息类型
	syslog(LOG_INFO, "hello %s","woring");//LOG_INFO表示优先级
}

void Woring(void)
{
	openlog("woring",LOG_PID,LOG_LOCAL5);
	syslog(LOG_WARNING, "hello %s","test");
}

int main()
{
	Info();
	Woring();
	closelog();
	return 0;
}

3.2. 基于buildroot平台的syslog使用
3.2.1. 确认系统已安装syslogd
首先我们需要先确认我们的开发板上是否安装了syslog服务，在开发板的文件系统下输入syslogd help命令查看如果不支持就是busybox的版本太低了，如图出现this version of syslogd ignores /etc/syslog.conf就是这个版本的syslogd不支持/etc/syslog.conf,需要重新构建一个支持/etc/syslog.conf的linux系统。

3.2.2. 配置busybox使其支持syslog.conf
在buildroot目录下运行make busybox-mencuconfig命令进行配置

选择保存后，在buildroot目录下运行make busybox-update-config进行配置更新。

3.2.3. Syslog.conf格式
如下所示：
类型facility：
保留字段中的“类型”代表信息产生的源头，可以是：

	auth    认证系统，即询问用户名和口令
	cron    系统定时系统执行定时任务时发出的信息
	daemon  某些系统的守护程序的syslog,如由in.ftpd产生的log
	kern    内核的syslog信息
	lpr     打印机的syslog信息
	mail    邮件系统的syslog信息
	mark    定时发送消息的时标程序
	news    新闻系统的syslog信息
	user    本地用户应用程序的syslog信息
	uucp    uucp子系统的syslog信息
	local0..7 种本地类型的syslog信息,这些信息可以又用户来定义
	\*       代表以上各种设备

级别priority：
保留字段中的“级别”代表信息的重要性，可以是：

	emerg   紧急，处于Panic状态。通常应广播到所有用户； 
	alert   告警，当前状态必须立即进行纠正。例如，系统数据库崩溃； 
	crit    关键状态的警告。例如，硬件故障； 
	err     其它错误； 
	warning 警告； 
	notice  注意；非错误状态的报告，但应特别处理； 
	info    通报信息； 
	debug   调试程序时的信息； 
	none    通常调试程序时用，指示带有none级别的类型产生的信息无需送出。如*.debug;mail.none表示调试时除邮件信息外其它信息都送出。

动作action：
“动作”域指示信息发送的目的地。可以是：

    /filename   日志文件。由绝对路径指出的文件名，此文件必须事先建立； 
    @host       远程主机； @符号后面可以是ip,也可以是域名，默认在/etc/hosts文件下loghost这个别名已经指定给了本机。
    user1,user2 指定用户。如果指定用户已登录，那么他们将收到信息； 
*           所有用户。所有已登录的用户都将收到信息。

3.2.4. Syslog编程

openlog函数会分配并打开一个文件描述符，并通过它来写日志。你可以使用closelog函数来关闭它。syslog（）函数主要的是第一个参数priority，后面那些参数就是和printf( )函数用法一样了。
option：用于openlog()的option参数可以是以下几个的组合:

•	LOG_CONS : 如果送到system logger时发生问题，直接写入系统console。
•	LOG_NDELAY : 立即开启连接(通常，连接是在第一次写入讯息时才打开的)。
•	LOG_PERROR : 将讯息也同时送到stderr
•	LOG_PID : 将PID含入所有讯息中

facility：该参数用来指定何种程式在记录讯息，这可让设定档来设定何种讯息如何处理。

•	LOG_AUTH : 安全/授权讯息(别用这个，请改用LOG_AUTHPRIV)
•	LOG_AUTHPRIV : 安全/授权讯息
•	LOG_CRON : 时间守护神专用(cron及at)
•	LOG_DAEMON : 其它系统守护神
•	LOG_KERN : 核心讯息
•	LOG_LOCAL0到LOG_LOCAL7 : 保留
•	LOG_LPR : line printer次系统
•	LOG_MAIL : mail次系统
•	LOG_NEWS : USENET news次系统
•	LOG_SYSLOG : syslogd内部所产生的讯息
•	LOG_USER(default) : 一般使用者等级讯息
•	LOG_UUCP : UUCP次系统

priority：决定讯息的重要性. 以下的等级重要性逐次递减:

•	LOG_EMERG : 系统无法使用
•	LOG_ALERT : 必须要立即采取反应行动
•	LOG_CRIT : 重要状况发生
•	LOG_ERR : 错误状况发生
•	LOG_WARNING : 警告状况发生
•	LOG_NOTICE : 一般状况，但也是重要状况
•	LOG_INFO : 资讯讯息
•	LOG_DEBUG : 除错讯息

3.2.5. 配置syslog.conf
1）在package/busybox目录下创建syslog.conf文件

2）然后在syslog.conf中写入消息处理配置文档，示例如下：

3）然后在busybox.mk添加如下代码，将syslog.conf增加到根文件系统。

4）在buildroot目录下进行重新编译：
make busybox-dirclean && make -j4

5）烧写到fpga，进行测试
可以看到此时的syslogd已经支持/etc/syslog.conf

而且根文件目录已经有Syslog.conf文件

运行测试代码后发现已经生成kernel.log和local0.log文件

6）如果开发板系统已经启动，还想保存日志到指定目录，可在开发板系统目录下更改/etc/syslog.conf进行配置，重启客户端syslogd使设置生效。
3.2.6. Syslog测试代码

#include 
#include 

int main(int argc, char **argv)
{
    openlog("MyMsgMARK", LOG_CONS | LOG_PID, LOG_LOCAL0);
    syslog(LOG_EMERG,  "This is a syslog test message generated by program '%s'/n",  argv[0]);
    openlog("logtest", LOG_CONS | LOG_PID, LOG_USER);
    syslog(LOG_INFO,  "PID information, pid=%d\n",  getpid());
    closelog();
    return 0;
}