CN110740071B - 一种网络接口监控的方法、装置及系统 - Google Patents

Abstract

本发明提供了一种网络接口监控方法、装置及系统，其中所述方法包括：根据接口文档来定制化地开发出对应的监控项目；基于所述监控项目监控HTTP状态码；校验接口返回的body数据；基于校验结果确定接口的工作状态。本发明的网络接口监控方法、装置及系统对网络接口实现了灵活精准的监控，还可以适用于可持续集成环境。

Description

一种网络接口监控的方法、装置及系统

技术领域

本发明属于互联网技术领域，尤其涉及一种网络接口监控的方法、装置及系统。

背景技术

随着互联网技术的飞速发展，人们对互联网服务的需求越来越多，对网络服务运行的稳定性、准确性和解决网络问题的及时性要求也越来越高。

网络接口是网络服务向用户提供服务的入口，通常是用户访问网络服务的地址。用户通过访问网络接口来使用网络服务并获取返回的数据。

为了掌握网络服务器的响应情况，在HTTP中设置了状态码(HTTP StatusCode)，HTTP状态码：HTTP状态码是用以表示网络服务器响应状态的3位数字代码。

对网络接口的有效监控是实现网络服务稳定良好运行的通用手段。传统的网络接口监控，是运维人员通过监控网络服务进程和查看网络服务运行日志(log)来判断网络服务是否正常运行的。这样操作的弊端是人力消耗大，日志信息纷繁复杂，挑选有效、不重复的信息效率低且准确性差，判断信息存在同样的问题。

另外网络接口有一定的特殊性，就是在网络服务进程运行、HTTP状态码返回正常，但接口返回的响应体不正常时，也会造成服务不可用。因此单纯依靠检测进程状态和HTTP状态不能准确监控接口运行状态。现有技术中存在一种叫Jmeter的技术，揭示了一种接口测试技术，它通过获取对接口的HTTP状态码和返回JSON(JavaScript Object Notation，JS对象简谱，是一种轻量级数据交换格式)对接口进行测试。Jmeter脚本的维护需要保存为本地文件，而每个脚本文件只能保存一个测试用例，不利于脚本的维护。Jmeter的测试脚本的管理不可以纳入版本控制。用Jmeter测试更需要人工测试，人工确认。综上，Jmeter不能很好的适应持续集成的监控项目，不能精准灵活地对网络接口实现自动化监控。

发明内容

本发明的目的在于克服上述现有技术中存在的缺陷，本公开提供了一种网络接口监控的方法、装置和系统。

根据本公开实施例的第一方面，提供一种网络接口监控的方法，所述方法包括：

根据接口文档来定制化地开发出对应的监控项目；

基于所述监控项目监控HTTP状态码；

校验接口返回的body数据；

基于校验结果确定接口的工作状态。

可选的，所述基于所述监控项目监控HTTP状态码具体为：

模拟接口请求，并监控返回的HTTP状态码是否是请求已经成功的HTTP状态码。

可选的，所述的网络接口监控方法具体为：

在返回的HTTP状态码是请求已经成功的HTTP状态码后，继续获取返回的body，并对所述body进行JSON格式化。

可选的，所述校验接口返回的body数据，具体为：

对所述body进行JSON格式化，是指根据接口文档预定的JSON类型，将body转换为对应类型的JSON数据的对象，如果转换失败，则确定网络接口出现异常。

可选的，所述确定接口工作状态具体为：

判断返回JSON中的字段是否完整、返回JSON中的字段的值是否符合预期。

可选的，所述的网络接口监控方法还包括：

将监控结果生成HTML报告，进行保存。

可选的，所述的网络接口监控方法还包括：

将含有接口异常的HTML报告发到指定的目的地。

可选的，所述HTML报告中包含本次接口监控执行的情况，如果有失败会在报告中列出具体失败原因。

根据本公开实施例的第二方面，提供一种网络接口监控的装置，包括：

开发模块，用于根据接口文档来定制化开发的监控项目；

监控模块，用于监控HTTP状态码；

校验模块，用于校验接口返回的body数据；

