CN112217684A - Api网关监控方法、装置及系统 - Google Patents

Abstract

本发明提供了一种API网关监控方法、装置及系统，涉及安全监控技术领域，该方法包括：当监控到API网关触发熔断机制时，获取熔断API信息；其中，熔断API信息包括第一API标识；根据熔断API信息确定第一配置信息；其中，第一配置信息包括通知方式和通知对象；根据第一配置信息进行告警通知。这样在API网关触发熔断机制时实现了针对性的报警，减少了API网关后端服务资源的投入，同时又提升了API网关问题的处理效率。

Description

API网关监控方法、装置及系统

技术领域

本发明涉及安全监控技术领域，尤其是涉及一种API网关监控方法、装置及系统。

背景技术

API（Application Programming Interface，应用程序接口）网关很好的解决了微服务下调用、统一接入等问题。API网关首要的功能是负责统一接入，然后将请求的协议转换成内部的接口协议，在调用的过程中还要有限流、降级、熔断等容错的方式来保护API网关的整体稳定。

近年来随着互联网行业快速发展，基于API的微服务网关技术也层出不穷，百花齐放。目前通常使用熔断组件来保证API网关后端服务的性能和稳定性，然而这种方式下无法及时排查出触发熔断告警的API所存在的问题。

发明内容

本发明的目的在于提供一种API网关监控方法、装置及系统，以提升API网关问题的处理效率。

本发明实施例提供了一种API网关监控方法，应用于报警执行器；所述方法包括：

当监控到API网关触发熔断机制时，获取熔断API信息；其中，所述熔断API信息包括第一API标识；

根据所述熔断API信息确定第一配置信息；其中，所述第一配置信息包括通知方式和通知对象；

根据所述第一配置信息进行告警通知。

进一步地，所述报警执行器与报警网络服务器连接，所述报警网络服务器用于提供针对API的用户交互界面；所述方法还包括：

当接收到所述报警网络服务器基于数据库中的API元数据信息发送的告警通知消息时，确定监控到API网关触发熔断机制。

进一步地，根据所述熔断API信息确定第一配置信息的步骤，包括：

从所述数据库中查询得到与所述第一API标识对应的第一配置信息；其中，所述数据库中存储有API标识与配置信息的对应关系。

进一步地，所述方法还包括：

接收所述报警网络服务器发送的信息维护请求；

解析所述信息维护请求，得到请求类型和请求内容；其中，所述请求类型包括增加、修改或删除；

根据所述请求类型和所述请求内容对所述数据库中的API元数据信息和/或配置信息进行维护。

进一步地，所述方法还包括：

当监控到所述API网关的服务恢复时，获取恢复API信息；其中，所述恢复API信息包括第二API标识；

根据所述恢复API信息确定第二配置信息；

根据所述第二配置信息进行恢复通知。

本发明实施例还提供了一种API网关监控装置，应用于报警执行器；所述装置包括：

获取模块，用于当监控到API网关触发熔断机制时，获取熔断API信息；其中，所述熔断API信息包括第一API标识；

确定模块，用于根据所述熔断API信息确定第一配置信息；其中，所述第一配置信息包括通知方式和通知对象；

通知模块，用于根据所述第一配置信息进行告警通知。

进一步地，所述报警执行器与报警网络服务器连接，所述报警网络服务器用于提供针对API的用户交互界面；所述装置还包括：

监控模块，用于当接收到所述报警网络服务器基于数据库中的API元数据信息发送的告警通知消息时，确定监控到API网关触发熔断机制。

进一步地，所述获取模块还用于当监控到所述API网关的服务恢复时，获取恢复API信息；其中，所述恢复API信息包括第二API标识；

所述确定模块还用于根据所述恢复API信息确定第二配置信息；

所述通知模块还用于根据所述第二配置信息进行恢复通知。

本发明实施例还提供了一种API网关监控系统，包括互接的报警网络服务器和报警执行器，所述报警网络服务器用于提供针对API的用户交互界面；所述报警执行器包括存储器、处理器，所述存储器中存储有可在所述处理器上运行的计算机程序，所述处理器执行所述计算机程序时实现上述的API网关监控方法。

