CN110096419A - 接口日志的获取方法、接口日志管理服务器及业务服务器 - Google Patents

Abstract

本发明实施例涉及互联网技术领域，公开了一种接口日志的获取方法、接口日志管理服务器及业务服务器。本发明实施方式中，收集各业务系统上报的接口日志，其中接口日志为业务系统响应于接口调用请求而生成的；接口日志中至少包括接口标识信息，接口标识信息是基于接口调用请求中携带的接口标识信息实时生成的；响应于接口日志查找指令，基于接口日志查找指令及接口标识信息从收集到的接口日志中查找并显示目标接口日志。方便运营人员快速查看各服务器的接口日志，并可根据这些接口日志快速定位故障。

Description

接口日志的获取方法、接口日志管理服务器及业务服务器

技术领域

本发明实施例涉及互联网技术领域，特别涉及一种接口日志的获取方法、接口日志管理服务器及业务服务器。

背景技术

在一个完整的信息系统里面，日志系统是一个非常重要的功能组成部分，它可以记录下系统所产生的所有行为，并按照某种规范表达出来。运营人员可根据日志系统所记录的信息为系统进行排错，优化系统的性能，或者根据这些信息调整系统的行为。

应用程序接口是一些预先定义的函数，目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力，而又无需访问源码，或理解内部工作机制的细节。举个例子，研发人员在开发第一款应用软件的过程中，想要调用第二款软件的部分功能来用，显然，研发人员一行一行看第二款软件的源码并分析其功能实现的过程是非常耗精力的，而且第二款软件的源码也不一定会公开，因此，研发人员想要调用第二款软件的部分功能有一定的困难。在实际开发过程中，为了解决这个问题，软件的开发人员通常会将软件的各个功能模块写成函数进行封装，当有运营人员想要调用某个功能模块时，直接调用这个功能模块对应的函数接口就行了，不需要了解具体的功能实现过程，这样，既能保运营人员能够使用这个功能，又能保证源代码不被泄露，同时也可时软件的价值更大，更具生命力。也就是说，在实际应用中，各种应用软件的服务器，一般都会提供一些接口供其他服务器调用。

发明人发现现有技术中至少存在如下问题：运营人员在定位故障的过程中，在搜索日志时，由于查找的条件无法很精确，因此往往会出现多条日志记录，这时需要再根据请求时间去分析具体对应哪一条日志信息，这样耗时耗力，日志分析的时间长，定位故障的时间也就很长。

发明内容

本发明实施方式的目的在于提供一种接口日志的获取方法、接口日志管理服务器及业务服务器，可方便运营人员快速查看各服务器的接口日志，并可根据这些接口日志快速定位故障。

为解决上述技术问题，本发明的实施方式提供了一种接口日志获取方法，包括以下步骤：收集各业务系统上报的接口日志，其中接口日志为业务系统响应于接口调用请求而生成的；接口日志中至少包括接口标识信息，接口标识信息是基于接口调用请求中携带的接口标识信息实时生成的；响应于接口日志查找指令，基于接口日志查找指令及接口标识信息从收集到的接口日志中查找并显示目标接口日志。

本发明的实施方式还提供了一种接口日志管理服务器，包括：至少一个处理器；以及，与至少一个处理器通信连接的存储器；其中，存储器存储有可被至少一个处理器执行的指令，指令被至少一个处理器执行，以使至少一个处理器能够执行上述的接口日志获取方法。

本发明的实施方式还提供了一种非易失性存储介质，用于存储计算机可读程序，所述计算机可读程序用于供计算机执行上述的接口日志获取方法。

本发明实施方式相对于现有技术而言，通过收集各业务系统上报的接口日志，可将各业务系统的接口日志集中起来；其中，接口日志为业务系统响应于接口调用请求而生成的；接口日志中至少包括接口标识信息，接口标识信息是基于接口调用请求中携带的接口标识信息实时生成的；基于日志查看指令和接口标识信息，就可直接在收集的接口日志中查找与日志查找信息对应的接口日志，由于接口日志不再与其他的日志信息混在一起，因此过滤掉了许多非接口日志，减轻了运营人员在查看接口日志的时候的工作量，从而大大节省了运营人员排查问题的时间；各服务器的接口日志汇总在一个平台上，运营人员可直接在这个平台上看到各个服务器的接口日志，这样在查找各个服务器之间的调用情况的时候就方便得多；而且各业务系统的接口日志中的接口标识信息与调用方的接口标识信息相关，因此可更快速地找到是哪两个业务系统之间进行接口调用时调用失败，从而可使得运营人员能够更快速的定位故障。