确定模块，基于校验结果确定接口的工作状态。

可选的，所述监控模块用于：

模拟接口请求，并监控返回的HTTP状态码是否是请求已经成功的HTTP状态码。

可选的，所述校验模块用于：

在返回的HTTP状态码是请求已经成功的HTTP状态码后，继续获取返回的body，并对所述body进行JSON格式化。

可选的，所述确定模块用于：

判断返回JSON中的字段是否完整、返回JSON中的字段的值是否符合预期。

可选的，所述网络接口监控装置还包括：

生成模块，用于监控结果生成HTML报告；

发送模块，用于发送HTML报告；

保存模块，用于保存HTML报告。

根据本公开实施例的第三方面，提供一种网络接口监控系统，所述系统包括至少一个处理器以及至少一个存储器；

所述存储器存储执行如上任一所述方法的计算机程序，所述处理器调用存储器中的所述计算机程序以执行如上任一所述的方法。

本公开所揭示的技术方案能够精准灵活地实现对网络接口的自动化监控，通用性更强。本发明的其它特征和优点将在随后的说明书中阐述，并且，部分地从说明书中变得显而易见，或者通过实施本发明而了解。本发明的目的和其他优点可通过在说明书、权利要求书以及附图中所指出的结构来实现和获得。

附图说明

通过结合附图对本发明实施例进行更详细的描述，本发明的上述以及其它目的、特征和优势将变得更加明显。附图用来提供对本发明实施例的进一步理解，并且构成说明书的一部分，与本发明实施例一起用于解释本发明，并不构成对本发明的限制。除非明确指出，否则附图不应视为按比例绘制。在附图中，相同的参考标号通常代表相同组件或步骤。在附图中：

图1示出了根据本发明实施例的网络接口监控方法的基本流程图；

图2示出了根据本发明实施例的网络接口状态判断基本流程图；

图3示出了根据本发明实施例的一种网络接口监控装置的基本结构图；

图4示出了根据本发明实施例的另一种网络接口监控装置的基本结构图。

具体实施方式

为了使得本发明的目的、技术方案和优点更为明显，下面将参照附图详细描述根据本发明的示例实施例。显然，所描述的实施例仅仅是本发明的一部分实施例，而不是本发明的全部实施例，应理解，本发明不受这里描述的示例实施例的限制。基于本文所描述的实施例，本领域技术人员在没有付出创造性劳动的情况下所得到的所有其它实施例都应落入本发明的保护范围之内。在本说明书和附图中，将采用相同的附图标记表示大体上相同的元素和功能，且将省略对这些元素和功能的重复性说明。此外，为了清楚和简洁，可以省略对于本领域所熟知的功能和构造的说明。

图1示出了根据本发明实施例的网络接口监控方法的流程示意图。如图1所示，本发明实施例的网络接口监控方法主要包括，首先根据接口文档来定制化开发出对应的监控项目；其次基于所述监控项目监控http状态码；再次校验接口返回的body数据；最后基于校验结果确定接口的工作状态。

进一步地，首先，持续集成网络接口的监控项目。所述监控项目包括一个或多个测试用例。

网络接口的监控项目利用一种版本管理工具进行管理，在本发明实施例采用版本管理工具管理监控项目，实现了监控项目持续集成和统一管理。示例性地在本发明实施例中，可以采用SVN(Subversion，一种开放源代码的版本控制系统)作为一种版本管理工具来实现对网络接口的监控项目进行管理。

其次，使用持续集成管理系统调度执行监控项目。

本发明实施例中，采用了一种持续集成管理工具(本实施例中为Jenkins)来调度执行上述监控项目。采用持续集成管理系统作为执行监控项目的调度工具，定期从版本管理的库(即SVN仓库)中获取最新监控项目并自动执行。