本发明实施例还提供了一种计算机可读存储介质，所述计算机可读存储介质上存储有计算机程序，所述计算机程序被处理器运行时执行上述的API网关监控方法。

本发明实施例提供的API网关监控方法、装置及系统中，该方法应用于报警执行器，该方法包括：当监控到API网关触发熔断机制时，获取熔断API信息；其中，熔断API信息包括第一API标识；根据熔断API信息确定第一配置信息；其中，第一配置信息包括通知方式和通知对象；根据第一配置信息进行告警通知。这样在API网关触发熔断机制时实现了针对性的报警，减少了API网关后端服务资源的投入，同时又提升了API网关问题的处理效率。

附图说明

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

图1为本发明实施例提供的一种API网关监控方法的系统架构图；

图2为本发明实施例提供的一种查询API元数据信息和配置信息的流程图；

图3为本发明实施例提供的一种创建API元数据信息和配置信息的流程图；

图4为本发明实施例提供的一种修改/删除元数据信息和配置信息的流程图；

图5为本发明实施例提供的一种API熔断告警通知的流程图；

图6为本发明实施例提供的一种API服务恢复通知的流程图；

图7为本发明实施例提供的一种API网关监控方法的流程示意图；

图8为本发明实施例提供的一种API网关监控装置的结构示意图；

图9为本发明实施例提供的一种API网关监控系统的结构示意图；

图10为本发明实施例提供的一种报警执行器的结构示意图。

具体实施方式

下面将结合实施例对本发明的技术方案进行清楚、完整地描述，显然，所描述的实施例是本发明一部分实施例，而不是全部的实施例。基于本发明中的实施例，本领域普通技术人员在没有做出创造性劳动前提下所获得的所有其他实施例，都属于本发明保护的范围。

目前在API网关后端服务的性能和稳定性保护机制上，传统的方法是使用熔断组件，但是这种方式对于触发熔断告警的API没有一个完善的信息统计，无法当下实时确认API对应的研发负责人，对于后续的问题排查和沟通效率影响较大，需要投入大量的人员对服务器资源进行主动的监控和运维，因此此种方式耗时耗力。基于此，本发明实施例提供的一种API网关监控方法、装置及系统，借助软件设计，通过代码引入熔断恢复机制的前提下，对每个API进行信息的记录和统计，同时触发告警通知时可以查询到API的录入统计信息，根据查询返回的API告警类型（即通知方式）和通知人的联系方式做针对性的报警，如短信、邮件、企业微信或钉钉等。通过这种告警通知机制可以减少API网关后端服务资源的投入，同时又可以保证问题处理沟通的高效性。

为便于对本实施例进行理解，首先对本发明实施例所公开的一种API网关监控方法的系统架构进行介绍。

参见图1所示的一种API网关监控方法的系统架构图，该方法主要可以由三个服务组成：ApiAlarm-Web服务（即API报警网络服务）、分布式消息服务和ApiAlarm-Executor（报警执行器）。

其中，ApiAlarm-Web服务：针对需要开放的所有API，提供了用户交互界面，用于管理和维护每个API的元数据信息和告警配置信息（也可简称为配置信息），元数据信息可以包括API标识（ID，Identity document）、请求URL（uniform resource locator，统一资源定位器）、请求方法、创建时间和请求正文等，告警配置信息可以包括API标识、告警类型、告警通知目标和告警联系人姓名等，其中告警类型可以是短信、邮件、企业微信或钉钉等，告警通知目标可以是手机号、邮箱或回调地址等。为了便于理解，如下表1示出了一种API元数据信息表的设计图，表2示出了一种API告警配置信息表的设计图。

表1

API元数据信息表
	+ID 主键 +请求URL +请求方法 +创建时间 +请求正文
+创建API信息 +更新API信息 +删除API信息

表2

API告警配置信息表
	+API ID +告警类型 +告警通知目标 +告警联系人姓名
+发送告警 +创建API告警信息 +更新API告警信息 +删除API告警信息

分布式消息服务包括两种MQ（Message Queue，消息队列）topic（主题）：1、ApiInfotopic（API信息主题）：当ApiAlarm-Web服务收到API信息创建、修改（更新）、删除的请求后，会往该ApiInfo topic发送对应的消息；2、熔断主题：当API网关触发熔断条件后，会往该熔断主题发送熔断的API信息。可选地，可以采用异步方式将消息写入相应的主题。

