CN109992492A - 功能模块的日志记录方法、装置、设备及可读存储介质 - Google Patents

Abstract

本发明实施例公开了一种功能模块的日志记录方法、装置、设备及计算机可读存储介质。其中，方法包括记录一次调用功能模块的详细运行日志数据和该功能模块调用结束后的返回值，若返回值异常，则对运行日志数据进行快照，生成快照日志数据。本申请功能模块返回值异常时，将详细记录该功能模块代码在一次调用中的整个运行流程中的所有日志数据进行快照日志，从而可有效避免日志瀑布将与故障相关的有用信息冲掉，软件开发人员根据保存的快照数据能够更加快速、直接的定位异常运行的功能模块的故障所在，提高了研发人员的工作效率，缩短软件研发周期，提升软件研发效率，还可大大提升产品的可维护性，有利于提升软件产品的质量，提升软件产品竞争力。

Description

功能模块的日志记录方法、装置、设备及可读存储介质

技术领域

本发明实施例涉及日志处理技术领域，特别是涉及一种功能模块的日志记录方法、装置、设备及计算机可读存储介质。

背景技术

随着计算机技术的快速发展，软件为与计算机系统操作有关的计算机程序、规程、规则，以及可能有的文件、文档及数据的集合，基于计算机环境可实现多种功能，也得到相应的发展。

在软件研发过程中，研发人员不可避免的需要对编写好的代码进行调试，日志记录作为软件研发工程师定位软件故障、及时修复软件代码、解决软件中隐藏bug的重要手段，故开发一个好的日志系统是一个很有必要的技术手段。

一般的日志手段是在重要的端点进行记录，在设备推向市场后，经过长时间的运行，一些有效性的日志可能会被冲掉，在设备出现售后问题时，研发人员在拿到被冲掉关键信息的日志时显得力不从心，从而导致在问题解决时出现阻塞。

鉴于此，如何有效地记录功能模块的日志，使得在功能模块出现问题时，保证异常日志不会被冲掉，避免有用的日志信息的缺失，是本领域技术人员亟待解决的问题。

发明内容

本公开实施例提供了一种功能模块的日志记录方法、装置、设备及计算机可读存储介质，可有效规避日志瀑布将有用信息冲掉，有利于快速定位软件故障，缩短软件周期，提升软件研发速率。

为解决上述技术问题，本发明实施例提供以下技术方案：

本发明实施例一方面提供了一种功能模块的日志记录方法，包括：

记录一次调用功能模块的所有运行日志数据，并获取调用结束后的返回值；

若所述返回值异常，则对所述运行日志数据进行快照，生成快照日志数据。

可选的，所述对所述运行日志数据进行快照，生成快照日志数据之后，还包括：

将所述快照日志数据同步至远端服务器，以用于备份所述快照日志数据；

其中，所述快照日志数据在本地存储空间的剩余空间占用值不大于预设空间阈值时，被后续快照日志数据覆盖。

可选的，所述获取调用结束后的返回值之后，还包括：

若所述返回值正常，则所述运行日志数据被后续功能模块调用过程中产生的日志数据覆盖。

可选的，所述对所述运行日志数据进行快照，生成快照日志数据为采用追加方法将所述运行日志数据保存，以作为快照日志数据。

可选的，所述获取调用结束后的返回值之后，还包括：

判断远端服务器数据库中的BMC的固件版本与本地BMC的固件版本是否一致；

若否，则触发更新所述本地BMC的固件版本。

本发明实施例另一方面提供了一种功能模块的日志记录装置，包括：

详细日志记录模块，用于记录一次调用功能模块的所有运行日志数据；

返回值判断模块，用于在所述功能模块调用结束后，判断调用结束后的返回值是否正常；

日志快照模块，用于若所述返回值异常，则对所述运行日志数据进行快照，生成快照日志数据。

可选的，还包括：

快照日志数据备份模块，用于将所述快照日志数据同步至远端服务器，以用于备份所述快照日志数据；其中，所述快照日志数据在本地存储空间的剩余空间占用值不大于预设空间阈值时，被后续快照日志数据覆盖。

可选的，还包括：

固件版本升级模块，用于若远端服务器数据库中的BMC的固件版本与本地BMC的固件版本不一致，则触发更新所述本地BMC的固件版本。

本发明实施例还提供了一种功能模块的日志记录设备，包括处理器，所述处理器用于执行存储器中存储的计算机程序时实现如前任一项所述功能模块的日志记录方法的步骤。

本发明实施例最后还提供了一种计算机可读存储介质，所述计算机可读存储介质上存储有功能模块的日志记录程序，所述功能模块的日志记录程序被处理器执行时实现如前任一项所述功能模块的日志记录方法的步骤。

