LINUX系统下,开发日志系统,没有头绪,求指点 -问答-阿里云开发者社区-阿里云

开发者社区> 问答> 正文

LINUX系统下,开发日志系统,没有头绪,求指点

杨冬芳 2016-07-08 16:07:49 1797

问题描述:
是在ARM开发板上开发LINUX系统及上软件,因为我刚参与进来,所以框架我还不清楚,主要是socket和can协议这样。

周五开会,让我开发一套日志系统,作为一个独立的模块,谁想写日志,就调用我的接口。

然而,我弄到现在完全没有头绪,因为以前也没搞过日志,所以求指点,给个头绪,让我进行下去。

Linux
分享到
取消 提交回答
全部回答(1)
  • 杨冬芳
    2019-07-17 19:53:36

    http://blog.csdn.net/zdy0_2004/article/details/46288183
    1.概述
    在大型软件系统中,为了监测软件运行状况及排查软件故障,一般都会要求软件程序在运行的过程中产生日志文件。在日志文件中存放程序流程中的一些重要信息,包括:变量名称及其值、消息结构定义、函数返回值及其执行情况、脚本执行及调用情况等。通过阅读日志文件,我们能够较快地跟踪程序流程,并发现程序问题。因此,熟练掌握日志系统的编写方法并快速地阅读日志文件,是对一个软件开发工程师的基本要求。
    本文详细地介绍了Linux下一个简单的日志系统的设计方法,并给出了其C代码实现。本文为相关开发项目Linux下软件日志系统的编写提供了有益的参考。

    2.日志系统的框架结构
    一个完整的日志系统包括三大部分:配置文件、软件程序和日志文件,它们之间的关系如图1所示。
    screenshot3.生成日志文件的程序流程
    基于日志系统的框架结构,生成日志文件的程序流程如图2所示。
    screenshot
    screenshot图2 生成日志文件的程序流程
    在实际的软件程序中,为了在程序的不同地方打印不同的日志,要将生成日志的代码封装为函数,作为API供程序调用。
    如果软件没有成功生成日志,那么就不要让其继续执行后续流程,而是要查找问题的原因,直到日志生成正常为止。

    4.日志文件命名及日志信息格式
    对于日志文件的命名,不同的软件开发项目有不同的规定。一般说来,日志文件都是以log作为后缀,如本文中的日志文件命名为:WriteLog.log。
    对于每条日志信息的格式,对于不同的软件来说,也会有所不同。在本文中,日志信息的格式有以下两种(具体使用哪一种通过配置项决定):
    第一种:日志生成时间函数名[日志等级]日志具体信息
    第二种:日志生成时间日志具体信息

    5.配置文件说明
    本文中使用的配置文件为Config.ini,它包括了两部分信息,如下所示:
    screenshot其中,“EMPLOYEEINFO”段是指员工信息,包含员工姓名和员工年龄两个配置项。程序会将员工姓名和员工年龄读入,并输出到日志文件中。
    “LOG”段是指日志信息,包含日志等级、日志代码位置标识和输出日志文件的目录三个配置项。对于“LogLevel”配置项,只有代码中日志等级不低于配置值的日志信息才会被输出到日志文件中(例如,LogLevel=4,那么只有Fatal、Error、Warn、Info和Trace等级的日志会被输出到日志文件中)。“LogPosition”配置项的值用于控制是否在日志文件中显示“文件名/函数名/代码行数”信息,1则显示,0则不显示。“LogDir”配置项的值表示生成的日志文件存放的目录。

    6.重要程序流程
    (1) 从配置文件中读取各个配置项的值
    该操作的流程如图3所示,具体请参见《Linux下配置文件读取操作流程及其C代码实现》(http://blog.csdn.net/zhouzhaoxiong1227/article/details/45563263)一文。 screenshotscreenshotscreenshotscreenshot图4 向日志文件中写入日志信息程序流程

    该流程的具体代码请参考本文附录中的完整程序代码中的WriteLogFile函数。

    7.程序测试设计及文件上传
    为了测试本日志系统的功能是否正确,在main函数中设计了以下三类日志信息:
    第一类:打印程序的版本号及编译时间。
    第二类:打印Fatal、Error、Warn、Info、Trace、Debug、All这七个等级的日志各一条。
    第三类:调用GetEmployeeInfo函数打印读取到的员工姓名和年龄。

    将本程序“WriteLog.c”上传到Linux的“/home/zhou/zhouzx/test”目录下,并在该目录下建立“etc”和“log”目录,将配置文件“Config.ini”上传到“etc”下。文件及目录布局如图5所示。 screenshot图5 文件及目录布局

    8.代码编译及运行
    在Linux下使用“gcc -g -o WriteLog WriteLog.c”命令对程序进行编译,生成“WriteLog”文件。
    下面来运行程序。
    (1) 将配置文件中的各个配置项的值设置如下:screenshot对照配置文件和日志文件,我们可以看到,“LogLevel”设置的是为4,因此只有日志等级不低于4的日志被输出到了日志文件中;“LogPosition”设置的是为0,因此在日志文件中不显示“文件名/函数名/代码行数”的信息。

    为了验证本日志系统功能的正常与否,要对程序进行多组测试,

    9.总结
    本文对Linux下一个简单的日志系统的设计方法进行了详细的介绍(其C代码实现请见附录),代码中的写日志相关函数可作为API供其它需要进行类似操作的程序调用。在使用本日志系统的过程中,有以下注意事项:
    第一,配置文件中“LOG”段只包括了日志等级、日志代码位置标识和输出日志文件的目录三个配置项。在实际的软件开发项目中,还会有更多的配置参数,像存放的日志文件的最大个数、每个日志文件的大小阈值、每个已写入完成的日志文件的命名等。可以在本程序的基础上进一步扩展来实现复杂的日志功能。
    第二,本文中对日志信息的写入采用的是直接在日志文件后面追加的方式,因此每次测试之前,要在“log”目录下删除上一次产生的“WriteLog.log”文件,否则新的日志信息会写入旧的日志文件中。
    第三,由于写日志函数WriteLogFile的入参较多,每次调用的时候编写代码较为繁琐,因此使用一个宏WRITELOGFILE来代替,且只需要带上日志等级和日志消息两个参数即可,其它的如代码文件名、函数名和代码行数直接使用系统自定义的宏即可。

    附录:完整的程序代码
    screenshot

    0 0
开发与运维
使用钉钉扫一扫加入圈子
+ 订阅

集结各类场景实战经验,助你开发运维畅行无忧

推荐文章
相似问题
推荐课程