ApiAlarm-Executor：报警执行器主要是消费分布式消息服务的消息，消费ApiInfo topic的消息后，会根据消息类型自动解析并创建或者修改对应的API元数据信息和告警配置信息；消费熔断主题的消息后，会根据消息中告警的API信息，去DB（Data Base，数据库）查询对应的API告警配置信息，根据告警配置信息选择对应的方式进行告警。报警执行器可以采用集群方式，也即报警执行器可以为多个。

如图1所示，上述系统架构可以实现如下功能：

（1）查询API元数据信息和配置信息：如图2所示，管理员登录ApiAlarm-Web服务后，可以在后端配置页面查询API的元数据信息，首次登录查询数据为空，此时可以创建对应的API信息和告警配置信息。

（2）创建API元数据信息和配置信息：如图3所示，管理员登录ApiAlarm-Web服务后，在服务界面上，进行API信息录入和告警信息配置，通过点击保存提交请求到后台服务；ApiAlarm-Web服务收到请求后，异步处理，往分布式消息服务的ApiInfo topic发送一条新增API信息的消息；ApiAlarm-Executor消费ApiInfo topic的消息后，进行消息解析，将相应信息存储到数据库里。

（3）修改/删除元数据信息和配置信息：如图4所示，管理员登录ApiAlarm-Web服务后，对API元数据信息和配置信息进行修改或者删除，点击确认提交请求到后台服务；ApiAlarm-Web服务收到请求后会异步处理，往分布式消息服务的ApiInfo topic发送一条修改/删除API信息的消息；ApiAlarm-Executor消费ApiInfo topic的消息后，首先进行消息解析，如果是修改信息，则将将修改后的API信息（即修改API信息）存储到数据库里，如果是删除信息，则将该API信息从数据库中删除。

（4）API熔断告警通知：如图5所示，当API调用方（请求调用网关API的用户）通过网关访问API的时候，如果因为网络故障或者服务内部错误，达到设置的阈值时触发熔断，此时会往分布式消息服务的熔断主题发送一条API触发熔断告警的消息（即当判断出API网关触发熔断时，往分布式消息服务发送触发熔断告警的消息）；ApiAlarm-Executor消费到该熔断告警的消息后，首先进行消息解析，然后根据解析到的API信息查询数据库中对应的告警配置信息（即通过读取DB获取告警API的配置信息），最后根据告警类型（如短信/邮件/企业微信/钉钉等）和告警通知目标触发对应的告警。

（5）API服务恢复通知：如图6所示，当熔断时间达到设置的时间阈值后，API网关会做服务恢复测试，当服务全面恢复的时候，API网关会往分布式消息服务的熔断主题发送一条服务恢复的消息；ApiAlarm-Executor消费到该主题消息后，首先进行消息解析，然后根据解析到的API信息查询数据库中对应的告警配置信息（即通过读取DB获取告警API的配置信息），根据告警类型和告警通知目标触发对应的恢复通知（即发送熔断解除消息）。

应用本实施例提供的API网关监控方法的系统架构，可以对API网关建立起一套高效的API信息配置维护和熔断、自动恢复的生产故障告警通知系统，真正达到生产故障实时有效预警以及高效沟通处理，从而节省成本；还可以支持报警执行器的水平扩展，通过不断增加服务器（即报警执行器），提高系统的性能。

基于上述的系统架构，本发明实施例提供了一种API网关监控方法，可以由上述的报警执行器执行。参见图7所示的一种API网关监控方法的流程示意图，该方法主要包括如下步骤S702~步骤S706：

步骤S702，当监控到API网关触发熔断机制时，获取熔断API信息；其中，熔断API信息包括第一API标识。

可选地，报警执行器与报警网络服务器连接，报警网络服务器用于提供API报警网络服务，该API报警网络服务提供有针对API的用户交互界面。基于此，当接收到报警网络服务器基于数据库中的API元数据信息发送的告警通知消息时，确定监控到API网关触发熔断机制。在此情况下，可以对告警通知消息进行解析，得到触发熔断的API信息，该API信息包括API ID（即第一API标识）。

