A health check implementation method and device based on API gateway

Abstract

The present invention discloses a health check implementation method and device based on API gateway, wherein the method comprises: adding a new service in API gateway and configuring a node into the service; configuring the health check parameters of the service in API gateway; API gateway performs survival check and functional check on the nodes in the service, and automatically calculates the detection interval time; API gateway monitors the health check status of the nodes in the service, and automatically forwards the traffic to the healthy nodes. The method and device detect the health status of the node through survival check and functional check, and automatically calculates the detection interval time, thereby reducing the number of unnecessary detection times and improving network performance.

Description

Technical Field

[0001] The present invention relates to the field of communication technology, and in particular to a method and device for implementing health checks based on an API gateway (Application Programming Interface Gateway). Background Art

[0002] The API gateway is the entrance to the API and provides a customized API access interface for the client. With the development of microservices and cloud-native related technologies, the granularity of services is getting finer and finer. Backend services focus on their own business functions, and each service exposes its interface to the outside world through the API gateway. As a service entrance, the API gateway needs to obtain the health status of the service to prevent backend service anomalies from affecting the front-end business, thereby improving the overall availability of the business.

[0003] The current health check solution mainly detects the node status by sending TCP or HTTP at regular intervals. However, if the detection interval is too short, it will affect the network performance; if the detection interval is too long, it will not be conducive to the rapid recovery of business. As the business scale continues to increase, if the service access scale reaches tens of thousands, the health check will have a great impact on the network performance. How to improve the efficiency of health checks has become an urgent problem to be solved. Summary of the invention

[0004] In view of the above situation, the present invention provides a health check implementation method and device based on API gateway, which detects the health status of the node through survival check and functional check, and automatically calculates the detection interval time, thereby reducing unnecessary detection times and improving network performance.

[0005] To achieve the above object, the present invention adopts the following technical solutions:

[0006] In one embodiment of the present invention, a health check implementation method based on an API gateway is proposed, the method comprising:

[0007] Add a new service in the API Gateway and configure the node to the service;

[0008] Configure the health check parameters of the service in the API gateway;

[0009] The API gateway performs survival and functionality checks on the nodes in the service and automatically calculates the detection interval;

[0010] The API Gateway monitors the health check status of the nodes in the service and automatically forwards traffic to healthy nodes.

[0011] Furthermore, a service is an abstraction of an API that can configure multiple nodes.

[0012] Furthermore, the API Gateway performs liveness and functionality checks on the nodes in the service and automatically calculates the detection interval, including:

[0013] After the service starts health check, the default health check status of the nodes in the service is unavailable, and the API gateway automatically performs a survival check on the nodes in the service;

[0014] If the number of detections reaches the threshold and the health check status of the node in service does not change, the detection interval will be doubled, and so on, until the maximum interval is reached;

[0015] If the health check status of the node in the service changes, the detection interval will be restored to the initial detection interval;

[0016] If the number of detections reaches the threshold and the health check status of the node in the service changes, the health check status of the node in the service is modified;

[0017] If the number of successful liveness checks reaches the health threshold, the health check status of the node in the service is changed to available, and the API gateway starts to perform functional checks on the node in the service;

[0018] If the number of survival check failures reaches the unhealthy threshold, the health check status of the node in service is changed to unhealthy and the detection interval is increased;

[0019] If the number of TCP connection failures reaches the unhealthy threshold during the functional check, the health check status of the node in the service is changed to unavailable, the API gateway stops performing functional checks on the node in the service, and performs a liveness check on the node in the service again;

[0020] If the number of successful functional checks reaches the health threshold, the health check status of the node in service is changed to healthy;

[0021] If the number of functional check failures reaches the unhealthy threshold, the health check status of the node in the service is changed to unhealthy and the detection interval is increased.

[0022] Furthermore, the liveness check is that the API gateway performs TCP detection based on the IP address and port of the node in the service;

[0023] Functional check is that the API gateway performs HTTP or HTTPS detection based on the IP address, port, and request path of the node in the service.

[0024] In one embodiment of the present invention, a health check implementation device based on an API gateway is also proposed, the device comprising:

[0025] The configuration module is used to add new services to the API gateway, configure nodes to services, and configure health check parameters for services;

[0026] API Gateway is used to perform survival and functionality checks on nodes in the service, and automatically calculate the detection interval; it monitors the health check status of nodes in the service and automatically forwards traffic to healthy nodes.

[0027] Furthermore, a service is an abstraction of an API that can configure multiple nodes.

[0028] Furthermore, the API Gateway performs liveness and functionality checks on the nodes in the service and automatically calculates the detection interval, including:

[0029] After the service starts health check, the default health check status of the nodes in the service is unavailable, and the API gateway automatically performs a survival check on the nodes in the service;

[0030] If the number of detections reaches the threshold and the health check status of the node in service does not change, the detection interval will be doubled, and so on, until the maximum interval is reached;

[0031] If the health check status of the node in the service changes, the detection interval will be restored to the initial detection interval;

[0032] If the number of detections reaches the threshold and the health check status of the node in the service changes, the health check status of the node in the service is modified;

[0033] If the number of successful liveness checks reaches the health threshold, the health check status of the node in the service is changed to available, and the API gateway starts to perform functional checks on the node in the service;

[0034] If the number of survival check failures reaches the unhealthy threshold, the health check status of the node in service is changed to unhealthy and the detection interval is increased;

[0035] If the number of TCP connection failures reaches the unhealthy threshold during the functional check, the health check status of the node in the service is changed to unavailable, the API gateway stops performing functional checks on the node in the service, and performs a liveness check on the node in the service again;

[0036] If the number of successful functional checks reaches the health threshold, the health check status of the node in service is changed to healthy;

[0037] If the number of functional check failures reaches the unhealthy threshold, the health check status of the node in the service is changed to unhealthy and the detection interval is increased.

[0038] Furthermore, the liveness check is that the API gateway performs TCP detection based on the IP address and port of the node in the service;

[0039] Functional check is that the API gateway performs HTTP or HTTPS detection based on the IP address, port, and request path of the node in the service.

[0040] In one embodiment of the present invention, a computer device is also proposed, including a memory, a processor, and a computer program stored in the memory and executable on the processor. When the processor executes the computer program, the aforementioned API gateway-based health check is implemented.

[0041] In one embodiment of the present invention, a computer-readable storage medium is also proposed, which stores a computer program for executing a health check based on an API gateway.

[0042] Beneficial effects:

[0043] 1. The present invention reduces the number of unnecessary detections and improves network performance.

[0044] 2. The present invention performs health examinations at different levels, thereby improving the efficiency of health examinations. BRIEF DESCRIPTION OF THE DRAWINGS

[0045] Figure 1 This is a flow chart of a method for implementing health checks based on an API gateway in the present invention;

[0046] Figure 2 It is a health check status change diagram of nodes in the service of the present invention;

[0047] Figure 3 It is a schematic diagram of the health check process of the nodes in the service of the present invention;

[0048] Figure 4 This is an architecture diagram of a health check implementation based on an API gateway according to an embodiment of the present invention;

[0049] Figure 5 It is a structural diagram of a health check implementation device based on an API gateway of the present invention;

[0050] Figure 6 It is a schematic diagram of the computer device structure of the present invention. DETAILED DESCRIPTION

[0051] The principles and spirit of the present invention will be described below with reference to several exemplary embodiments. It should be understood that these embodiments are provided only to enable those skilled in the art to better understand and implement the present invention, and are not intended to limit the scope of the present invention in any way. On the contrary, these embodiments are provided to make the present disclosure more thorough and complete, and to fully convey the scope of the present disclosure to those skilled in the art.

[0052] Those skilled in the art will appreciate that the embodiments of the present invention may be implemented as a device, apparatus, node, method or computer program product. Therefore, the present disclosure may be implemented in the following forms, namely: complete hardware, complete software (including firmware, resident software, microcode, etc.), or a combination of hardware and software.

