CN104376043A

CN104376043A - 日志记录与显示方法及装置

Info

Publication number: CN104376043A
Application number: CN201410541234.7A
Authority: CN
Inventors: 李进南
Original assignee: Shenzhen Yihua Computer Co Ltd; Shenzhen Yihua Time Technology Co Ltd; Shenzhen Yihua Financial Intelligent Research Institute
Current assignee: Shenzhen Yihua Computer Co Ltd; Shenzhen Yihua Time Technology Co Ltd; Shenzhen Yihua Financial Intelligent Research Institute
Priority date: 2014-10-14
Filing date: 2014-10-14
Publication date: 2015-02-25
Anticipated expiration: 2034-10-14
Also published as: CN104376043B

Abstract

一种日志记录与显示方法及装置，该方法包括如下步骤:根据预先设置的日志规范文档对日志进行格式化操作，得到格式化的日志，该日志规范文档包括预先设置的日志记录语法及日志记录格式；根据预先设置的日志记录格式，将上述格式化的日志记录到指定文件，得到日志文件；当需要查看日志记录时，从上述日志文件中读取日志，根据预先设置的日志记录语法加亮显示日志，并图形化显示日志内容中的指定内容。利用本发明可提高查看日志的效率和可读性。

Description

日志记录与显示方法及装置

技术领域

本发明涉及日志记录与显示技术领域，尤其涉及一种金融业软件的日志记录与显示方法及装置。

背景技术

目前，一般金融业软件都会记录日志用于分析故障、查账等，由于自助设备量大，交易量很大，导致日志查看工作量巨大，维护软件成本很高，现有的技术方案与缺点如下：

通过记录文本文件方式，采用记事本、写字板等工具浏览，记录文本没有规范，比较随意，记事本、写字板显示单一；

记录文本没有规范，浏览工具显示单一、难懂，日志可读性比较差，开发人员查看日志效率低。查看日志要求高导致维护人员入门难，增加软件的维护成本。

发明内容

鉴于以上内容，本发明提出一种日志记录与显示方法及装置，通过预先设置的日志规范文档，采用统一的记录规范记录日志，根据预先设置的日志记录语法加亮显示日志，并图形化显示日志内容中的主要内容。

所述日志记录与显示方法包括：

日志记录步骤一，根据预先设置的日志规范文档对日志进行格式化操作，得到格式化的日志，该日志规范文档包括预先设置的日志记录语法及日志记录格式；

日志记录步骤二，根据预先设置的日志记录格式，将上述格式化的日志记录到指定文件，得到日志文件；

日志显示步骤，当需要查看日志记录时，从上述日志文件中读取日志，根据预先设置的日志记录语法加亮显示日志，并图形化显示日志内容中的指定内容。

所述日志记录与显示装置包括：

日志记录模块，用于根据预先设置的日志规范文档对日志进行格式化操作，得到格式化的日志，该日志规范文档包括预先设置的日志记录语法及日志记录格式；

所述日志记录模块，还用于根据预先设置的日志记录格式，将上述格式化的日志记录到指定文件，得到日志文件；

日志显示模块，用于当需要查看日志记录时，从上述日志文件中读取日志，根据预先设置的日志记录语法加亮显示日志，并图形化显示日志内容中的指定内容。

相较于现有技术，本发明所述的日志记录与显示方法及装置，通过预先设置的日志规范文档，采用统一的记录规范记录日志，根据预先设置的日志记录语法加亮显示日志，并图形化显示日志内容中的主要内容，提高了查看日志的效率，同时提高了软件的可读性，降低客服人员维护软件的难度，达到降低程序维护成本的目的。

附图说明

图1是本发明日志记录与显示装置的结构示意图；

图2是本发明日志记录与显示方法的整体流程图；

图3是采用图形化显示日志内容的示意图；

图4是采用折叠层次方式显示日志内容的示意图。

具体实施方式

如图1所示，是本发明日志记录与显示装置的结构示意图。在本实施方式中，所述日志记录与显示装置2包括日志记录模块21和日志显示模块22，其中，所述日志记录模块21进一步包括日志格式化子模块211、日志保存子模块212，所述日志显示模块22进一步包括日志加载子模块221、语法加亮显示子模块222、及图形化显示子模块223。所述日志记录模块21用于通过预先设置的日志规范文档，采用统一的记录规范记录日志，所述日志显示模块22用于根据预先设置的日志记录语法加亮显示日志，并图形化显示日志内容中的主要内容。