步骤S704，根据熔断API信息确定第一配置信息；其中，第一配置信息包括通知方式和通知对象。

可选地，可以从数据库中查询得到与第一API标识对应的第一配置信息；其中，数据库中存储有API标识与配置信息的对应关系。这里的配置信息也即上述的告警配置信息，通知方式也即上述的告警类型，通知对象可以包括上述的告警通知目标和告警联系人姓名。

步骤S706，根据第一配置信息进行告警通知。

本发明实施例提供的API网关监控方法中，当监控到API网关触发熔断机制时，获取熔断API信息；其中，熔断API信息包括第一API标识；根据熔断API信息确定第一配置信息；其中，第一配置信息包括通知方式和通知对象；根据第一配置信息进行告警通知。这样在API网关触发熔断机制时实现了针对性的报警，减少了API网关后端服务资源的投入，同时又提升了API网关问题的处理效率。

进一步，上述API网关监控方法还包括：接收报警网络服务器发送的信息维护请求；解析该信息维护请求，得到请求类型和请求内容；其中，请求类型包括增加、修改或删除；根据请求类型和请求内容对数据库中的API元数据信息和/或配置信息进行维护。这样实现了对API元数据信息和配置信息的维护。

进一步，上述API网关监控方法还包括：当监控到API网关的服务恢复时，获取恢复API信息；其中，恢复API信息包括第二API标识；根据恢复API信息确定第二配置信息；根据第二配置信息进行恢复通知。这样可以及时通知相关人员API网关的服务已恢复，避免了针对已恢复服务的盲目处理。

对应于上述的API网关监控方法，本发明实施例还提供了一种API网关监控装置，该装置应用于上述的报警执行器。参见图8示出的一种API网关监控装置的结构示意图，该装置包括：

获取模块82，用于当监控到API网关触发熔断机制时，获取熔断API信息；其中，熔断API信息包括第一API标识；

确定模块84，用于根据熔断API信息确定第一配置信息；其中，第一配置信息包括通知方式和通知对象；

通知模块86，用于根据第一配置信息进行告警通知。

本发明实施例提供的API网关监控装置中，当监控到API网关触发熔断机制时，获取熔断API信息；其中，熔断API信息包括第一API标识；根据熔断API信息确定第一配置信息；其中，第一配置信息包括通知方式和通知对象；根据第一配置信息进行告警通知。这样在API网关触发熔断机制时实现了针对性的报警，减少了API网关后端服务资源的投入，同时又提升了API网关问题的处理效率。

进一步，上述报警执行器与报警网络服务器连接，报警网络服务器用于提供针对API的用户交互界面；上述装置还包括：

监控模块，该监控模块与上述获取模块82连接，用于当接收到报警网络服务器基于数据库中的API元数据信息发送的告警通知消息时，确定监控到API网关触发熔断机制。

进一步，上述确定模块84具体用于：从数据库中查询得到与第一API标识对应的第一配置信息；其中，数据库中存储有API标识与配置信息的对应关系。

进一步，上述装置还包括维护模块，该维护模块与上述确定模块84连接，用于：接收报警网络服务器发送的信息维护请求；解析信息维护请求，得到请求类型和请求内容；其中，请求类型包括增加、修改或删除；根据请求类型和请求内容对数据库中的API元数据信息和/或配置信息进行维护。

进一步，上述获取模块82还用于当监控到API网关的服务恢复时，获取恢复API信息；其中，恢复API信息包括第二API标识；上述确定模块84还用于根据恢复API信息确定第二配置信息；上述通知模块86还用于根据第二配置信息进行恢复通知。

本实施例所提供的装置，其实现原理及产生的技术效果和前述方法实施例相同，为简要描述，装置实施例部分未提及之处，可参考前述方法实施例中相应内容。

本发明实施例还提供了一种API网关监控系统，参见图9所示的一种API网关监控系统的结构示意图，该系统包括互接的报警网络服务器92和报警执行器94，报警网络服务器92用于提供针对API的用户交互界面；报警执行器94包括存储器、处理器，存储器中存储有可在处理器上运行的计算机程序，处理器执行计算机程序时实现上述的API网关监控方法。