[0053] The implementation mode of the present invention proposes a health check implementation method and device based on API gateway, which adds a new service in the API gateway, configures the node to the service, and configures the health check parameters of the service; the API gateway performs a survival check and a functional check on the nodes in the service, monitors the health check status of the nodes in the service, and automatically forwards the traffic to the healthy nodes. The present invention uses survival checks and functional checks to detect the health status of the nodes in the service, and automatically calculates the detection interval time. By dynamically adjusting the detection interval time, the number of unnecessary detections is reduced, thereby improving network performance.

[0054] The principle and spirit of the present invention are explained in detail below with reference to several representative embodiments of the present invention.

[0055] Figure 1 This is a flow chart of the health check implementation method based on the API gateway of the present invention. Figure 1 As shown, the method includes:

[0056] S1. Add a new service in the API gateway and configure the upstream node to the service;

[0057] The service here is an abstraction of a class of APIs, which can configure multiple nodes; the node information includes: IP:port or domain name:port format; different formats do not affect the scope of protection of this patent;

[0058] The node here is the backend server, and the API gateway service is used to load balance multiple nodes according to the configuration rules. That is, multiple nodes can be configured on the service to provide services to the outside in a unified manner in the form of load balancing.

[0059] S2. Configure the health check parameters of the service;

[0060] The health check parameters here include timeout, initial interval, maximum interval, request path, healthy threshold, unhealthy threshold, healthy status code list and unhealthy status code list;

[0061] The initial interval here indicates the initial detection interval of health detection, which is smaller than the maximum interval;

[0062] The maximum interval here indicates the maximum detection interval of health detection.

[0063] S3 and API Gateway perform health checks on upstream nodes of the service;

[0064] The health check here includes survival check and functionality check;

[0065] like Figure 2 and Figure 3 As shown in the figure, after the service starts the health check, the default health check status of the nodes in the service is unavailable, and the API gateway automatically performs a survival check on the nodes in the service;

[0066] The liveness check here means that the API gateway performs TCP detection based on the IP address and port of the node in the service;

[0067] The functional check here means that the API gateway performs HTTP or HTTPS detection based on the IP address, port, and request path of the node in the service;

[0068] If the number of detections reaches the threshold and the health check status of the node in service does not change, the detection interval will be doubled, and so on, until the maximum interval is reached;

[0069] If the health check status of the node in the service changes, the detection interval will be restored to the initial detection interval;

[0070] If the number of detections reaches the threshold and the health check status of the node in the service changes, the health check status of the node in the service is modified;

[0071] If the number of successful liveness checks reaches the health threshold, the health check status of the node in the service is changed to available, and the API gateway starts to perform functional checks on the node in the service;

[0072] If the number of survival check failures reaches the unhealthy threshold, the health check status of the node in service is changed to unhealthy and the detection interval is increased;

[0073] If the number of TCP connection failures reaches the unhealthy threshold during the functional check, the health check status of the node in the service is changed to unavailable, the API gateway stops performing functional checks on the node in the service, and performs a liveness check on the node in the service again;

[0074] If the number of successful functional checks reaches the health threshold, the health check status of the node in service is changed to healthy;

[0075] If the number of functional check failures reaches the unhealthy threshold, the health check status of the node in the service is changed to unhealthy and the detection interval is increased;

[0076] The health check status here includes: healthy, unhealthy, available, and unavailable. The default status is unavailable.

[0077] S4, monitors the health check status of upstream nodes and automatically forwards traffic to healthy upstream nodes;

[0078] The API Gateway maintains the health check status of the nodes in the service based on the health check status of the nodes in the service and automatically forwards traffic to healthy nodes.

[0079] Operation and maintenance personnel can troubleshoot the causes of unhealthy nodes based on the monitoring and alarm information of nodes in the API gateway.

[0080] It should be noted that, although the operations of the method of the present invention are described in a specific order in the above embodiments and the accompanying drawings, this does not require or imply that the operations must be performed in the specific order, or that all the operations shown must be performed to achieve the desired results. Additionally or alternatively, some steps may be omitted, multiple steps may be combined into one step, and / or one step may be decomposed into multiple steps.