该Jenkins可以搭载在web服务器上，来实现对监控项目的调度执行。其中，在本发明实施实例中，以Tomcat作为web服务器，以Jenkins作为持续集成管理工具。本发明实施例所采用的所述搭载方法可以是：将jenkins.war包放在Tomcat服务器目录webapps下，启动Tomcat服务后，即可通过HTTP://localhost:8080/jenkins地址访问Jenkins服务。需要说明的是，上述地址是示例性的，可以根据Tomcat服务器地址和服务端口的不同进行自行调整。Jenkins按照设定周期从版本管理服务器SVN上获取监控项目代码，然后自动编译、运行。示例性地，以24小时为一个获取周期，Jenkins将每隔24小时从SVN服务器中获取监控项目代码，获得项目代码后，对项目代码进行编译，形成可执行的项目，最后运行监控项目的编译结果。需要说的是，本发明实施例中可以根据实际情况周期的长度进行设定。

使用持续集成管理工具Jenkins调度上述监控项目并执行，本发明实施例的执行，可以通过一次配置的方式达到多次重复执行的目的。并且这种配置更加方便地迁移到其他产品，因此，对不同产品的网络接口测试，只需要简单更改获取与之对应的监控项目。本发明实施例的一次执行所有项目还是可配置针对性执行，示例性地，在一次执行监控项目中，所执行的监控项目可以是所有监控项目的一部分。

使用持续集成管理工具调度执行上述监控项目，对所有待检查接口进行测试的过程如图2所示。

再次，利用监控项目对网络接口的HTTP状态码和响应体(body)进行分析判断。

根据接口文档来定制化开发出对应的监控项目，通过所述监控项目不仅监控HTTP状态码，也会校验接口返回JSON的格式、返回JSON中的字段是否完整、返回JSON中的字段的值是否符合预期。

进一步地，如图2所示本发明实施例中模拟一个接口请求，通过该接口请求获取到HTTP状态码(HTTPStatusCode)。在本发明实施例中，示例性地示出了几个HTTP状态码及其含义，如下表所示：

本发明实施例中，判断HTTP状态码是否为200。如上表所示，也即判断请求是否已经成功，如果收到的HTTP状态码为200，则可以确定请求已成功，此时，请求所希望的响应头或数据体将随此响应返回。相反，如果返回的状态码不是200，则确定网络接口运行异常，得到网络接口运行不正常的结果，此时可以不再进行以下获取和分析响应体的操作。

如果判断上述返回的HTTP状态码为200，那么继续获取返回的body，并对其进行分析。具体为，对返回的body进行JSON格式化：将返回的body字符串根据接口预定义返回类型转化为JSONObject(Java中存储JSON数据的一种对象类型)或JSONArray(JSON数组)或JSONText(JSON字符串)类型的对象。转换的过程使用Java工具包(如FastJson工具包)所提供的方法实现。以JSONObject为例，JSONObject对象通过一系列键值对(本发明实施例中，“键”与接口文档的字段相对应，“值”与应接口文档的字段值相对应)保存JSON信息。

本发明实施例中，对body格式化的过程即为JSON格式完整性的校验。对body的JSON格式化，在实施中即为数据从字符串到JSONObject的类型转换。因此如果不是以接口文档中的类型得到一个JSON对象，那么在此处就会抛出异常并终止程序，得到接口运行不正常的结果。如果JSON格式化成功，得到JSON对象，如JSONObject对象，监控程序中可以很方便地从JSONObject对象中获取特定的键值对，并与接口文档所预定的字段和字段值进行比较。从而进一步判断关键字段是否完整、正确。示例性地，将JSON数据中的code字段和id字段作为关键字段，则判断JSON数据信息中的code字段和id字段的值是否为预期值，如果code字段和id字段信息值是预期值，则可以确定网路接口运行正常，此时认为接口工作状态正常。

示例性地，

body数据如下：

将此body格式化为JSONObject：

JSONObject jsonObject＝com.alibaba.fastjson.JSON.parseObject(bodyStr)；

获取JSONObject中存储的id信息：

jsonObject.get(“id”)；

JSONObject包含的键值对，除了可以是id＝1、cod＝123这样的简单键值对，也可以包含更复杂的对象，如键值对的值可以是数组、JSON格式字符串或其组合。本实施例中，name的值[{"fistname":"Jack","lastname":"Li"}]是一个数组，数组的第一个元素{"fistname":"Jack","lastname":"Li"}是一个JSON字符串。