本申请提供的技术方案的优点在于，根据调用功能模块的返回值确定是否要进行快照日志，当返回值异常时，表征功能模块可能会出现异常，将详细记录该功能模块代码在一次调用中的整个运行流程中的所有日志数据进行快照日志，从而可有效避免日志瀑布将与故障相关的有用信息冲掉，软件开发人员根据保存的快照数据能够更加快速、直接的定位异常运行的功能模块的故障所在，提高了研发人员的工作效率，缩短软件研发周期，提升软件研发效率，还可大大提升产品的可维护性，有利于提升软件产品的质量，提升软件产品竞争力。

此外，本发明实施例还针对功能模块的日志记录方法提供了相应的实现装置、设备及计算机可读存储介质，进一步使得所述方法更具有实用性，所述装置、设备及计算机可读存储介质具有相应的优点。

应当理解的是，以上的一般描述和后文的细节描述仅是示例性的，并不能限制本公开。

附图说明

为了更清楚的说明本发明实施例或相关技术的技术方案，下面将对实施例或相关技术描述中所需要使用的附图作简单的介绍，显而易见地，下面描述中的附图仅仅是本发明的一些实施例，对于本领域普通技术人员来讲，在不付出创造性劳动的前提下，还可以根据这些附图获得其他的附图。

图1为本发明实施例提供的一种功能模块的日志记录方法的流程示意图；

图2为本发明实施例提供的另一种功能模块的日志记录方法的流程示意图；

图3为本发明实施例提供的功能模块的日志记录装置的一种具体实施方式结构图；

图4为本发明实施例提供的功能模块的日志记录装置的另一种具体实施方式结构图。

具体实施方式

为了使本技术领域的人员更好地理解本发明方案，下面结合附图和具体实施方式对本发明作进一步的详细说明。显然，所描述的实施例仅仅是本发明一部分实施例，而不是全部的实施例。基于本发明中的实施例，本领域普通技术人员在没有做出创造性劳动前提下所获得的所有其他实施例，都属于本发明保护的范围。

本申请的说明书和权利要求书及上述附图中的术语“第一”、“第二”、“第三”“第四”等是用于区别不同的对象，而不是用于描述特定的顺序。此外术语“包括”和“具有”以及他们任何变形，意图在于覆盖不排他的包含。例如包含了一系列步骤或单元的过程、方法、系统、产品或设备没有限定于已列出的步骤或单元，而是可包括没有列出的步骤或单元。

在介绍了本发明实施例的技术方案后，下面详细的说明本申请的各种非限制性实施方式。

首先参见图1，图1为本发明实施例提供的一种功能模块的日志记录方法的流程示意图，本发明实施例可包括以下内容：

S101：记录一次调用功能模块的所有运行日志数据。

对开发的软件功能模块进行详细的日志记录，在一次功能模块的调用过程中，将整个调用过程中产生的运行日志数据均进行记录，尤其是一些容易出问题的关键点，例如固件通讯、CPU温度、电压、风扇等。在发生异常时，记录的日志数据中必然存在与故障相关的信息，从而有利于研发人员快速定位故障，从而快速修复软件中bug。

S102：获取功能模块调用结束后的返回值。

每个功能模块设置一个返回值，返回值可用于表征功能模块运行是否正常，在调用结束后，功能模块返回该返回值。系统在接收到返回值后，根据返回值检测功能模块是否发生异常。举例来说，功能模块运行正常时，返回值为0；当接收到的返回值为非零值时，则表明功能模块运行异常。

S103：判断返回值是否正常，若否，则执行S104。

S104：对运行日志数据进行快照，生成快照日志数据。

当功能模块返回值为异常返回值，可将该功能模块的整个运行的详细日志进行快照，例如可采用追加方法重新保存下来作为快照日志数据。

考虑到系统存储空间有限，详细的日志记录是有空间限制的，而且在正常情况下，调用功能模块的详细日志是无用的，鉴于此，可以采用覆盖的方式进行日志记录。也就是说，在当前调用功能模块返回值不为异常时，记录其整个调用过程中的运行日志数据会被后续功能模块调用过程中产生的日志数据覆盖，系统中保存的均是当前时刻调用的功能模块的日志数据。

通过对异常数据进行快照，在产品长时间运行过程中，当出现问题时，可以通过快照日志数据快速定位故障。

在本发明实施例提供的技术方案中，根据调用功能模块的返回值确定是否要进行快照日志，当返回值异常时，表征功能模块可能会出现异常，将详细记录该功能模块代码在一次调用中的整个运行流程中的所有日志数据进行快照日志，从而可有效避免日志瀑布将与故障相关的有用信息冲掉，软件开发人员根据保存的快照数据能够更加快速、直接的定位异常运行的功能模块的故障所在，提高了研发人员的工作效率，缩短软件研发周期，提升软件研发效率，还可大大提升产品的可维护性，有利于提升软件产品的质量，提升软件产品竞争力。

