Python syslog 浅谈

最近在写一些命令行守护程序,类似于 Linux 下的一些常运行的程序,除了用到一些常见的IO 以及进程间通信的内容之外,还尝试了一下 Unix 系列的 syslog,在尝试过程中,发现 Python 已经在 logging 模块中很方便得集成了 syslog 的功能,很是方便;但同时,Python 的内置库中也提供了 syslog 的支持,所以,我就对这两种方式都进行一个介绍和总结。

syslog

开始之前想说说什么是 syslog,在 Linux 中,有很多后台程序都是以后台进程的形式存在运行,例如 crontab/sshd/nginx 等,有些是系统的,有些是我们自己添加的,但是,他们都有一些相同的特点:

  1. 我们不能直接从标准输入给他们输入,也不能直接从标准输出获得他们的输出
  2. 他们通常在固定的位置有日志可以查看,这个位置通常在 /var/log
  3. ... ...

对于其中的第 2 个特点,大部分 Linux 后台进程都通过 syslog 来实现。因为服务器中很多进程的调试和维护都需要一个稳定专业的日志系统,因此,Linux 提供了一个守护进程专门用来处理系统日志,而这个守护进程就是 syslogd,不过,现在的系统大都使用 rsyslod(syslog 升级版) 代替。例如以下是我在一台 Ubuntu16 的机器上的 syslogd 进程:

有一点值得一提的是,无论是内核还是用户态,都可以使用 syslog,只不过他们的路径不一样

  • 用户态:我们调用 syslog 生成日子,然后这个函数将日志输出到一个 UNIX域套接字类型的文件 /dev/log 中,然后 rsyslogd 监听这个文件来获取日志
  • 内核态[2]:内核日志通过调用 printk 等函数打印到内核的环状缓存中,然后这个缓存的内容和文件 /proc/kmsg 是直接映射的,所以 rsyslogd 就可以直接读取这个文件获得日志了

syslog 日志的位置

rsyslogd 在接收到日志之后,需要将日志输出到特定的日志文件中,默认情况下

  • 调试信息会保存到 /var/log/debug 文件中
  • 普通信息会保存到 /var/log/messages 文件中
  • 内核消息会保存到 /var/log/kern.log 文件中

但是这些都是可以改变的,在我的系统中,配置文件的位置是 /etc/rsyslog.conf,因为我没准备修改这些配置,所以就没有研究配置信息,有需要可以参考资料[3]

内置 syslog 库

在 Python 中,直接就有内置的函数库可以使用 syslog,一段很简单的代码如下:

就可以在 /var/log/syslog 中看到这个内容了:

我们还可以加上日志级别

然而,我们会发现,这些日志有些简单,例如我们不知道是哪个进程打出来的,这个时候,还有一个函数值得我们一试,那就是 openlog

然后再看看我们的日志输出:

可以看到,这些设置都不是那么好用,毕竟是比较底层的接口,所以我们来尝试一下高层一点的。

与 logging 模块结合

我们查阅一下 Python 文档中的 logging 模块的文档,可以发现又一个 handler 叫做:SysLogHandler,看一下参数,并不比 syslog 的原始函数简单,但是,我们可以忽略所有这些参数,而简单得控制日志输出:

class logging.handlers.SysLogHandler(address=(‘localhost’, SYSLOG_UDP_PORT), facility=LOG_USER, socktype=socket.SOCK_DGRAM)
  • address: 前面说了 rsyslog 是一个套接字,这里可以制定套接字的地址,注意:这个可以是不在同一台机器
  • facility:这个参数的作用是告诉 rsyslog 日志的类型,从而可以让他根据不同的类型执行不同的操作
  • socktype:这个不用多解释了

所以使用的话就和其他的 Handler 一致,简单得记一下:

这里的 address 用的是 /dev/log,因为我查看了一下我机器上是没有开放 514 端口的,查了一下资料[5]发现:/dev/log 是一个 Unix 套接字,而我机器上并不开放所有机器可用的日志服务,所以使用 /dev/log 就好了。

Reference

  1. What is the difference between syslog, rsyslog and syslog-ng?
  2. Kernel logging: APIs and implementation
  3. Rsyslogd Configuration
  4. python syslog handler codes
  5. Understand logging in Linux
  6. Linux高性能服务器编程

· EOF ·

最近爬虫很是凶猛,标注下文章的原文地址: https://liuliqiang.info/post/syslog-in-python/