获取name信息，得到一个数组：

Array array＝jsonObject.get(“name”)；

获取数组中第一个元素并转化为JSONObject:

JSONObject nameObject＝com.alibaba.fastjson.JSON.parseObject(array.get(0))；

对nameObject的解析与前述JSONObject一致。

本发明实施例中，采用了状态码判断和JSON判断相结合的方式，更加方便准确地判断网络接口的运行状态。并且按照对HTTP状态码、JSON完整性、JSON关键字段正确性逐层深入的判断，进一步避免了HTTP状态码错误时后续不必要的操作。因此，本发明实施例的判断方法能够更加高效准确地作出判断。而且本发明实施例根据网络接口监控需求调整监控判断的深度和复杂度，具有较高的灵活性。而且本发明的实施例中，监控项目除了对服务接口的状态码进行监控，还对接口响应体进行数据结构分析，实现了对接口的精准监控。

最后，在执行监控项目后，将执行结果生成HTML报告并保存在web服务器中。

监控项目运行结束后，通过接口项目生成HTML报告。HTML报告包含所有执行的监控项目的结果信息，示例性地，所述结果信息可以包含每个接口监控的结果：访问的接口、状态码信息、JSON的信息、JSON校验结果、异常日志等信息。HTTP报告中包含本次接口监控执行的情况，如果有有网络接口运行异常的情况则会在报告中列出具体异常原因。HTML报告保存在Tomcat服务器中，方便人员通过浏览器查看监控结果报告。本发明实施例中，使用HTML作为报告格式，格式清晰直观，方便对错误记录进行特殊显示。

当接口发生异常时，会及时发送通知，本发明中使用Jenkins的插件EditableExtended EmailPublisher发送邮件。本发明实施例中，可以通过邮件、微信、短信等即时通信方式发送给设定的负责人。网络接口不正常时，通过上述即时通信方式将HTTP报告发送给相关责任人，相关责任人收到该HTTP报告后，可以在第一时间发现问题并且第一时间反馈，这种方式极大地缩小了线上故障时长及故障率。

本发明实施例中，对于检测到有异常的接口自动发送通知，提高监控有效性，缩短发现问题的时间。接口异常的邮件通知，降低了人工查看所有监控结果的必要性，从而节约了人力成本。

在上述方法的基础上，本发明实施例还提供了一种网络接口监控装置，如图3所示，所述网络接口监控装置包括开发模块、监控模块、校验模块、确定模块、生成模块、发送模块和保存模块等各个模块。

所述开发模块能够根据接口文档来定制化开发的监控项目；所述监控模块能够监控HTTP状态码，并可以模拟接口请求，监控返回的HTTP状态码是否是请求已经成功的HTTP状态码；所述校验模块能够校验接口返回的body数据，并可以在返回的HTTP状态码是请求已经成功的HTTP状态码后，继续获取返回的body，并对所述body进行JSON格式化；所述确定模块能够基于校验结果确定接口的工作状态；所述生成模块能够监控结果生成HTML报告；所述发送模能够发送HTML报告；所述保存模块能够保存HTML报告。

在本发明的方法可以是由计算机或嵌入式程序控制的系统来实现。因此，与之相对应地，本发明的实施例中还提供了另一种网络接口监控系统，如图4所示，所述网络接口监控系统包括至少一个处理器以及至少一个存储器；所述存储器存储执行以上本发明任意实施例方法的计算机程序，所述处理器调用存储器中计算机程序以执行本发明任意实施例方法。

进一步地，所述存储器可与所述一个或多个处理器通信连接，所述存储器中存储有可被所述一个或多个处理器执行的指令，所述指令被所述一个或多个处理器执行，以使所述一个或多个处理器能够实现本发明的方法。

本发明实施例的上述接口监控方法和装置，具有较大的通用性。如果需要移至到其他产品上，只需编写对应项目的接口测试项目，然后按照Jenkins上已经配置过的监控项目，配置新的监控项目即可。因此本技术方案具有良好的通用性。方案开发完成，后期修改维护大大降低，监控性的有效性有明显提高。

