CN116915648A - 接口监控方法、装置、服务器及存储介质 - Google Patents

Abstract

本申请涉及接口监控技术领域，特别涉及一种接口监控方法、装置、服务器及存储介质，其中，包括：获取业务系统的接口参数；根据所述接口参数配置所述业务系统的接口监控功能，通过所述业务系统的接口监控功能采集接口数据；根据所述接口数据确定接口的当前状态，并根据所述当前状态生成提示信息，利用所述提示信息进行监控提示。由此，解决了相关技术中无法及时获取接口的实际情况导致出现异常情况无法及时处理，用户的使用体验感较差等问题。

Description

接口监控方法、装置、服务器及存储介质

技术领域

本申请涉及接口监控技术领域，特别涉及一种接口监控方法、装置、服务器及存储介质。

背景技术

现如今各行各业已经把大量的产品转换为微服务的解决方案；巨量的Web数据接口成为了各服务模块之间通信的最基本元素，也是业务开发和整合的核心。

相关技术中，仅能监控当前系统的运行情况、CPU使用率以及内存使用情况，并不能监控到接口的返回时长和失败率，导致当用户由于个人操作失误或者系统存在故障，或是接口返回超时、失败率过高等情况时，无法及时得知和处理，用户的使用体验感较差。

发明内容

本申请提供一种接口监控方法、装置、服务器及存储介质，以解决相关技术中无法及时获取接口的实际情况导致出现异常情况无法及时处理，用户的使用体验感较差等问题。

本申请第一方面实施例提供一种接口监控方法，包括以下步骤：获取业务系统的接口参数；根据所述接口参数配置所述业务系统的接口监控功能，通过所述业务系统的接口监控功能采集接口数据；根据所述接口数据确定接口的当前状态，并根据所述当前状态生成提示信息，利用所述提示信息进行监控提示。

可选地，所述根据所述接口参数配置所述业务系统的接口监控功能，包括：启动类声明的注解版和注解配置；根据所述注解版和所述注解配置自定义注解；

根据所述注解定义切面实现类，利用所述切面实现类配置接口监控功能的相关参数。

可选地，所述相关参数包括接口数据请求出入参、返回值以及接口耗时，在利用所述切面实现类配置接口监控功能的相关参数之后，还包括：将接口数据请求出入参、返回值以及接口耗时写入预设数据库。

可选地，所述根据所述接口数据监控接口的当前状态，包括：识别业务系统的接口响应时长；若接口响应时长大于或等于预设阈值，则所述接口的当前状态为第一状态，否则接口的当前状态为第二状态。

可选地，所述根据所述接口数据监控接口的当前状态，还包括：获取接口返回状态码标识；当接口返回状态码标识满足预设标识时，则所述接口响应请求失败，此时接口的当前状态为第一状态，否则接口响应请求成功且接口的当前状态为第二状态。

可选地，在根据所述当前状态生成提示信息，包括：若所述当前状态为第一状态，则生成提示信息。

可选地，在根据所述当前状态生成提示信息之后，还包括：根据所述提示信息控制告警系统的报警组件执行预设提醒动作。

本申请第二方面实施例提供一种装置，所述装置包括：获取模块，用于获取业务系统的接口参数；配置模块，用于根据所述接口参数配置所述业务系统的接口监控功能，通过所述业务系统的接口监控功能采集接口数据；监控模块，用于根据所述接口数据监控接口的当前状态，并根据所述当前状态生成提示信息，利用所述提示信息进行监控提示。

本申请第三方面实施例提供一种服务器，包括：存储器、处理器及存储在所述存储器上并可在所述处理器上运行的计算机程序，所述处理器执行所述程序，以实现如上述实施例所述的接口监控方法。

本申请第四方面实施例提供一种计算机可读存储介质，其上存储有计算机程序，该程序被处理器执行，以用于实现如上述实施例所述的接口监控方法。

由此，本申请至少具有如下有益效果：

本申请实施例可以通过接口监控功能采集接口数据并确定接口的当前状态，根据当前状态判断接口是否异常，以生成相关提示信息提示维护人员及时处理，提升了系统的稳定性，提高了用户的使用体验。