另外，接口标识信息还包括：调用顺序编号，调用顺序编号用于标识接口日志所属业务系统在在处理一次用户请求过程中被调用的顺序。设置调用顺序编号，使得在处理一次用户访问的过程中，每个接口被调用的顺序都被记录下来，方便运营人员查看一次用户请求过程中的接口调用链路。

另外，调用顺序编号的生成方法包括：获取接口调用请求中携带的接口标识信息；若接口调用请求中携带的接口标识信息为空，则将调用顺序编号设置为用于指示首次调用的值，若接口调用请求中携带的接口标识信息不为空，则根据接口调用请求中携带的接口标识信息所包含的调用顺序编号，确定当前调用顺序编号。根据接口调用请求中的接口标识信息，可了解到调用方在处理一次用户请求的过程中被调用的次序，从而方便运营人员了解到用户请求的调用链路，而且根据调用方的接口调用请求中包含的调用顺序编号确定业务系统在处理一次用户请求过程中被调用的次序，结果可靠，可实施性强。

另外，上述根据接口调用请求中的接口标识信息所包含的调用顺序编号，确定当前调用顺序编号，具体包括：将接口调用请求中携带的接口标识信息所包含的调用顺序编号加上一预设值，作为当前调用顺序编号，其中预设值大于零。将接口调用请求中包含的调用顺序编号加上预设值从而得到本次接口调用的调用顺序，使得在处理一次用户访问的过程中，每个接口的调用顺序以递增的方式记录下来，实现简单，方便运营人员查看业务系统的调用情况以及对故障进行定位。

另外，上述接口标识信息根据以下信息按照预设的编码规则生成：业务系统的标识、接口资源标识符、用户请求的标识信息、调用顺序编号。接口标识信息中包括的这些信息能够清楚地体现出被调用的业务系统、被调用的接口、此次调用具体对应的哪一个用户请求以及接口被调用的顺序，从而使得运营人员全面掌握处理一次用户请求的过程中用到的业务系统资源，而对这些信息按照预设的编码规则进行编码可使得不同的业务系统之间顺利进行信息传递。

另外，接口日志查找指令包含查找在处理目标用户请求过程中，生成的目标接口日志，基于接口日志查找指令及接口标识信息从收集到的接口日志中查找并显示目标接口日志具体包括：查找出接口标识信息中包含目标用户请求的标识信息的接口日志，确定为目标接口日志；提取目标接口日志的接口标识信息中的调用顺序编号；按照调用顺序编号，依次显示目标接口日志。将包含目标用户请求标识信息的接口日志查找出来，并按照调用顺序编号依次显示，从而能够以最直观的方式向运营人员展示在处理目标用户请求过程中用的所有接口以及调用的次序，方便运营人员分析问题。

另外，上述方法还包括：响应于接口日志统计指令，从收集到的接口日志中确定出接口日志统计指令对应的待分析接口日志，基于接口日志统计指令及待分析接口日志包含的接口标识信息，对待分析接口日志进行统计并显示统计结果。对待分析的接口日志进行统计并显示统计结果，可帮助运营人员根据待分析接口日志的分析结果查找问题。

附图说明

一个或多个实施例通过与之对应的附图中的图片进行示例性说明，这些示例性说明并不构成对实施例的限定。

图1是根据本发明第一实施方式提供的接口日志获取方法流程图；

图2是根据本发明第二实施方式提供的接口日志获取方法流程图；

图3是根据本发明第三实施方式提供的接口日志管理服务器结构示意图。

具体实施方式

