日志模块

 

    日志模块


前言:


    很多程序都有记录日志的需求,并且日志中包含的信息既有正常的程序访问日志,还可能有错误、警告灯信息输出,python的logging模块提供了标准的日志接口,你可以通过它存储各种格式的日志,logging的日志可以分为debug(),info(),warning(),error(),and crirical() 5个级别。



    一、简单用法



    1、灵活被指日志级别,日志格式,输出位置。


        #导入模块

        import logging

        #level:设置rootlogger的日志级别

        logging.basicConfig(level=logging.DEBUG,


             # handler使用的日志显示格式

            format = '%(asctime)s %(filename)s[line:%(lineno)d] %(levelname)s %(message)s',


            #指定时间格式

            datefmt = '%a, %d %b %Y %H:%M:%S',

            # filename:使用指定文件名创建filedHandler,这样日志会被存储在指定的文件中。
    
            filename = '/tmp/test.log',


            # 文件的打开方式

            filemode = 'w' )


        logging.debug('debug message')

        logging.info('info message')

        logging.warning('warning message')

        logging.error('error message')

        logging.critical('critical message')



    2、format 参数中可能用到的格式化串



        %(name)s:Logger的名字。

        %(levelon)s:数字形式的日志级别。

        %(levelname)s:文本形式的日志级别。

        %(pathname)s:调用日志输出函数的模块的完整路径名。可能没有。

        %(filename)s:调用日志输出函数的模块的文件名。

        %(module)s:调用日志输出函数的模块名。

        %(funcName)s:调用日志输出函数的函数名。

        %(lineno)d:调用日志输出函数的语句所在的代码行。

        %(created)f:当前时间,用UNIX标准表示时间的浮点数表示。

        %(relativeCreated)d:输出日志信息时的,自logged创建以来的毫秒数。

        %(asctime)s:字符串形式的当前时间,默认格式是“2003-07-08 16:49:45,896。“逗号后面是毫秒

        %(therad)d:线程ID。可能没有

        %(threadName)s:线程名。可能没有

        %(process)d:进程ID。可能没有

        %(message)s:用户输出的信息





    二、logger对象配置



        python使用logging模块记录日志涉及四个主要类:

        1、logger提供了应用程序可以直接使用的接口:

        每个程序输出信息之前都要获得一个Logger。Logger通常对应了城西的模块名,比如聊天工具的图形界面模块可以这样获得它们的Logger;

        LOG=logging.getLogger("chat.gui")

        而可信模块可以这样;

        LOG=logging.getLogger("chat.kernel")

        指定最低的日志些别,低于lel的级别将别忽略。debug是最低的内置级别,critical为最高

            Logger.setLevel(lel)

            #添加或者删除指定的filter

            Logger.addFilter(filt)、Logger.removeFilter(filt)

            #增加或删除指定的handler

            Logger.addHandler(hdlr),Logger.removeHandler(hdlr)

            Logger.debug(),Logger.info(),Logger.warning(),Logger.error(),Logger.critial():可以设置的日志级别。





        2、handler(logger创建的)将日志记录发送到合适的目的输出;

            handler对象负责发送相关的信息到指定目的地。Python的日志系统有多种Handler可以使用。有些Handler可以把信息输出到控制台,有些Logger可以把信息输出到文件,还有些 Handler可以把信息发送到网络上。如果觉得不够用,还可以编写自己的Handler。

                #指定被处理的信息级别,低于lel级别的信息将被忽略

                Handler.setLevel(lel)

                #给这个handler选择一个格式

                Handler.setFormatter()

                #新增或删除一个filter对象

                Handler.addFilter(filt)、Handler.removeFilter(filt)



        3、每个Logger可以附加多个Handler。一下是常用的Handler



             (1) logging.StreamHandler

              使用这个Handler可以向类似于sys.stdout或者sys.stderr的任何文件对象(file object)输出信息

              语法:

              StreamHandler([strm])

              参数:

              strm       #strm参数是一个文件对象。默认是sys.stderr



              (2) logging.FileHandler

              和StreamHandler类似,用于向一个文件输出日志信息。不过FileHandler会帮你打开这个文件。

              语法:

              FileHandler(filename[,mode])

              参数:

              filename       #文件名,必须指定一个文件名。

              mode            #文件的打开方式。参见Python内置函数open()的用法。默认是’a’,即添加到文件末尾。


              (3) logging.handlers.RotatingFileHandler

              这个Handler类似于上面的FileHandler,但是它可以管理文件大小。当文件达到一定大小之后,它会自动将当前日志文件改名,然后创建 一个新的同名日志文件继续输出。

              语法:

              RotatingFileHandler( filename[, mode[, maxBytes[, backupCount]]])

              参数:

              filename               #文件名,必须指定一个文件名。

              mode                    #文件的打开方式。参见Python内置函数open()的用法。默认是’a’,即添加到文件末尾。

              maxBytes            #用于指定日志文件的最大文件大小。如果maxBytes为0,意味着日志文件可以无限大,这时上面描述的重命名过程就不会发生。

              backupCount       #用于指定保留的备份文件的个数。





             (4) logging.handlers.TimedRotatingFileHandler

              这个Handler和RotatingFileHandler类似,不过,它没有通过判断文件大小来决定何时重新创建日志文件,而是间隔一定时间就 自动创建新的日志文件。重命名的过程与RotatingFileHandler类似,不过新的文件不是附加数字,而是当前时间。

              语法:

              TimedRotatingFileHandler( filename [,when [,interval [,backupCount]]])

              参数:

              filename                  #文件名,必须指定一个文件名。

              backupCount          #用于指定保留的备份文件的个数。

              interval   #时间间隔。

              when            #when参数是一个字符串。表示时间间隔的单位,不区分大小写。它有以下取值:


                    S 秒

                    M 分

                    H 小时

                    D 天

                    W 每星期(interval==0时代表星期一)

                    midnight 每天凌晨  


                     3、filter提供了细度设备来决定输出哪条日志记录;                

                   4、formatter决定日志记录的最终输出格式                               





    三、使用示例:



           导入模块

            import logging


            创建logger对象

            logger = logging.getLogger('TEST-LOG')

            logger.setLevel(logging.DEBUG)



            创建一个handler,用于输出到控制台并设置日志级别为debug。

            ch = logging.StreamHandler()

            ch.setLevel(logging.DEBUG)



            创建一个handler,用于写入日志文件并设置日志级别为warning

            fh = logging.FileHandler("access.log")

            fh.setLevel(logging.WARNING)



            创建日志格式

            formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')



            添加日志格式

            ch.setFormatter(formatter)

            fh.setFormatter(formatter)



            将handler添加到logger对象

            logger.addHandler(ch)

            logger.addHandler(fh)



            打印日志

            logger.debug('debug message')

            logger.info('info message')

            logger.warn('warn message')

            logger.error('error message')

            logger.critical('critical message')     









四、文件自动截断例子:

        导入日志模块

        import logging

        from logging import handlers

        创建logger对象

        logger = logging.getLogger(__name__)

        创建handler

        log_file = "timelog.log"

        #fh = handlers.RotatingFileHandler(filename=log_file,maxBytes=10,backupCount=3)

        fh = handlers.TimedRotatingFileHandler(filename=log_file,when="S",interval=5,backupCount=3)


        创建日志格式

        formatter = logging.Formatter('%(asctime)s %(module)s:%(lineno)d %(message)s')


        添加日志格式

        fh.setFormatter(formatter)


        添加handler

        logger.addHandler(fh)



        打印日志

        logger.warning("test1")

        logger.warning("test12")

        logger.warning("test13")

        logger.warning("test14")
posted @ 2018-05-24 10:52  zhangliang666  阅读(308)  评论(0编辑  收藏  举报