本申请附加的方面和优点将在下面的描述中部分给出，部分将从下面的描述中变得明显，或通过本申请的实践了解到。

附图说明

本申请上述的和/或附加的方面和优点从下面结合附图对实施例的描述中将变得明显和容易理解，其中：

图1为根据本申请实施例提供的一种接口监控方法的流程图；

图2为根据本申请实施例提供的接口监控方法的整体方案流程图；

图3为根据本申请实施例提供的接口监控装置的方框图；

图4为根据本申请实施例的服务器的结构示意图。

具体实施方式

下面详细描述本申请的实施例，所述实施例的示例在附图中示出，其中自始至终相同或类似的标号表示相同或类似的元件或具有相同或类似功能的元件。下面通过参考附图描述的实施例是示例性的，旨在用于解释本申请，而不能理解为对本申请的限制。

下面参考附图描述本申请实施例的接口监控方法、装置、服务器及存储介质。针对上述背景技术中提到的相关技术中无法及时获取接口的实际情况导致出现异常情况无法及时处理，用户的使用体验感较差的问题，本申请提供了一种接口监控方法，在该方法中，获取业务系统的接口参数配置接口监控功能，并通过业务系统的接口监控功能采集接口数据，根据接口数据确定接口的当前状态以生成相应的提示信息，利于提示信息进行监控提示，从而及时得知接口的实际情况，并在出现异常情况能够及时通知工作人员快速处理，提升了系统的稳定性，提升了用户的使用体验。由此，解决了相关技术中无法及时获取接口的实际情况导致出现异常情况无法及时处理，用户的使用体验感较差等问题。

具体而言，图1为本申请实施例所提供的一种接口监控方法的流程示意图。

如图1所示，该接口监控方法包括以下步骤：

在步骤S101中，获取业务系统的接口参数。

可以理解的是，本申请实施例通过获取业务系统的接口参数，以便于后续配置业务系统的接口监控功能。

在步骤S102中，根据接口参数配置业务系统的接口监控功能，通过业务系统的接口监控功能采集接口数据。

可以理解的是，本申请实施例利用接口参数配置业务系统的接口监控功能，并利用接口监控功能采集接口数据，以便于后续根据接口数据确定接口当前状态。

在本申请实施例中，根据接口参数配置业务系统的接口监控功能，包括：启动类声明的注解版和注解配置；根据注解版和注解配置自定义注解；根据注解定义切面实现类，利用切面实现类配置接口监控功能的相关参数。

其中，相关参数包括接口数据请求出入参、返回值以及接口耗时。

可以理解的是，本申请实施例先启动类声明的注解版和注解配置，并配置自定义注解，根据注解定义切面实现类以配置接口监控功能的相关参数，以便于后续利用接口监控功能采集接口数据。

具体地，在业务系统中开启SpringAOP功能，在启动类声明开启@EnableAspectJAutoProxy，开启SpringAOP注解配置；其次声明一个自定义注解，定义切面实现类，切面实现类中定义方法01实现@Pointcut(value＝自定义注解)，其次继续声明一个方法02(实现@Around(方法01))，方法02实现收集接口数据请求出入参，返回值以及接口耗时。

在本申请实施例中，在利用切面实现类配置接口监控功能的相关参数之后，还包括：将接口数据请求出入参、返回值以及接口耗时写入预设数据库。

其中，预设数据库可以是elasticsearch，不做具体限定。

可以理解的是，本申请实施例将接口数据中请求出入参、返回值以及接口耗时写入预设数据库，以便于后续从预设数据库获取相关接口数据。

在步骤S103中，根据接口数据确定接口的当前状态，并根据当前状态生成提示信息，利用提示信息进行监控提示。

可以理解的是，本申请实施例可以根据接口数据确定接口的当前状态，根据当前状态生成对应的提示信息，并利用提示信息进行监控提示，从而及时得知接口的实际情况，并在出现异常情况能够及时通知工作人员快速处理，适用性较高，且提升了系统的稳定性。