本申请还提供了另外一个实施例，请参见图2，图2为本发明实施例提供的另一种功能模块的日志记录方法的流程示意图，可包括以下内容：

S201：记录一次调用功能模块的所有运行日志数据。

S202：获取功能模块调用结束后的返回值。

S203：判断返回值是否正常，若是，则执行S204，若否，则执行S205。

S204：执行下一个功能模块的调用，且下一个功能模块的日志数据覆盖该运行日志数据。

S205：采用追加方法对运行日志数据进行快照，生成快照日志数据。

在进行日志数据快照时，也可采用其他方式进行，这均不影响本申请的实现。

S206：将快照日志数据同步至远端服务器，以用于备份快照日志数据。

快照日志数据在本地存储空间的剩余空间占用值不大于预设空间阈值时，被后续快照日志数据覆盖。

对于以追加方式日志快照保存的日志，由于系统空间有限，所以不可能一直保存在系统中，但是这些数据对应故障定位是不可缺少的，可将其同步到远端服务器的数据库中，这样就解决了大量日志占用系统空间的问题。

此外，将其异常日志保存下来并同步到远端服务器，不仅可避免日志瀑布将其有用信息冲掉，还可在系统发生问题时，避免日志数据的丢失。

S207：判断远端服务器数据库中的BMC的固件版本与本地BMC的固件版本是否一致，若否，则执行S208。

S208：触发更新本地BMC的固件版本。

当发现远端数据库中BMC的固件版本以及本系统中在用的BMC的固件版本不一致时，可触发自动升级操作，可采用开源的升级BMC的Yafu工具，执行对应的系统调用即可。

本发明实施例与上述实施例相同的步骤或方法，与上述实施例所描述一致，具体实现过程可参阅上述实施例相应内容，此处便不再赘述。

由上可知，本发明实施例可有效规避日志瀑布将有用信息冲掉，还可避免系统发生异常时丢失日志数据，有利于快速定位软件故障，缩短软件周期，提升软件研发速率。

本发明实施例还针对功能模块的日志记录方法提供了相应的实现装置，进一步使得所述方法更具有实用性。下面对本发明实施例提供的功能模块的日志记录装置进行介绍，下文描述的功能模块的日志记录装置与上文描述的功能模块的日志记录方法可相互对应参照。

参见图3，图3为本发明实施例提供的功能模块的日志记录装置在一种具体实施方式下的结构图，该装置可包括：

详细日志记录模块301，用于记录一次调用功能模块的所有运行日志数据。

返回值判断模块302，用于在功能模块调用结束后，判断调用结束后的返回值是否正常。

日志快照模块303，用于若返回值异常，则对运行日志数据进行快照，生成快照日志数据。

可选的，在本实施例的一些实施方式中，请参阅图4，所述装置可以包括快照日志数据备份模块304，用于将快照日志数据同步至远端服务器，以用于备份快照日志数据；其中，快照日志数据在本地存储空间的剩余空间占用值不大于预设空间阈值时，被后续快照日志数据覆盖。

在另外一些实施方式中，所述装置例如还可以包括固件版本升级模块305，用于若远端服务器数据库中的BMC的固件版本与本地BMC的固件版本不一致，则触发更新本地BMC的固件版本。

可选的，在本实施例的另一些实施方式中，所述日志快照模块303还可以为采用追加方法将所述运行日志数据保存，以作为快照日志数据的模块。

本发明实施例所述功能模块的日志记录装置的各功能模块的功能可根据上述方法实施例中的方法具体实现，其具体实现过程可以参照上述方法实施例的相关描述，此处不再赘述。

由上可知，本发明实施例可有效规避日志瀑布将有用信息冲掉，还可避免系统发生异常时丢失日志数据，有利于快速定位软件故障，缩短软件周期，提升软件研发速率。

本发明实施例还提供了一种功能模块的日志记录设备，具体可包括：

存储器，用于存储计算机程序；

处理器，用于执行计算机程序以实现如上任意一实施例所述功能模块的日志记录方法的步骤。

本发明实施例所述功能模块的日志记录设备的各功能模块的功能可根据上述方法实施例中的方法具体实现，其具体实现过程可以参照上述方法实施例的相关描述，此处不再赘述。

由上可知，本发明实施例可有效规避日志瀑布将有用信息冲掉，还可避免系统发生异常时丢失日志数据，有利于快速定位软件故障，缩短软件周期，提升软件研发速率。

本发明实施例还提供了一种计算机可读存储介质，存储有功能模块的日志记录程序，所述功能模块的日志记录程序被处理器执行时如上任意一实施例所述功能模块的日志记录方法的步骤。

