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是線程安全的