具体地，告警系统需集成多种告警方式，如邮件，短信，电话，企业微信等方式，也需要提供配置告警方式，提供不同的个性化告警方式，根据告警数据的严重性提供不同的告警信息。

需要说明的是，本申请实施例中根据接口数据监控接口的当前状态不仅可以通过获取接口的响应时长进行判断，还可以根据接口返回状态码标识是否正常进行判断，不做具体限定。

作为一种可能实现的方式，根据接口数据监控接口的当前状态，包括：识别业务系统的接口响应时长；若接口响应时长大于或等于预设阈值，则接口的当前状态为第一状态，否则接口的当前状态为第二状态。

其中，预设阈值可以是10s，可根据实际情况进行标定，不做具体限定。

其中，第一状态为异常状态，第二状态为正常状态。

可以理解的是，本申请实施例通过识别业务系统的接口响应时长判断接口的当前状态是否存在异常，以便于后续根据实际情况进行提示。

作为另一种可能实现的方式，根据接口数据监控接口的当前状态，还包括：获取接口返回状态码标识；当接口返回状态码标识满足预设标识时，则接口响应请求失败，此时接口的当前状态为第一状态，否则接口响应请求成功且接口的当前状态为第二状态。

其中，预设条件为接口返回状态码标识显示正常，不做具体限定。

可以理解的是，本申请实施例根据接口返回状态码标识判断接口的当前状态是否存在异常，以便于后续根据实际情况进行提示。

需要说明的是，状态码标识第一位数字决定了不同的响应状态，有如下：1、消息；2、成功；3、重定向；4、请求错误；5、服务器错误。

在本申请实施例中，在根据当前状态生成提示信息，包括：若当前状态为第一状态，则生成提示信息。

可以理解的是，本申请实施例在接口的当前状态为异常状态时，生成提示信息。

具体地，提示信息可以是“错误请求！”或是“请求超时！”等，不做具体限定。

在本申请实施例中，在根据当前状态生成提示信息之后，还包括：根据提示信息控制告警系统的报警组件执行预设提醒动作。

其中，预设提醒动作可以是控制告警系统执行光学提醒或声学提醒或是推送相关消息至客户端。

可以理解的是，本申请实施例根据提示信息控制告警系统的报警组件执行预设提醒动作，以及时告知工作人员出现异常情况，并快速处理。

根据本申请实施例提出的接口监控方法，获取业务系统的接口参数配置接口监控功能，并通过业务系统的接口监控功能采集接口数据，根据接口数据确定接口的当前状态以生成相应的提示信息，利于提示信息进行监控提示，从而及时得知接口的实际情况，并在出现异常情况能够及时通知工作人员快速处理，提升了系统的稳定性，提升了用户的使用体验。

下面将结合图2对本申请的接口监控监控方法进行详细阐述，具体步骤如下：

(1)通过SpringAOP环绕切面方法收集接口信息，将收集的数据存入elasticsearch中

在业务系统中开启SpringAOP功能，在启动类声明开启@EnableAspectJAutoProxy，开启SpringAOP注解配置。其次声明一个自定义注解，定义切面实现类，切面实现类中定义方法01实现@Pointcut(value＝自定义注解)，其次继续声明一个方法02(实现@Around(方法01))，方法02实现收集接口数据请求出入参，返回值以及接口耗时，再将这些数据写入到elasticsearch中。

(2)定时任务系统处理elasticsearch的数据

定时任务可以提供个性化配置去筛选处理elasticsearch中的数据，可以监控某个时间段的接口成功率，接口响应耗时等，也可以提供主动调用查询接口性能等功能，定时任务框架也可以使用xxl-job、powerjob等；一旦有发现有预期外的数据，比如某个时间段内接口请求失败率过高，超过设定的阈值，就可以将该信息通知到告警系统，例如五分钟内超50％的请求返回失败或者有接口请求耗时超过10秒的，不做具体限定。

(3)告警系统通知维护人员

告警系统需要提供给定时任务调用的rest接口，告警系统需集成多种告警方式，如邮件，短信，电话，企业微信等方式，也需要提供配置告警方式，提供不同的个性化告警方式，根据告警数据的严重性提供不同的告警信息。