参见图10，本发明实施例还提供一种报警执行器94，包括：处理器940，存储器941，总线942和通信接口943，所述处理器940、通信接口943和存储器941通过总线942连接；处理器940用于执行存储器941中存储的可执行模块，例如计算机程序。

其中，存储器941可能包含随机存取存储器（Random Access Memory，简称RAM），也可能还包括非易失性存储器（non-volatile memory，简称NVM），例如至少一个磁盘存储器。通过至少一个通信接口943（可以是有线或者无线）实现该系统网元与至少一个其他网元之间的通信连接，可以使用互联网，广域网，本地网，城域网等。

总线942可以是工业标准体系结构（Industry Standard Architecture，简称ISA）总线、外设部件互连标准（Peripheral Component Interconnect，简称PCI）总线或扩展工业标准结构（Extended Industry Standard Architecture，简称EISA）总线等。所述总线可以分为地址总线、数据总线、控制总线等。为便于表示，图10中仅用一个双向箭头表示，但并不表示仅有一根总线或一种类型的总线。

其中，存储器941用于存储程序，所述处理器940在接收到执行指令后，执行所述程序，前述本发明实施例任一实施例揭示的流过程定义的装置所执行的方法可以应用于处理器940中，或者由处理器940实现。

处理器940可能是一种集成电路芯片，具有信号的处理能力。在实现过程中，上述方法的各步骤可以通过处理器940中的硬件的集成逻辑电路或者软件形式的指令完成。上述的处理器940可以是通用处理器，包括中央处理器(Central Processing Unit，简称CPU)、网络处理器(Network Processor，简称NP)等；还可以是数字信号处理器(DigitalSignal Processing，简称DSP)、专用集成电路(Application Specific IntegratedCircuit，简称ASIC)、现成可编程门阵列(Field-Programmable Gate Array，简称FPGA)或者其他可编程逻辑器件、分立门或者晶体管逻辑器件、分立硬件组件。可以实现或者执行本发明实施例中的公开的各方法、步骤及逻辑框图。通用处理器可以是微处理器或者该处理器也可以是任何常规的处理器等。结合本发明实施例所公开的方法的步骤可以直接体现为硬件译码处理器执行完成，或者用译码处理器中的硬件及软件模块组合执行完成。软件模块可以位于随机存储器，闪存、只读存储器，可编程只读存储器或者电可擦写可编程存储器、寄存器等本领域成熟的存储介质中。该存储介质位于存储器941，处理器940读取存储器941中的信息，结合其硬件完成上述方法的步骤。

本发明实施例还提供了一种计算机可读存储介质，该计算机可读存储介质上存储有计算机程序，该计算机程序被处理器运行时执行前面方法实施例中所述的API网关监控方法。该计算机可读存储介质包括：U盘、移动硬盘、只读存储器（Read-Only Memory，简称ROM）、RAM、磁碟或者光盘等各种可以存储程序代码的介质。

在这里示出和描述的所有示例中，任何具体值应被解释为仅仅是示例性的，而不是作为限制，因此，示例性实施例的其他示例可以具有不同的值。

附图中的流程图和框图显示了根据本发明的多个实施例的系统、方法和计算机程序产品的可能实现的体系架构、功能和操作。在这点上，流程图或框图中的每个方框可以代表一个模块、程序段或代码的一部分，所述模块、程序段或代码的一部分包含一个或多个用于实现规定的逻辑功能的可执行指令。也应当注意，在有些作为替换的实现中，方框中所标注的功能也可以以不同于附图中所标注的顺序发生。例如，两个连续的方框实际上可以基本并行地执行，它们有时也可以按相反的顺序执行，这依所涉及的功能而定。也要注意的是，框图和/或流程图中的每个方框、以及框图和/或流程图中的方框的组合，可以用执行规定的功能或动作的专用的基于硬件的系统来实现，或者可以用专用硬件与计算机指令的组合来实现。