本领域技术人员应该理解的是：以上各实施例仅用以说明本发明的技术方案，而非对其限制；尽管参照前述各实施例对本发明进行了详细的说明，但本领域的技术人员可以对前述各实施例所记载的技术方案进行修改，或者对其中部分或者全部技术特征进行等同替换；而这些修改或者替换，并不使相应技术方案的本质脱离本发明权利要求书的范围。

Claims (7)

1.一种网络接口监控方法，所述方法包括：

根据接口文档来定制化地开发出对应的监控项目；

基于所述监控项目监控HTTP状态码；

校验接口返回的body数据；

基于校验结果确定接口的工作状态；

对HTTP状态码、JSON完整性、JSON关键字段正确性逐层深入的判断；

模拟接口请求，并监控返回的HTTP状态码是否是请求已经成功的HTTP状态码；

在返回的HTTP状态码是请求已经成功的HTTP状态码后，继续获取返回的body，并对所述body进行JSON格式化，包括：指根据接口文档预定的JSON类型，将body转换为对应类型的JSON数据的对象，如果转换失败，则确定网络接口出现异常；

对返回的body进行JSON格式化：将返回的body字符串根据接口预定义返回类型转化为JSONObject或JSONArray或JSONText类型的对象；

判断返回JSON中的字段的值是否符合预期，包括：从JSONObject对象中获取特定的键值对，并与接口文档所预定的字段和字段值进行比较；

采用持续集成管理工具Jenkins来调度执行所述监控项目，定期从版本管理的库中获取最新监控项目并自动执行，当接口发生异常时，使用Jenkins的插件EditableExtendedEmailPublisher发送邮件。

2.根据权利要求1所述的网络接口监控方法，其中，

将监控结果生成HTML报告，进行保存。

3.根据权利要求2所述的网络接口监控方法，其中，

将含有接口异常的HTML报告发到指定的目的地。

4.根据权利要求2或3所述的网络接口监控方法，其中，

所述HTML报告中包含本次接口监控执行的情况，如果有失败会在报告中列出具体失败原因。

5.一种网络接口监控装置，所述装置包括：

开发模块，用于根据接口文档来定制化开发的监控项目；

监控模块，用于监控HTTP状态码；

校验模块，用于校验接口返回的body数据；

确定模块，用于基于校验结果确定接口的工作状态；

所述监控模块还用于：

模拟接口请求，并监控返回的HTTP状态码是否是请求已经成功的HTTP状态码；

所述校验模块还用于：

在返回的HTTP状态码是请求已经成功的HTTP状态码后，继续获取返回的body，并对所述body进行JSON格式化，包括：指根据接口文档预定的JSON类型，将body转换为对应类型的JSON数据的对象，如果转换失败，则确定网络接口出现异常；将返回的body字符串根据接口预定义返回类型转化为JSONObject或JSONArray或JSONText类型的对象；

所述确定模块还用于：

判断返回JSON中的字段是否完整、返回JSON中的字段的值是否符合预期，包括：从JSONObject对象中获取特定的键值对，并与接口文档所预定的字段和字段值进行比较；

所述确定模块对HTTP状态码、JSON完整性、JSON关键字段正确性逐层深入的判断；

采用持续集成管理工具Jenkins来调度执行所述监控项目，定期从版本管理的库中获取最新监控项目并自动执行，当接口发生异常时，使用Jenkins的插件EditableExtendedEmailPublisher发送邮件。

6.根据权利要求5所述的网络接口监控装置，所述网络接口监控装置还包括：

生成模块，用于监控结果生成HTML报告；

发送模块，用于发送HTML报告；

保存模块，用于保存HTML报告。

7.一种网络接口监控系统，所述系统包括至少一个处理器以及至少一个存储器；

所述存储器存储执行权利要求1－4任一所述方法的计算机程序，所述处理器调用存储器中的所述计算机程序以执行权利要求1－4任一所述的方法。

Images