为使本发明实施例的目的、技术方案和优点更加清楚，下面将结合附图对本发明的各实施方式进行详细的阐述。然而，本领域的普通技术人员可以理解，在本发明各实施方式中，为了使读者更好地理解本申请而提出了许多技术细节。但是，即使没有这些技术细节和基于以下各实施方式的种种变化和修改，也可以实现本申请所要求保护的技术方案。以下各个实施例的划分是为了描述方便，不应对本发明的具体实现方式构成任何限定，各个实施例在不矛盾的前提下可以相互结合相互引用。

本发明的第一实施方式涉及一种接口日志获取方法。本实施方式中，收集各业务系统上报的接口日志，其中接口日志为业务系统响应于接口调用请求而生成的；接口日志中至少包括接口标识信息，接口标识信息是基于接口调用请求中携带的接口标识信息实时生成的；响应于接口日志查找指令，基于接口日志查找指令及接口标识信息从收集到的接口日志中查找并显示目标接口日志。大大节省了运营人员排查问题的时间，而且可帮助运营人员快速定位故障。下面对本实施方式的接口日志获取方法的实现细节进行具体的说明，以下内容仅为方便理解提供的实现细节，并非实施本方案的必须。

本实施方式中的接口日志获取方法流程图如图1所示，下面进行具体说明。

步骤101，收集各业务系统上报的接口日志。

具体地说，接口日志为业务系统响应于接口调用请求而生成的日志，运营人员可在各业务系统中编写脚本文件，使得各业务系统能够将自身的接口日志上报至一个统一的接口日志管理服务器，由接口日志管理服务器来周期性收集各业务系统上报的接口日志，接口日志中包括接口调用发生的时间、接口调用是否成功等信息，还包括接口标识信息，这里所说的接口标识信息是基于接口调用请求中携带的接口标识信息实时生成的，在实际实施中，各个接口之间进行调用时会通过接口调用请求来传递接口标识信息，也就是说，被调用的业务系统的接口标识信息与调用方的接口标识信息相关。例如，业务系统A响应于业务系统B发送的接口调用请求后，解析业务系统B发送的接口调用请求，并根据解析结果中包含的接口标识信息，生成自己的接口标识信息。

具体地说，接口标识信息中可包括调用顺序编号，调用顺序编号用于标识所述接口日志所属业务系统在处理一次用户请求过程中被调用的顺序。若调用方的接口调用请求中携带的接口标识信息为空，表明当前接口所属的业务系统是在响应这次用户请求中第一个被调用的业务系统，可将调用顺序编号设置为用于指示首次调用的值，例如，在处理一次用户请求时，需要先调用业务系统A的接口1，再由业务系统A调用业务系统B的接口2，那么，接口1被调用的顺序为首次调用，调用顺序编号可设置为1，接口2被调用的顺序为第二次被调用，调用顺序编号可为2。若调用方的接口调用请求中携带的接口标识信息不为空，表明当前接口所属的业务系统在这次用户请求中是在调用方业务系统被调用之后再被调用的，可根据接口调用请求中的接口标识信息包含的调用顺序，确定当前的调用顺序，比如，可将接口调用请求中携带的接口标识信息所包含的调用顺序编号加上一大于零的预设值，作为当前所述调用顺序编号。在一个例子中，预设值为1，业务系统B接收到业务系统A发送的调用业务系统B的接口2的接口调用请求，这个接口调用请求中存在接口标识信息，且该接口标识信息中的调用顺序编号为3，那么业务系统B的接口2的接口标识信息中的调用顺序编号可为3+1＝4。

步骤102，响应于接口日志查找指令，基于所述接口日志查找指令及所述接口标识信息从收集到的所述接口日志中查找并显示目标接口日志。

具体地说，运营人员在需要查找日志时，可以向接口日志管理服务器发出日志查找指令，在接收到日志查找指令后，接口日志管理服务器响应该接口日志查找指令，从收集到的接口日志中查找符合要求的目标接口日志，并提供一个日志看板，将查找到的目标接口日志显示在这个看板上。