[0081] In order to explain the above-mentioned API gateway-based health check implementation method more clearly, a specific embodiment is used for illustration below. However, it should be noted that this embodiment is only for better illustrating the present invention and does not constitute an improper limitation to the present invention.

[0082] Example:

[0083] Figure 4 This is an architecture diagram of health check based on API gateway according to an embodiment of the present invention. Figure 4 As shown, the implementation steps are as follows:

[0084] S1. Add a new service in the API gateway and configure the node to the service;

[0085] The service here is an abstraction of a type of API that can configure multiple nodes; the node information includes: IP:port or domain name:port format;

[0086] For example, the node can be configured in different forms: 1.1.1.1:80 or www.test.com:80.

[0087] S2. Configure the health check parameters of the service;

[0088] The health check parameters here include timeout, initial interval, maximum interval, request path, healthy threshold, unhealthy threshold, healthy status code list and unhealthy status code list;

[0089] The healthy status code list and unhealthy status code list here represent the HTTP status codes of healthy status and unhealthy status respectively;

[0090] For example, 200, 201, 301, 302, etc. can be set as healthy status codes, and 400, 401, 404, 500, 501, 502, etc. can be set as unhealthy status codes.

[0091] The initial interval here indicates the initial detection interval of the health check, which is smaller than the maximum interval;

[0092] The maximum interval here indicates the maximum detection interval of the health check.

[0093] S3 and API Gateway perform health checks on service nodes;

[0094] After the service starts health check, the default health check status of the nodes in the service is unavailable, and the API gateway automatically performs a survival check on the nodes in the service;

[0095] The liveness check here means that the API gateway performs TCP detection based on the IP address and port of the node in the service;

[0096] The functional check here means HTTP or HTTPS detection based on the IP address, port and request path of the node in the service;

[0097] When performing a specific detection, if the node information is in the form of domain name:port, you need to perform domain name resolution first, obtain the IP address, and then perform the detection;

[0098] If the number of detections reaches the threshold and the health check status of the node in service does not change, the detection interval will be doubled, and so on, until the maximum interval is reached;

[0099] If the health check status of the node in the service changes, the detection interval will be restored to the initial detection interval;

[0100] When performing specific detection, if the initial interval and maximum interval are 1 second and 20 seconds respectively, the unhealthy threshold is 3 times. A node in a service has been unavailable. Initially, the API gateway detects once every 1 second. After 3 consecutive detection failures, the API gateway detects once every 2 seconds. Finally, the detection interval of the API gateway is 20 seconds. If the detection interval is 20 seconds and there is one successful detection in the middle, the detection interval will be changed to 1 second.

[0101] If the number of detections reaches the threshold and the health check status of the node in the service changes, the health check status of the node in the service is modified;

[0102] During the specific detection, if the current health check status of the node in the service is unhealthy and the health threshold is 3 times; the API gateway succeeds in 3 consecutive functional checks, the health check status of the node in the service is changed to healthy;

[0103] If the number of successful liveness checks reaches the health threshold, the health check status of the node in the service is changed to available, and the API gateway starts to perform functional checks on the node in the service;

[0104] If the number of TCP connection failures reaches the unhealthy threshold during the functional check, the health check status of the node in the service is changed to unavailable, the API gateway stops performing functional checks on the node in the service, and performs a liveness check on the node in the service again;

[0105] The health check status here includes: healthy, unhealthy, available, and unavailable. The default status is unavailable.

[0106] S4, monitors the health check status of the node and automatically forwards traffic to healthy nodes;

[0107] The API gateway maintains the health check status of the nodes in the service and automatically forwards traffic to healthy nodes based on the health check status of the nodes in the service;

[0108] The API gateway monitors the health check status of the nodes in the service and synchronizes the data to the control plane. The control plane displays the health check status of the nodes in the service and sends an alarm to the operation and maintenance personnel.

[0109] Operation and maintenance personnel can check the reasons for node unhealthiness based on the monitoring and alarm information of the nodes in the API gateway. For example, if the health check status of a node is unavailable, it is necessary to check for network problems or service failures; if the health check status of a node is unhealthy, it is necessary to check for interface problems or code problems.