当系统维护人员收到告警信息就可以第一时间去定位和解决系统问题，不需要等到很多用户来投诉才去排查问题，这样既耗时又会影响用户的体验度；使用该接口监控技术就可以大大提高系统的稳定性，提升了用户的体验度。

其次参照附图描述根据本申请实施例提出的接口监控装置。

图3是本申请实施例的接口监控装置的方框示意图。

如图3所示，该接口监控装置10包括：获取模块100、配置模块200和监控模块300。

其中，获取模块100，用于获取业务系统的接口参数；配置模块200，用于根据接口参数配置业务系统的接口监控功能，通过业务系统的接口监控功能采集接口数据；监控模块300，用于根据接口数据监控接口的当前状态，并根据当前状态生成提示信息，利用提示信息进行监控提示。

需要说明的是，前述对接口监控方法实施例的解释说明也适用于该实施例的接口监控装置，此处不再赘述。

根据本申请实施例提出的接口监控装置，获取业务系统的接口参数配置接口监控功能，并通过业务系统的接口监控功能采集接口数据，根据接口数据确定接口的当前状态以生成相应的提示信息，利于提示信息进行监控提示，从而及时得知接口的实际情况，并在出现异常情况能够及时通知工作人员快速处理，提升了系统的稳定性，提升了用户的使用体验。

图4为本申请实施例提供的服务器的结构示意图。该服务器可以包括：

存储器401、处理器402及存储在存储器401上并可在处理器402上运行的计算机程序。

处理器402执行程序时实现上述实施例中提供的接口监控方法。

进一步地，服务器还包括：

通信接口403，用于存储器401和处理器402之间的通信。

存储器401，用于存放可在处理器402上运行的计算机程序。

存储器401可能包含高速RAM(Random Access Memory，随机存取存储器)存储器，也可能还包括非易失性存储器，例如至少一个磁盘存储器。

如果存储器401、处理器402和通信接口403独立实现，则通信接口403、存储器401和处理器402可以通过总线相互连接并完成相互间的通信。总线可以是ISA(IndustryStandard Architecture，工业标准体系结构)总线、PCI(Peripheral Component，外部设备互连)总线或EISA(Extended Industry Standard Architecture，扩展工业标准体系结构)总线等。总线可以分为地址总线、数据总线、控制总线等。为便于表示，图4中仅用一条粗线表示，但并不表示仅有一根总线或一种类型的总线。

可选的，在具体实现上，如果存储器401、处理器402及通信接口403，集成在一块芯片上实现，则存储器401、处理器402及通信接口403可以通过内部接口完成相互间的通信。

处理器402可能是一个CPU(Central Processing Unit，中央处理器)，或者是ASIC(Application Specific Integrated Circuit，特定集成电路)，或者是被配置成实施本申请实施例的一个或多个集成电路。

本申请实施例还提供一种计算机可读存储介质，其上存储有计算机程序，该程序被处理器执行时实现如上的接口监控方法。

在本说明书的描述中，参考术语“一个实施例”、“一些实施例”、“示例”、“具体示例”、或“一些示例”等的描述意指结合该实施例或示例描述的具体特征、结构、材料或者特点包含于本申请的至少一个实施例或示例中。在本说明书中，对上述术语的示意性表述不是必须针对的是相同的实施例或示例。而且，描述的具体特征、结构、材料或者特点可以在任一个或N个实施例或示例中以合适的方式结合。此外，在不相互矛盾的情况下，本领域的技术人员可以将本说明书中描述的不同实施例或示例以及不同实施例或示例的特征进行结合和组合。

此外，术语“第一”、“第二”仅用于描述目的，而不能理解为指示或暗示相对重要性或者隐含指明所指示的技术特征的数量。由此，限定有“第一”、“第二”的特征可以明示或者隐含地包括至少一个该特征。在本申请的描述中，“N个”的含义是至少两个，例如两个，三个等，除非另有明确具体的限定。