在实际应用中，为了完成某个用户请求，仅仅依靠一个业务系统一般是完不成的，通常需要一个业务系统调用另一个业务系统，甚至需要一个业务系统调用多个其他业务系统才能完成，在这个调用的过程中，如果某个业务系统的服务器发生了故障导致调用不成功，在客户端，只能看到请求失败而并不能知道故障发生的原因，运营人员为了找出问题，需要去查看系统日志，根据请求发生的时间，请求的接口类型等得到相关的日志，再根据这些日志信息去排查出到底是在调用哪个服务器的被调用的时候调用失败，定位问题。

在这个过程中，由于各个服务器的系统日志数量很多，在一个个系统中查找相应的接口日志步骤繁琐，非常耗时。本实施方式相对现有技术而言，通过收集各业务系统上报的接口日志，可将各业务系统的接口日志集中起来；其中，接口日志为业务系统响应于接口调用请求而生成的；接口日志中至少包括接口标识信息，接口标识信息是基于接口调用请求中携带的接口标识信息实时生成的；基于日志查看指令和接口标识信息，就可直接在收集的接口日志中查找与日志查找信息对应的接口日志，由于接口日志不再与其他的日志信息混在一起，因此过滤掉了许多非接口日志，减轻了运营人员在查看接口日志的时候的工作量，从而大大节省了运营人员排查问题的时间；各服务器的接口日志汇总在一个平台上，运营人员可直接在这个平台上看到各个服务器的接口日志，这样在查找各个服务器之间的调用情况的时候就方便得多；而且各业务系统的接口日志中的接口标识信息与调用方的接口标识信息相关，因此可更快速地找到是哪两个业务系统之间进行接口调用时调用失败，从而可使得运营人员能够更快速的定位故障。

本发明的第二实施方式涉及一种接口日志获取方法。第二实施方式与第一实施方式大致相同，主要区别之处在于：在本发明第二实施方式中，接口日志查找指令包含查找在处理目标用户请求过程中，生成的目标接口日志，接口日志管理服务器会将包含目标用户请求标识信息的接口日志查找出来，并按照调用顺序编号依次显示。

在本实施方式中，接口标识信息中包括业务系统的标识、接口资源标识符、用户请求的标识信息和调用顺序编号，这些信息可采用索引编码的方式，按一定的编码规则组成一个接口标识信息。

其中，业务系统的标识可用于确定接口日志来源于哪个业务系统；接口资源标识符可用于确定日志对应业务系统中的哪个接口，即具体是业务系统中的哪个接口被调用时生成的；用户请求的标识信息用于确定该日志是针对哪个用户请求而生成的，用户请求的标识信息可用随机码的方式来表示，即随机获得一个唯一值来标识具体的用户请求。接口标识信息中包括的这些信息能够清楚地体现出被调用的业务系统、被调用的接口、此次调用具体对应的哪一个用户请求以及接口被调用的顺序，从而使得运营人员全面掌握处理一次用户请求的过程中用到的业务系统资源，而对这些信息按照预设的编码规则进行编码可使得不同的业务系统之间顺利进行信息传递。

本实施方式的具体流程图如图2所示，下面进行具体说明。

步骤201，收集各业务系统上报的接口日志。

步骤201与第一实施方式中的步骤101大致相同，为避免重复，这里不再赘述。

步骤202，响应于接口日志查找指令，查找出接口标识信息中包含目标用户请求的标识信息的接口日志，确定为目标接口日志。

具体地说，接口日志查找指令可包含查找在处理目标用户请求过程中，生成的目标接口日志。由于在处理目标用户请求的过程中，生成的接口日志的接口标识信息中都会包括目标用户请求的标识信息，在接口日志查找指令中指定目标用户请求的标识信息，接口日志管理服务器在响应接口日志查找指令后，就可以基于目标用户的标识信息，查找出在目标用户请求过程中所有被调用的接口对应的接口日志。

在其他实现方法中，接口日志查找指令中，也可以包括接口日志发生的时间、待查找的接口标识、或者其他的接口标识信息等。在实际实施中，若想要查找某次用户请求过程中所有被调用的接口对应的接口日志，也可适当调整查找的日志发生的时间，例如，用户请求发生的时间为12:00，那么可以在接口日志查找指令中设置要查找的接口日志生成的时间在11；55至12:05之间，从而得到在这个时间段内生成的所有接口日志，再结合日志查找指令中的用户请求标识信息等，就可以筛选出目标接口日志。