本发明实施例所述计算机可读存储介质的各功能模块的功能可根据上述方法实施例中的方法具体实现，其具体实现过程可以参照上述方法实施例的相关描述，此处不再赘述。

由上可知，本发明实施例可有效规避日志瀑布将有用信息冲掉，还可避免系统发生异常时丢失日志数据，有利于快速定位软件故障，缩短软件周期，提升软件研发速率。

本说明书中各个实施例采用递进的方式描述，每个实施例重点说明的都是与其它实施例的不同之处，各个实施例之间相同或相似部分互相参见即可。对于实施例公开的装置而言，由于其与实施例公开的方法相对应，所以描述的比较简单，相关之处参见方法部分说明即可。

专业人员还可以进一步意识到，结合本文中所公开的实施例描述的各示例的单元及算法步骤，能够以电子硬件、计算机软件或者二者的结合来实现，为了清楚地说明硬件和软件的可互换性，在上述说明中已经按照功能一般性地描述了各示例的组成及步骤。这些功能究竟以硬件还是软件方式来执行，取决于技术方案的特定应用和设计约束条件。专业技术人员可以对每个特定的应用来使用不同方法来实现所描述的功能，但是这种实现不应认为超出本发明的范围。

结合本文中所公开的实施例描述的方法或算法的步骤可以直接用硬件、处理器执行的软件模块，或者二者的结合来实施。软件模块可以置于随机存储器(RAM)、内存、只读存储器(ROM)、电可编程ROM、电可擦除可编程ROM、寄存器、硬盘、可移动磁盘、CD-ROM、或技术领域内所公知的任意其它形式的存储介质中。

以上对本发明所提供的一种功能模块的日志记录方法、装置、设备及计算机可读存储介质进行了详细介绍。本文中应用了具体个例对本发明的原理及实施方式进行了阐述，以上实施例的说明只是用于帮助理解本发明的方法及其核心思想。应当指出，对于本技术领域的普通技术人员来说，在不脱离本发明原理的前提下，还可以对本发明进行若干改进和修饰，这些改进和修饰也落入本发明权利要求的保护范围内。

Claims (10)

1.一种功能模块的日志记录方法，其特征在于，包括：

记录一次调用功能模块的所有运行日志数据，并获取调用结束后的返回值；

若所述返回值异常，则对所述运行日志数据进行快照，生成快照日志数据。

2.根据权利要求1所述的功能模块的日志记录方法，其特征在于，所述对所述运行日志数据进行快照，生成快照日志数据之后，还包括：

将所述快照日志数据同步至远端服务器，以用于备份所述快照日志数据；

其中，所述快照日志数据在本地存储空间的剩余空间占用值不大于预设空间阈值时，被后续快照日志数据覆盖。

3.根据权利要求2所述的功能模块的日志记录方法，其特征在于，所述获取调用结束后的返回值之后，还包括：

若所述返回值正常，则所述运行日志数据被后续功能模块调用过程中产生的日志数据覆盖。

4.根据权利要求3所述的功能模块的日志记录方法，其特征在于，所述对所述运行日志数据进行快照，生成快照日志数据为采用追加方法将所述运行日志数据保存，以作为快照日志数据。

5.根据权利要求1至4任意一项所述的功能模块的日志记录方法，其特征在于，所述获取调用结束后的返回值之后，还包括：

判断远端服务器数据库中的BMC的固件版本与本地BMC的固件版本是否一致；

若否，则触发更新所述本地BMC的固件版本。

6.一种功能模块的日志记录装置，其特征在于，包括：

详细日志记录模块，用于记录一次调用功能模块的所有运行日志数据；

返回值判断模块，用于在所述功能模块调用结束后，判断调用结束后的返回值是否正常；

日志快照模块，用于若所述返回值异常，则对所述运行日志数据进行快照，生成快照日志数据。

7.根据权利要求6所述的功能模块的日志记录装置，其特征在于，还包括：

快照日志数据备份模块，用于将所述快照日志数据同步至远端服务器，以用于备份所述快照日志数据；其中，所述快照日志数据在本地存储空间的剩余空间占用值不大于预设空间阈值时，被后续快照日志数据覆盖。

8.根据权利要求6或7所述的功能模块的日志记录装置，其特征在于，还包括：

固件版本升级模块，用于若远端服务器数据库中的BMC的固件版本与本地BMC的固件版本不一致，则触发更新所述本地BMC的固件版本。

9.一种功能模块的日志记录设备，其特征在于，包括处理器，所述处理器用于执行存储器中存储的计算机程序时实现如权利要求1至5任一项所述功能模块的日志记录方法的步骤。

10.一种计算机可读存储介质，其特征在于，所述计算机可读存储介质上存储有功能模块的日志记录程序，所述功能模块的日志记录程序被处理器执行时实现如权利要求1至5任一项所述功能模块的日志记录方法的步骤。