python的日志模块logging和syslog

 　　syslog模块是在unix环境下工作的模块，不能用于windows,在windows环境下可以使用logging模块。

　　一、syslog

　　syslog模块可以用于记录系统运行的信息，这个模块提供的方法有，syslog(priority,message),它将message送入系统日志，priority的默认选项为LOG_INFO，openlog([ident[,logoption[,facility]]])，它用于打开日志，ident会被加到每条日志，logoption是日志选项，facility是可选工具参数。closelog()用于关闭日志。

        日志优先级priority从高到低的顺序是：LOG_EMERG, LOG_ALERT, LOG_CRIT, LOG_ERR, LOG_WARNING, LOG_NOTICE,LOG_INFO, LOG_DEBUG,

        默认情况下是LOG_INFO。

        syslog日志选项有LOG_CONS，LOG_NDELAY，LOG_NOWAIT，LOG_PID，LOG_PERROR。

        facility的选项有LOG_AUTH，LOG_CRON，LOG_DAEMON，LOG_KERN，LOG_LOCALx,LOG_MAIL,LOG_NEWS,LOG_USER,LOG_UUCP.

#!/usr/bin/env python
import syslog,sys,os
sys.openlog():
    syslog.openlog("%s[%d]") % (os.path.basename(sys.argv[0],os.getpid()),0,syslog.LOG_DAEMON)
    syslog.syslog("Stared")
try:
    raise RuntimeError,e:
except:
    type,exception,trace=sys.exc_info()
    excclass=str(exception.__class__)
    message=str(exception)
    syslog.syslog(syslog.ERROR,"%s:%s" %( excclass,message))

Openlog,syslog这两个函数并且结合syslog.conf的配置，就能定制出一种很好的日志记录功能。通过openlog的函数，我们就可以将信息分门别类的记录到何种文件下

并采取syslog函数参数便可以将何种服务的级别记录到何种文件下，前提需要syslog.conf的配合。

以下我将用通俗的语言和例子来说明下面的函数：

syslog.openlog(ident[, logopt[, facility]])

这个就是初始化syslog接口的函数，在这里有一个必须的参数和两个可选的参数。

第一个参数,ident

这个就是一个标识字符串，是log里每一行中程序的名程,如：

syslog.openlog("test.py")

syslog.syslog("The process is test.py")

 

tail -n 1 /var/log/messages

Apr 22 16:26:52 databak test.py: The process is test.py

对上了吧？看明白了吧？

第二个参数,logopt

选项名称：LOG_CONS,LOG_NDELAY,LOG_NOWAIT,LOG_PID,LOG_PERROR

大家可以从中选择一个，或者多个(要借助或操作符”|”),如:

Syslog.openlog(“test.py”,syslog.LOG_PID|syslog.LOG_PERROR)

Syslog.syslog(“The messages print pid and messages print to stderr”)

 

>>> syslog.syslog("The messages print pid and messages print to stderr")

test.py[16826]: The messages print pid and messages print to stderr

 

这个函数大家明白了吧？接下来，我们看syslog函数

在上面的例子中，syslog函数一直伴随着我们，我相信大家也看到了一点门道了，现在我还是把函数公示给大家吧。

syslog.syslog([priority], message)

这里有两个参数，一个可选一个必写。

Message就不用说了，我的例子都有了，只是要说明下可选参数了。

Priority,

名称：LOG_EMERG,LOG_ALERT,LOG_CRIT,LOG_ERR,LOG_WARNING,LOG_INFO,LOG_DEBUG(默认为LOG_INFO)

我们想将认证错误的信息写到python.err文件中，那么修改syslog.conf

auth.err                                           /var/log/python.err

看程序：

Syslog.openlog(“test.py”,syslog.LOG_PID,syslog.LOG_AUTH)

Syslog.syslog(syslog.LOG_ERR,“Add error information to python.err file”)

 

二、logging

1.简单的将日志打印到屏幕

 

import logging

logging.debug('This is debug message')
logging.info('This is info message')
logging.warning('This is warning message')

屏幕上打印:
WARNING:root:This is warning message

默认情况下，logging将日志打印到屏幕，日志级别为WARNING；
日志级别大小关系为：CRITICAL > ERROR > WARNING > INFO > DEBUG > NOTSET，当然也可以自己定义日志级别。

2.通过logging.basicConfig函数对日志的输出格式及方式做相关配置

import logging

logging.basicConfig(level=logging.DEBUG,
                format='%(asctime)s %(filename)s[line:%(lineno)d] %(levelname)s %(message)s',
                datefmt='%a, %d %b %Y %H:%M:%S',
                filename='myapp.log',
                filemode='w')
    
logging.debug('This is debug message')
logging.info('This is info message')
logging.warning('This is warning message')

./myapp.log文件中内容为:
Sun, 24 May 2009 21:48:54 demo2.py[line:11] DEBUG This is debug message
Sun, 24 May 2009 21:48:54 demo2.py[line:12] INFO This is info message
Sun, 24 May 2009 21:48:54 demo2.py[line:13] WARNING This is warning message