步骤203，提取目标接口日志的接口标识信息中的调用顺序编号。

具体地说，在找到各个目标接口日志后，可将解析出的调用顺序编码提取出来。

步骤204，按照调用顺序编号，依次显示目标接口日志。

具体地说，在提取出调用顺序编码后，可按照调用顺序编号对各个目标接口日志进行排序，并按照排序结果在日志看板上依次显示目标接口日志，其中，各个接口日志的接口标识信息显示于接口日志的头部。

值得一提的是，接口日志管理服务器在收集接口日志后，若检测到某个接口日志记录的接口调用结果为调用失败，可从该接口日志所属的业务系统中收集该接口调用的具体过程的日志记录。例如，接口日志记录了业务系统B的接口2在12：00被业务系统A调用时调用失败，那么接口日志管理服务器可收集业务系统A从11：50开始到12：00与业务系统B发生数据交互的所有日志信息，从而确定在这个接口调用的过程中具体是哪个数据交互的过程出现了问题。对于接口调用失败的接口日志，收集关于这个接口调用的详细日志信息可帮助运营人员分析接口调用失败的具体原因。

另外，在实际实施中，运营人员还可向接口日志管理服务器发出日志统计指令，日志统计指令具体可以是接口调用成功率的统计、还可以是针对某个接口的日志数量统计、某个业务系统的所有接口的统计等，针对不同的统计需求，统计指令的形式也不同，例如，针对接口调用成功率的统计，统计指令中就包含接口标识以及计算调用成功率的函数名，而针对某个接口的日志统计，统计指令中就包含接口标识以及计算日志数量的函数名。接口日志管理服务器响应于接口日志统计指令，从收集到的接口日志中确定出接口日志统计指令对应的待分析接口日志，基于接口日志统计指令及待分析接口日志包含的接口标识信息，对待分析接口日志进行统计并显示统计结果可帮助运营人员根据待分析接口日志的分析结果查找问题。

本实施方式相对现有技术而言，将包含目标用户请求标识信息的接口日志查找出来，并按照调用顺序编号依次显示，从而能够以最直观的方式向运营人员展示在处理目标用户请求过程中地道用的所有接口以及调用的次序，方便运营人员分析问题。

上面各种方法的步骤划分，只是为了描述清楚，实现时可以合并为一个步骤或者对某些步骤进行拆分，分解为多个步骤，只要包括相同的逻辑关系，都在本专利的保护范围内；对算法中或者流程中添加无关紧要的修改或者引入无关紧要的设计，但不改变其算法和流程的核心设计都在该专利的保护范围内。

本发明第三实施方式涉及一种接口日志管理服务器，如图3所示，接口日志管理服务器300包括至少一个处理器301；以及，与至少一个处理器301通信连接的存储器302；其中，存储器302存储有可被至少一个处理器301执行的指令，指令被至少一个处理器301执行，以使至少一个处理器301能够执行上述的接口日志获取方法。

其中，存储器302和处理器301采用总线方式连接，总线可以包括任意数量的互联的总线和桥，总线将一个或多个处理器301和存储器302的各种电路连接在一起。总线还可以将诸如外围设备、稳压器和功率管理电路等之类的各种其他电路连接在一起，这些都是本领域所公知的，因此，本文不再对其进行进一步描述。总线接口在总线和收发机之间提供接口。收发机可以是一个元件，也可以是多个元件，比如多个接收器和发送器，提供用于在传输介质上与各种其他装置通信的单元。经处理器301处理的数据通过天线在无线介质上进行传输，进一步，天线还接收数据并将数据传送给处理器301。

处理器301负责管理总线和通常的处理，还可以提供各种功能，包括定时，外围接口，电压调节、电源管理以及其他控制功能。而存储器302可以被用于存储处理器301在执行操作时所使用的数据。

本发明第四实施方式涉及一种计算机可读存储介质，存储有计算机程序。计算机程序被处理器执行时实现上述方法实施例。