在本申请所提供的几个实施例中，应该理解到，所揭露的系统、装置和方法，可以通过其它的方式实现。以上所描述的装置实施例仅仅是示意性的，例如，所述单元的划分，仅仅为一种逻辑功能划分，实际实现时可以有另外的划分方式，又例如，多个单元或组件可以结合或者可以集成到另一个系统，或一些特征可以忽略，或不执行。另一点，所显示或讨论的相互之间的耦合或直接耦合或通信连接可以是通过一些通信接口，装置或单元的间接耦合或通信连接，可以是电性，机械或其它的形式。

所述作为分离部件说明的单元可以是或者也可以不是物理上分开的，作为单元显示的部件可以是或者也可以不是物理单元，即可以位于一个地方，或者也可以分布到多个网络单元上。可以根据实际的需要选择其中的部分或者全部单元来实现本实施例方案的目的。

另外，在本发明各个实施例中的各功能单元可以集成在一个处理单元中，也可以是各个单元单独物理存在，也可以两个或两个以上单元集成在一个单元中。

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

Claims (10)

1.一种API网关监控方法，其特征在于，应用于报警执行器；所述方法包括：

当监控到API网关触发熔断机制时，获取熔断API信息；其中，所述熔断API信息包括第一API标识；

根据所述熔断API信息确定第一配置信息；其中，所述第一配置信息包括通知方式和通知对象；

根据所述第一配置信息进行告警通知。

2.根据权利要求1所述的API网关监控方法，其特征在于，所述报警执行器与报警网络服务器连接，所述报警网络服务器用于提供针对API的用户交互界面；所述方法还包括：

当接收到所述报警网络服务器基于数据库中的API元数据信息发送的告警通知消息时，确定监控到API网关触发熔断机制。

3.根据权利要求2所述的API网关监控方法，其特征在于，根据所述熔断API信息确定第一配置信息的步骤，包括：

从所述数据库中查询得到与所述第一API标识对应的第一配置信息；其中，所述数据库中存储有API标识与配置信息的对应关系。

4.根据权利要求3所述的API网关监控方法，其特征在于，所述方法还包括：

接收所述报警网络服务器发送的信息维护请求；

解析所述信息维护请求，得到请求类型和请求内容；其中，所述请求类型包括增加、修改或删除；

根据所述请求类型和所述请求内容对所述数据库中的API元数据信息和/或配置信息进行维护。

5.根据权利要求1所述的API网关监控方法，其特征在于，所述方法还包括：

当监控到所述API网关的服务恢复时，获取恢复API信息；其中，所述恢复API信息包括第二API标识；

根据所述恢复API信息确定第二配置信息；

根据所述第二配置信息进行恢复通知。

6.一种API网关监控装置，其特征在于，应用于报警执行器；所述装置包括：

获取模块，用于当监控到API网关触发熔断机制时，获取熔断API信息；其中，所述熔断API信息包括第一API标识；

确定模块，用于根据所述熔断API信息确定第一配置信息；其中，所述第一配置信息包括通知方式和通知对象；

通知模块，用于根据所述第一配置信息进行告警通知。

7.根据权利要求6所述的API网关监控装置，其特征在于，所述报警执行器与报警网络服务器连接，所述报警网络服务器用于提供针对API的用户交互界面；所述装置还包括：

监控模块，用于当接收到所述报警网络服务器基于数据库中的API元数据信息发送的告警通知消息时，确定监控到API网关触发熔断机制。

8.根据权利要求6所述的API网关监控装置，其特征在于，所述获取模块还用于当监控到所述API网关的服务恢复时，获取恢复API信息；其中，所述恢复API信息包括第二API标识；

所述确定模块还用于根据所述恢复API信息确定第二配置信息；

所述通知模块还用于根据所述第二配置信息进行恢复通知。

9.一种API网关监控系统，其特征在于，包括互接的报警网络服务器和报警执行器，所述报警网络服务器用于提供针对API的用户交互界面；所述报警执行器包括存储器、处理器，所述存储器中存储有可在所述处理器上运行的计算机程序，所述处理器执行所述计算机程序时实现权利要求1-5中任一项所述的方法。

10.一种计算机可读存储介质，所述计算机可读存储介质上存储有计算机程序，其特征在于，所述计算机程序被处理器运行时执行权利要求1-5中任一项所述的方法。

Images