[0110] Based on the same inventive concept, the present invention also proposes a health check implementation device based on an API gateway. The implementation of the device can refer to the implementation of the above method, and the repeated parts will not be repeated. The term "module" used below can be a combination of software and / or hardware that implements a predetermined function. Although the device described in the following embodiments is preferably implemented in software, the implementation of hardware, or a combination of software and hardware, is also possible and conceived.

[0111] Figure 5 This is a schematic diagram of the structure of the health check implementation device based on the API gateway of the present invention. Figure 5 As shown, the device comprises:

[0112] Configuration module 101, used to add new services in the API gateway, configure nodes to the services, and configure health check parameters of the services;

[0113] A service is an abstraction of an API that can be configured on multiple nodes.

[0114] The API gateway 102 is used to perform a survival check and a functionality check on the nodes in the service, and automatically calculate the detection interval; the details are as follows:

[0115] After the service starts health check, the default health check status of the nodes in the service is unavailable, and the API gateway automatically performs a survival check on the nodes in the service;

[0116] The liveness check is that the API gateway performs TCP detection based on the IP address and port of the node in the service;

[0117] If the number of detections reaches the threshold and the health check status of the node in service does not change, the detection interval will be doubled, and so on, until the maximum interval is reached;

[0118] If the health check status of the node in the service changes, the detection interval will be restored to the initial detection interval;

[0119] If the number of detections reaches the threshold and the health check status of the node in the service changes, the health check status of the node in the service is modified;

[0120] If the number of successful liveness checks reaches the health threshold, the health check status of the node in the service is changed to available, and the API gateway starts to perform functional checks on the node in the service;

[0121] Functional check is that the API gateway performs HTTP or HTTPS detection based on the IP address, port, and request path of the node in the service;

[0122] If the number of survival check failures reaches the unhealthy threshold, the health check status of the node in service is changed to unhealthy and the detection interval is increased;

[0123] If the number of TCP connection failures reaches the unhealthy threshold during the functional check, the health check status of the node in the service is changed to unavailable, the API gateway stops performing functional checks on the node in the service, and performs a liveness check on the node in the service again;

[0124] If the number of successful functional checks reaches the health threshold, the health check status of the node in service is changed to healthy;

[0125] If the number of functional check failures reaches the unhealthy threshold, the health check status of the node in the service is changed to unhealthy and the detection interval is increased.

[0126] The API gateway 102 is used to monitor the health check status of the nodes in the service and automatically forward the traffic to the healthy nodes.

[0127] It should be noted that although several modules of the health check implementation device based on the API gateway are mentioned in the above detailed description, this division is only exemplary and not mandatory. In fact, according to an embodiment of the present invention, the features and functions of two or more modules described above can be concretized in one module. Conversely, the features and functions of one module described above can be further divided into multiple modules to be concretized.

[0128] Based on the above invention concept, Figure 6 As shown, the present invention also proposes a computer device 200, including a memory 210, a processor 220, and a computer program 230 stored in the memory 210 and executable on the processor 220, and when the processor 220 executes the computer program 230, the aforementioned API gateway-based health check implementation method is implemented.

[0129] Based on the aforementioned inventive concept, the present invention also proposes a computer-readable storage medium, which stores a computer program for executing the aforementioned API gateway-based health check.

[0130] The API gateway-based health check implementation method and device proposed in the present invention reduce the number of unnecessary detection times and improve network performance; perform health checks in layers to improve health check efficiency.

[0131] Although the spirit and principle of the present invention have been described with reference to several specific embodiments, it should be understood that the present invention is not limited to the disclosed specific embodiments, and the division of various aspects does not mean that the features in these aspects cannot be combined to benefit, and such division is only for the convenience of expression. The present invention is intended to cover various modifications and equivalent arrangements contained in the spirit and scope of the attached claims.

[0132] Regarding the limitation of the protection scope of the present invention, those skilled in the art should understand that, based on the technical solution of the present invention, various modifications or variations that can be made by those skilled in the art without creative work are still within the protection scope of the present invention.

Claims