即，本领域技术人员可以理解，实现上述实施例方法中的全部或部分步骤是可以通过程序来指令相关的硬件来完成，该程序存储在一个存储介质中，包括若干指令用以使得一个设备(可以是单片机，芯片等)或处理器(processor)执行本申请各个实施例方法的全部或部分步骤。而前述的存储介质包括：U盘、移动硬盘、只读存储器(ROM，Read-OnlyMemory)、随机存取存储器(RAM，Random Access Memory)、磁碟或者光盘等各种可以存储程序代码的介质。

本领域的普通技术人员可以理解，上述各实施方式是实现本发明的具体实施例，而在实际应用中，可以在形式上和细节上对其作各种改变，而不偏离本发明的精神和范围。

Claims (10)

1.一种接口日志获取方法，其特征在于，包括：

收集各业务系统上报的接口日志，其中所述接口日志为所述业务系统响应于接口调用请求而生成的；所述接口日志中至少包括接口标识信息，所述接口标识信息是基于所述接口调用请求中携带的接口标识信息实时生成的；

响应于接口日志查找指令，基于所述接口日志查找指令及所述接口标识信息从收集到的所述接口日志中查找并显示目标接口日志。

2.根据权利要求1所述的接口日志获取方法，其特征在于，

所述接口标识信息中包括调用顺序编号，所述调用顺序编号用于标识所述接口日志所属业务系统在处理一次用户请求过程中被调用的顺序。

3.根据权利要求2所述的接口日志获取方法，其特征在于，所述调用顺序编号的生成方法包括：

获取所述接口调用请求中携带的接口标识信息；

若所述接口调用请求中携带的接口标识信息为空，则将所述调用顺序编号设置为用于指示首次调用的值，若所述接口调用请求中携带的接口标识信息不为空，则根据所述接口调用请求中携带的接口标识信息所包含的调用顺序编号，确定当前所述调用顺序编号。

4.根据权利要求3所述的接口日志获取方法，其特征在于，所述根据所述接口调用请求中的接口标识信息所包含的调用顺序编号，确定当前所述调用顺序编号，具体包括：

将所述接口调用请求中携带的接口标识信息所包含的调用顺序编号加上一预设值，作为当前所述调用顺序编号，其中所述预设值大于零。

5.根据权利要求2至4中任一项所述的接口日志获取方法，其特征在于，所述接口标识信息根据以下信息按照预设的编码规则生成：业务系统的标识、接口资源标识符、用户请求的标识信息、调用顺序编号。

6.根据权利要求5所述的接口日志获取方法，其特征在于，

所述接口日志查找指令包含查找在处理目标用户请求过程中，生成的目标接口日志；

所述基于所述接口日志查找指令及所述接口标识信息从收集到的所述接口日志中查找并显示目标接口日志具体包括：

查找出接口标识信息中包含所述目标用户请求的标识信息的所述接口日志，确定为所述目标接口日志；

提取所述目标接口日志的所述接口标识信息中的所述调用顺序编号；

按照所述调用顺序编号，依次显示所述目标接口日志。

7.根据权利要求5所述的接口日志获取方法，其特征在于，

所述接口标识信息显示于所述接口日志的头部。

8.根据权利要求5所述的接口日志获取方法，其特征在于，所述方法还包括：

响应于接口日志统计指令，从收集到的所述接口日志中确定出所述接口日志统计指令对应的待分析接口日志，基于所述接口日志统计指令及所述待分析接口日志包含的接口标识信息，对所述待分析接口日志进行统计并显示统计结果。

9.一种接口日志管理服务器，其特征在于，包括：

至少一个处理器；以及，

与所述至少一个处理器通信连接的存储器；其中，

所述存储器存储有可被所述至少一个处理器执行的指令，所述指令被所述至少一个处理器执行，以使所述至少一个处理器能够执行如权利要求1至8中任一所述的接口日志获取方法。

10.一种非易失性存储介质，用于存储计算机可读程序，所述计算机可读程序用于供计算机执行如权利要求1至8中任一项所述的接口日志获取方法。