本发明所称的模块可以是完成一特定功能的计算机程序段，也可以是固化有上述计算机程序段的芯片。所述日志记录与显示装置2可以是一台电脑或一台服务器，关于各个模块的具体功能参阅图2的描述。

需要说明的是，图1只是日志记录与显示装置2的软件结构和硬件结构的示意性说明，该日志记录与显示装置2还包括其它必要的电子元器件和系统软件，如通过数据线或信号线相连的显示屏幕、输入设备、存储器、处理器、操作系统等，在此不再一一赘述。所述多个模块可以存储于日志记录与显示装置2的存储器中并被配置成由一个或多个处理器执行，以完成本发明。

如图2所示，是本发明日志记录与显示方法的整体流程图。

步骤S101，日志格式化子模块211根据预先设置的日志规范文档对日志进行格式化操作，得到格式化的日志，该日志规范文档用于描述日志记录的语法及日志记录到文件的格式。

在本实施方式中，所述日志规范文档主要用于描述日志记录的语法（以下也简称为“日志记录语法”或“日志记录规则”），包括但不限于，根据特定日志内容（如金融业软件日志）定义的相应关键字，及所定义关键字的作用与用法，如所定义关键字的显示模式等。

举例而言，ATMC软件日志可以定义关键字：[METHOD]、[GET]、[SET]、[EVENT]、[WFSAsyncGetInfo]、[WFSAsyncExecute]等。其中，WFSAsyncGetInfo、WFSAsyncExecute为XFS（X Filing System，X文件系统）中的2个API函数，[WFSAsyncGetInfo]代表获取状态信息时采用异步方式，[WFSAsyncExecute]代表执行指令时采用异步方式。当定义好上述关键字后，在显示日志的时候就可以根据上述关键字进行语法高亮显示及图形化显示。

进一步地，所述日志规范文档还描述有日志记录到文件的格式（以下也简称为“日志记录格式”）。在本实施方式中，所述日志记录格式包括7个字段：唯一编号、时间、线程ID、代码行、日志级别、模块、日志内容。除了日志内容字段，其它字段长度相同。其中，所述日志级别包括：调试、提示、告警、错误。

在软件开发的时候，根据所述日志规范文档记录日志，通过日志格式化子模块211格式化日志，其中，记录日志只需要填写日志级别、模块、及日志内容，然后根据预先设置的日志记录语法在日志内容中增加关键字及关键字的相关数据（如METHOD函数中的参数等）。在本实施方式中，所述日志格式化子模块211提供接口如下：

#define LOGMSG(pszLevel, fmt, ...) \

LogMsgEx(pszLevel, MID_CUR1, __FILE__, __LINE__, fmt, __VA_ARGS__);

步骤S102，日志保存子模块212根据预先设置的日志记录格式，将上述格式化的日志记录到指定文件，得到日志文件，该日志文件设置为统一格式。在本实施方式中，所述日志文件采用Unicode统一格式，支持不同地区语言。

步骤S103，当需要查看日志记录时，日志加载子模块221从上述日志文件中读取日志。然后，语法加亮显示子模块222根据预先设置的日志记录语法加亮显示日志，且图形化显示子模块223在日志记录与显示装置2的显示屏幕上图形化显示日志内容中的指定内容（参阅图3所示）。在本实施方式中，所述日志内容中的指定内容为所述日志内容中的重要内容，如硬件指令、API函数、及API函数的相关参数等。

具体而言，所述语法加亮显示子模块222根据预先设置的日志记录语法加亮显示日志包括：

1）默认所有日志内容显示为第一颜色，如蓝色；

2）错误级别和告警级别的记录显示为第二颜色，如红色；

3）所定义关键字显示为第三颜色，如绿色，例如：[METHOD]、[EVENT]等关键字显示为绿色，参阅图3所示；

4）日志记录与显示装置2的文件系统（如XFS）中相关的宏定义显示为第四颜色，如粉红色；

5）所述文件系统中对应的结果参数采用折叠层次方式显示，参阅图4所示，所述折叠层次方式为树形层级结构，在其他实施方式中，也可以不采用折叠层次方式显示所述文件系统中对应的结果参数。