流程图中或在此以其他方式描述的任何过程或方法描述可以被理解为，表示包括一个或N个用于实现定制逻辑功能或过程的步骤的可执行指令的代码的模块、片段或部分，并且本申请的优选实施方式的范围包括另外的实现，其中可以不按所示出或讨论的顺序，包括根据所涉及的功能按基本同时的方式或按相反的顺序，来执行功能，这应被本申请的实施例所属技术领域的技术人员所理解。

应当理解，本申请的各部分可以用硬件、软件、固件或它们的组合来实现。在上述实施方式中，N个步骤或方法可以用存储在存储器中且由合适的指令执行系统执行的软件或固件来实现。如，如果用硬件来实现和在另一实施方式中一样，可用本领域公知的下列技术中的任一项或他们的组合来实现：具有用于对数据信号实现逻辑功能的逻辑门电路的离散逻辑电路，具有合适的组合逻辑门电路的专用集成电路，可编程门阵列，现场可编程门阵列等。

本技术领域的普通技术人员可以理解实现上述实施例方法携带的全部或部分步骤是可以通过程序来指令相关的硬件完成，所述的程序可以存储于一种计算机可读存储介质中，该程序在执行时，包括方法实施例的步骤之一或其组合。

尽管上面已经示出和描述了本申请的实施例，可以理解的是，上述实施例是示例性的，不能理解为对本申请的限制，本领域的普通技术人员在本申请的范围内可以对上述实施例进行变化、修改、替换和变型。

Claims (10)

1.一种接口监控方法，其特征在于，包括以下步骤：

获取业务系统的接口参数；

根据所述接口参数配置所述业务系统的接口监控功能，通过所述业务系统的接口监控功能采集接口数据；

根据所述接口数据确定接口的当前状态，并根据所述当前状态生成提示信息，利用所述提示信息进行监控提示。

2.根据权利要求1所述的接口监控方法，其特征在于，所述根据所述接口参数配置所述业务系统的接口监控功能，包括：

启动类声明的注解版和注解配置；

根据所述注解版和所述注解配置自定义注解；

根据所述注解定义切面实现类，利用所述切面实现类配置接口监控功能的相关参数。

3.根据权利要求2所述的接口监控方法，其特征在于，所述相关参数包括接口数据请求出入参、返回值以及接口耗时，在利用所述切面实现类配置接口监控功能的相关参数之后，还包括：

将接口数据请求出入参、返回值以及接口耗时写入预设数据库。

4.根据权利要求1所述的接口监控方法，其特征在于，所述根据所述接口数据监控接口的当前状态，包括：

识别业务系统的接口响应时长；

若接口响应时长大于或等于预设阈值，则所述接口的当前状态为第一状态，否则接口的当前状态为第二状态。

5.根据权利要求1所述的接口监控方法，其特征在于，所述根据所述接口数据监控接口的当前状态，还包括：

获取接口返回状态码标识；

当接口返回状态码标识满足预设标识时，则所述接口响应请求失败，此时接口的当前状态为第一状态，否则接口响应请求成功且接口的当前状态为第二状态。

6.根据权利要求4或5所述的接口监控方法，其特征在于，在根据所述当前状态生成提示信息，包括：

若所述当前状态为第一状态，则生成提示信息。

7.根据权利要求1所述的接口监控方法，其特征在于，在根据所述当前状态生成提示信息之后，还包括：

根据所述提示信息控制告警系统的报警组件执行预设提醒动作。

8.一种接口监控装置，其特征在于，所述装置包括：

获取模块，用于获取业务系统的接口参数；

配置模块，用于根据所述接口参数配置所述业务系统的接口监控功能，通过所述业务系统的接口监控功能采集接口数据；

监控模块，用于根据所述接口数据监控接口的当前状态，并根据所述当前状态生成提示信息，利用所述提示信息进行监控提示。

9.一种服务器，其特征在于，包括：存储器、处理器及存储在所述存储器上并可在所述处理器上运行的计算机程序，所述处理器执行所述程序，以实现如权利要求1-7任一项所述的接口监控方法。

10.一种计算机可读存储介质，其上存储有计算机程序，其特征在于，该程序被处理器执行，以用于实现如权利要求1-7任一项所述的接口监控方法。