1. A health check implementation method based on API gateway, characterized in that: The method includes: Add a new service in the API Gateway and configure the node to the service; Configure the health check parameters of the service in the API gateway; The API Gateway performs liveness and functionality checks on the nodes in the service and automatically calculates the detection interval, including: After the service starts health check, the default health check status of the nodes in the service is unavailable, and the API gateway automatically performs a survival check on the nodes in the service; If the number of detections reaches the threshold and the health check status of the node in service does not change, the detection interval will be doubled, and so on, until the maximum interval is reached; If the health check status of the node in the service changes, the detection interval will be restored to the initial detection interval; If the number of detections reaches the threshold and the health check status of the node in the service changes, the health check status of the node in the service is modified; If the number of successful liveness checks reaches the health threshold, the health check status of the node in the service is changed to available, and the API gateway starts to perform functional checks on the node in the service; If the number of survival check failures reaches the unhealthy threshold, the health check status of the node in service is changed to unhealthy and the detection interval is increased; If the number of TCP connection failures reaches the unhealthy threshold during the functional check, the health check status of the node in the service is changed to unavailable, the API gateway stops performing functional checks on the node in the service, and performs a liveness check on the node in the service again; If the number of successful functional checks reaches the health threshold, the health check status of the node in service is changed to healthy; If the number of functional check failures reaches the unhealthy threshold, the health check status of the node in the service is changed to unhealthy and the detection interval is increased; The liveness check is that the API gateway performs TCP detection based on the IP address and port of the node in the service; Functional check is that the API gateway performs HTTP or HTTPS detection based on the IP address, port, and request path of the node in the service; The API Gateway monitors the health check status of the nodes in the service and automatically forwards traffic to healthy nodes.

2. The API gateway-based health check implementation method according to claim 1 is characterized in that: The service is an abstraction of a class of APIs that can configure multiple nodes.

3. A health check implementation device based on API gateway, characterized in that: The device includes: The configuration module is used to add new services to the API gateway, configure nodes to services, and configure health check parameters for services; The API gateway is used to perform survival checks and functional checks on the nodes in the service, and automatically calculate the detection interval time, including: after the service starts the health check, the default health check status of the nodes in the service is unavailable, and the API gateway automatically performs a survival check on the nodes in the service; if the number of detections reaches the threshold and the health check status of the nodes in the service does not change, the detection interval time is doubled, and so on, until the maximum interval time is reached; if the health check status of the nodes in the service changes, the detection interval time is restored to the initial detection interval time; if the number of detections reaches the threshold and the health check status of the nodes in the service changes, the health check status of the nodes in the service is modified; if the number of survival check successes reaches the health threshold, the health check status of the nodes in the service is modified to available, and the API gateway starts to perform functional checks on the nodes in the service; if the number of survival check failures reaches the unhealthy threshold, the service The health check status of the node in the service is changed to unhealthy, and the detection interval is increased; if the number of TCP connection failures reaches the unhealthy threshold during the functional check, the health check status of the node in the service is changed to unavailable, the API gateway stops performing functional checks on the nodes in the service, and re-checks the survival of the nodes in the service; if the number of successful functional checks reaches the healthy threshold, the health check status of the node in the service is changed to healthy; if the number of failed functional checks reaches the unhealthy threshold, the health check status of the node in the service is changed to unhealthy, and the detection interval is increased; the survival check is that the API gateway performs TCP detection based on the IP address and port of the node in the service; the functional check is that the API gateway performs HTTP or HTTPS detection based on the IP address, port and request path of the node in the service; monitor the health check status of the nodes in the service and automatically forward the traffic to the healthy nodes.

4. The health check implementation device based on API gateway according to claim 3 is characterized in that: The service is an abstraction of a class of APIs that can configure multiple nodes.

5. A computer device comprising a memory, a processor and a computer program stored in the memory and executable on the processor, characterized in that: When the processor executes the computer program, the method according to any one of claims 1 to 2 is implemented.

6. A computer-readable storage medium, characterized in that: The computer-readable storage medium stores a computer program for executing the method according to any one of claims 1 to 2.

Images