在本实施方式中，所述图形化显示子模块223图形化显示日志内容中的指定内容包括：根据所定义关键字及相应的显示模式，绘制出时序图，以图形化模式显示日志内容中的指定内容。参阅图3所示，所述时序图为根据日志记录的时间顺序绘制的图形，在本实施方式中，所述时序图中显示日志内容中的重要内容，以快速定位问题、找到主要矛盾。

进一步地，在本实施方式中，所述绘制的时序图颜色为可配置选项，所述可配置选项包括但不限于，时序图背景颜色配置和时序图对象颜色相关配置，具体配置方法如下：

<ChartView background="RGB:255,255,255" arrowcolor= "RGB:0,0,255"> //时序图背景颜色配置

<Object id="1" name="APP" left="180" width="60" textcolor="RGB:255,0,0" linecolor="RGB:0,0,0" /> //时序图对象颜色相关配置

<Object id="2" name="YHAX" left="550" width="60" textcolor="RGB:255,0,0" linecolor="RGB:0,0,0" /> //时序图对象颜色相关配置

<Object id="3" name="SP" left="920" width="60" textcolor="RGB:255,0,0" linecolor="RGB:0,0,0" /> //时序图对象颜色相关配置

</Objects>

</ChartView>

综上所述，本发明所述的日志记录与显示方法及装置，首先自定义日志记录的语法规范，记录规范的日志，并根据约定的语法规范高亮显示日志，图形化显示日志的主要内容，日志展示规范、丰富，具有如下有益效果：(1)格式整齐，预先定义的语法内容加亮显示，日志可读性高；(2)重要内容图形化显示，主要流程快速呈现；(3)故障显示红色，快速定位故障位置；(4)客服人员也很容易查看日志并处理问题；(5)提高了日志可读性和软件的可维护性，降低软件维护成本。

以上内容是结合具体的优选实施方式对本发明所作的详细说明，不能认定具体实施只局限于这些说明。对于所属技术领域的普通技术人员来说，在不脱离本发明构思的前提下，还可以做出若干简单推演或替换，都应当视为属于本发明的保护范围。

Claims

1.一种日志记录与显示方法，应用于日志记录与显示装置，其特征在于，该方法包括：

日志记录步骤二，根据预先设置的日志记录格式，将上述格式化的日志记录到指定文件，得到日志文件；及

2.根据权利要求1所述的日志记录与显示方法，其特征在于，所述日志记录语法用于定义日志内容中的关键字，及所定义关键字的显示模式。

3.根据权利要求2所述的日志记录与显示方法，其特征在于，所述日志记录格式包括如下字段：唯一编号、时间、线程ID、代码行、日志级别、模块、及日志内容，其中，所述日志级别包括：调试、提示、告警、错误。

4.根据权利要求2所述的日志记录与显示方法，其特征在于，所述根据预先设置的日志记录语法加亮显示日志的步骤包括：

默认所有日志内容显示为第一颜色；

错误级别和告警级别的记录显示为第二颜色；

所定义关键字显示为第三颜色；及

文件系统中相关的宏定义显示为第四颜色。

5.根据权利要求4所述的日志记录与显示方法，其特征在于，所述根据预先设置的日志记录语法加亮显示日志的步骤还包括：

所述文件系统中对应的结果参数采用折叠层次方式显示，其中，所述折叠层次方式为树形层级结构。

6.根据权利要求4所述的日志记录与显示方法，其特征在于，所述图形化显示日志内容中的指定内容的步骤包括：

根据所定义关键字及相应的显示模式，绘制出时序图，以图形化模式显示日志内容中的指定内容，其中，所述时序图为根据日志记录的时间顺序绘制的图形。

7.根据权利要求6所述的日志记录与显示方法，其特征在于，所述日志内容中的指定内容包括：硬件指令、API函数、及API函数的相关参数。

8.根据权利要求6所述的日志记录与显示方法，其特征在于，所述绘制的时序图颜色为可配置选项，其中，所述可配置选项包括时序图背景颜色配置和时序图对象颜色配置。

9.一种日志记录与显示装置，其特征在于，该装置包括：

所述日志记录模块，还用于根据预先设置的日志记录格式，将上述格式化的日志记录到指定文件，得到日志文件；及

10.根据权利要求9所述的日志记录与显示装置，其特征在于，所述日志记录语法用于定义日志内容中的关键字，及所定义关键字的显示模式。