logging.basicConfig函数各参数:
filename: 指定日志文件名
filemode: 和file函数意义相同，指定日志文件的打开模式，'w'或'a'
format: 指定输出的格式和内容，format可以输出很多有用信息，如上例所示:
 %(levelno)s: 打印日志级别的数值
 %(levelname)s: 打印日志级别名称
 %(pathname)s: 打印当前执行程序的路径，其实就是sys.argv[0]
 %(filename)s: 打印当前执行程序名
 %(funcName)s: 打印日志的当前函数
 %(lineno)d: 打印日志的当前行号
 %(asctime)s: 打印日志的时间
 %(thread)d: 打印线程ID
 %(threadName)s: 打印线程名称
 %(process)d: 打印进程ID
 %(message)s: 打印日志信息
datefmt: 指定时间格式，同time.strftime()
level: 设置日志级别，默认为logging.WARNING
stream: 指定将日志的输出流，可以指定输出到sys.stderr,sys.stdout或者文件，默认输出到sys.stderr，当stream和filename同时指定时，stream被忽略

3.将日志同时输出到文件和屏幕

import logging

logging.basicConfig(level=logging.DEBUG,
                format='%(asctime)s %(filename)s[line:%(lineno)d] %(levelname)s %(message)s',
                datefmt='%a, %d %b %Y %H:%M:%S',
                filename='myapp.log',
                filemode='w')

#################################################################################################
#定义一个StreamHandler，将INFO级别或更高的日志信息打印到标准错误，并将其添加到当前的日志处理对象#
console = logging.StreamHandler()
console.setLevel(logging.INFO)
formatter = logging.Formatter('%(name)-12s: %(levelname)-8s %(message)s')
console.setFormatter(formatter)
logging.getLogger('').addHandler(console)
#################################################################################################

logging.debug('This is debug message')
logging.info('This is info message')
logging.warning('This is warning message')

屏幕上打印:
root        : INFO     This is info message
root        : WARNING  This is warning message

./myapp.log文件中内容为:
Sun, 24 May 2009 21:48:54 demo2.py[line:11] DEBUG This is debug message
Sun, 24 May 2009 21:48:54 demo2.py[line:12] INFO This is info message
Sun, 24 May 2009 21:48:54 demo2.py[line:13] WARNING This is warning message

4.logging之日志回滚

import logging
from logging.handlers import RotatingFileHandler

#################################################################################################
#定义一个RotatingFileHandler，最多备份5个日志文件，每个日志文件最大10M
Rthandler = RotatingFileHandler('myapp.log', maxBytes=10*1024*1024,backupCount=5)
Rthandler.setLevel(logging.INFO)
formatter = logging.Formatter('%(name)-12s: %(levelname)-8s %(message)s')
Rthandler.setFormatter(formatter)
logging.getLogger('').addHandler(Rthandler)
################################################################################################

从上例和本例可以看出，logging有一个日志处理的主对象，其它处理方式都是通过addHandler添加进去的。
logging的几种handle方式如下：

logging.StreamHandler: 日志输出到流，可以是sys.stderr、sys.stdout或者文件
logging.FileHandler: 日志输出到文件

日志回滚方式，实际使用时用RotatingFileHandler和TimedRotatingFileHandler
logging.handlers.BaseRotatingHandler
logging.handlers.RotatingFileHandler
logging.handlers.TimedRotatingFileHandler

logging.handlers.SocketHandler: 远程输出日志到TCP/IP sockets
logging.handlers.DatagramHandler:  远程输出日志到UDP sockets
logging.handlers.SMTPHandler:  远程输出日志到邮件地址
logging.handlers.SysLogHandler: 日志输出到syslog
logging.handlers.NTEventLogHandler: 远程输出日志到Windows NT/2000/XP的事件日志
logging.handlers.MemoryHandler: 日志输出到内存中的制定buffer
logging.handlers.HTTPHandler: 通过"GET"或"POST"远程输出到HTTP服务器

由于StreamHandler和FileHandler是常用的日志处理方式，所以直接包含在logging模块中，而其他方式则包含在logging.handlers模块中，
上述其它处理方式的使用请参见python2.5手册！

5.通过logging.config模块配置日志

#logger.conf


###############################################

[loggers]
keys=root,example01,example02

[logger_root]
level=DEBUG
handlers=hand01,hand02

[logger_example01]
handlers=hand01,hand02
qualname=example01
propagate=0

[logger_example02]
handlers=hand01,hand03
qualname=example02
propagate=0

###############################################

[handlers]
keys=hand01,hand02,hand03

[handler_hand01]
class=StreamHandler
level=INFO
formatter=form02
args=(sys.stderr,)

[handler_hand02]
class=FileHandler
level=DEBUG
formatter=form01
args=('myapp.log', 'a')

[handler_hand03]
class=handlers.RotatingFileHandler
level=INFO
formatter=form02
args=('myapp.log', 'a', 10*1024*1024, 5)

###############################################

[formatters]
keys=form01,form02

[formatter_form01]
format=%(asctime)s %(filename)s[line:%(lineno)d] %(levelname)s %(message)s
datefmt=%a, %d %b %Y %H:%M:%S

[formatter_form02]
format=%(name)-12s: %(levelname)-8s %(message)s
datefmt=

上例3：

import logging
import logging.config

logging.config.fileConfig("logger.conf")
logger = logging.getLogger("example01")

logger.debug('This is debug message')
logger.info('This is info message')
logger.warning('This is warning message')

上例4：

import logging
import logging.config

logging.config.fileConfig("logger.conf")
logger = logging.getLogger("example02")

logger.debug('This is debug message')
logger.info('This is info message')
logger.warning('This is warning message')

6.logging是线程安全的