A performance testing method and device for API gateway

Abstract

The present invention discloses a performance testing method and device for an API gateway, wherein the method comprises: a testing system receives configuration parameters for a stress test; the testing system synchronizes clocks of a packet sender, an API gateway, and a server, and sends the test configuration parameters and a test case startup time to the packet sender; the packet sender constructs and sends a test message according to the test case startup time and the test configuration parameters; the test message carries a unique message identifier; the packet sender, the API gateway, and the server respectively record message processing logs in a request phase and a response phase; a performance monitoring system collects and analyzes the message processing logs, system performance indicators, and session information of the API gateway of each node, and synchronizes the test analysis results to the testing system; the testing system adjusts the test configuration parameters and the system configuration parameters according to the test analysis results, thereby determining the performance indicators of the API gateway for massive requests and achieving the effect of optimizing performance.

Description

Technical Field

[0001] The present invention relates to the field of performance testing of API gateways, and in particular to a performance testing method and device for an API gateway. Background Art

[0002] As a capability forwarding device, the API gateway processes a massive number of API requests. Therefore, APIs must undergo stress testing before they are deployed. Existing API gateway performance testing typically uses stress testing tools such as JMeter and Wrk. Stress testing results are based on statistical data from the stress testing tool (i.e., the client). Since the entire stress testing process involves the client (i.e., the stress testing tool), the server, and the API gateway, each process can affect the test results. The client and server processing mechanisms, the API gateway's message processing mechanism, and the characteristics of the messages themselves (message type, size, and connection type) all affect the performance of the API gateway. Therefore, client-side test results are not fully representative of the API gateway's performance. Furthermore, a single stress testing tool often cannot meet stress testing requirements. Most stress testing tools do not support simultaneous testing on multiple devices, resulting in inconsistent stress testing times and inconsistent results. Therefore, the stress testing tool itself often becomes a bottleneck in performance testing. Summary of the Invention

[0003] In order to solve the above problems existing in the prior art, the present invention provides a performance testing method and device for an API gateway, which can improve the accuracy of API gateway performance testing.

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

[0005] In one embodiment of the present invention, a performance testing method for an API gateway is proposed, the method comprising:

[0006] The test system receives the configuration parameters of the stress test;

[0007] The test system synchronizes the clocks of the contract issuing machine, API gateway, and server, and sends the stress test configuration parameters and test case start time to the contract issuing machine;

[0008] The packet sender constructs and sends a test message based on the test case start time and the configuration parameters of the stress test; the test message carries a unique message identifier;

[0009] The packet sender, API gateway, and server record message processing logs during the request and response phases respectively;

[0010] The performance monitoring system collects and analyzes each node's message processing logs, system performance indicators, and API gateway session information, and synchronizes the test analysis results to the test system;

[0011] The test system adjusts the stress test configuration parameters and system configuration parameters based on the test analysis results, thereby determining the performance indicators of the API gateway's massive requests and achieving the effect of optimizing performance.

[0012] Furthermore, the message unique identifier is generated by the packet sender, and the server copies the message unique identifier in the request message to the response message during the response phase. The message unique identifier is located in the request header and the response message header.

[0013] Furthermore, the performance monitoring system obtains the TPS, processing delay, and trend chart of abnormal distribution of each node based on the message processing log of each node and the session information of the API gateway, and determines the performance indicators of the stress test of each node and the trend chart of each indicator.

[0014] Furthermore, the test system compares the performance index of the stress test of each node with the system performance index and the configuration parameters of the stress test to determine the influencing factors of the system configuration parameters of each node and the configuration parameters of the stress test on the performance index of the stress test.

[0015] Furthermore, the packet sending machine receives instructions from the test system, executes the test task according to the instructions, and constructs a unique message identifier in the request message.

[0016] Furthermore, the API gateway processes the request message sent by the packet sender according to the routing strategy, and responds to the packet sender's request according to the server's response.

[0017] In one embodiment of the present invention, a performance testing device for an API gateway is also proposed, the device comprising:

[0018] The test system is used to receive the configuration parameters of the stress test; synchronize the clocks of the contract issuing machine, API gateway, and server, and send the stress test configuration parameters and test case start time to the contract issuing machine, and obtain the system performance indicators and stress test performance indicators of each node from the performance monitoring system; record and store the execution results of the test case at each node, and summarize and analyze the relationship between the performance indicators of the stress test of each node and the system performance indicators and the configuration parameters of the stress test; store the relationship between the performance indicators of the stress test of each node and the system performance indicators and the configuration parameters of the stress test;

[0019] The API gateway processes the request message sent by the dispatcher according to the routing policy and responds to the dispatcher's request based on the server's response.

[0020] The packet sender is used to construct and send test messages based on the test case startup time and the configuration parameters of the stress test; the test message carries a unique message identifier;

[0021] The server, after receiving the request, copies the unique identifier of the message to the header of the response message and returns it to the API gateway;

[0022] The performance monitoring system is used to collect and analyze each node's message processing logs, system performance indicators, and API gateway session information, and synchronize the test analysis results to the test system.

[0023] Furthermore, the message unique identifier is generated by the packet sender, and the server copies the message unique identifier in the request message to the response message during the response phase. The message unique identifier is located in the request header and the response message header.

[0024] Furthermore, the performance monitoring system obtains the TPS, processing delay, and trend chart of abnormal distribution of each node based on the message processing log of each node and the session information of the API gateway, and determines the performance indicators of the stress test of each node and the trend chart of each indicator.

[0025] Furthermore, the test system compares the performance index of the stress test of each node with the system performance index and the configuration parameters of the stress test to determine the influencing factors of the system configuration parameters of each node and the configuration parameters of the stress test on the performance index of the stress test.

[0026] Furthermore, the packet sending machine receives instructions from the test system, executes the test task according to the instructions, and constructs a unique message identifier in the request message.

[0027] 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 performance testing method is implemented.

[0028] In one embodiment of the present invention, a computer-readable storage medium is further provided, wherein the computer-readable storage medium stores a computer program for executing a performance testing method for an API gateway.

[0029] Beneficial effects:

[0030] The present invention improves the accuracy of API gateway performance testing by comprehensively comparing the relationship between the performance indicators of the stress test and the system performance indicators and the configuration parameters of the stress test. BRIEF DESCRIPTION OF THE DRAWINGS

[0031] Figure 1 This is a flow chart of the performance testing method for the API gateway of the present invention;

[0032] Figure 2 is a networking diagram of an embodiment of the present invention;

[0033] Figure 3 This is a schematic diagram of the performance testing device for the API gateway of the present invention;

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

[0035] 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 solely 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. Rather, these embodiments are provided to make this disclosure more thorough and complete, and to fully convey the scope of the present disclosure to those skilled in the art.

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

[0037] According to an embodiment of the present invention, a performance testing method and device for an API gateway are proposed, wherein a testing system receives configuration parameters for a stress test; the testing system synchronizes the clocks of a packet sender, an API gateway, and a server, and sends the configuration parameters for the stress test and the test case startup time (which can be configured by the tester) to the packet sender; the packet sender constructs and sends a test message according to the test case startup time and the configuration parameters for the stress test; the test message carries a unique message identifier; the packet sender, the API gateway, and the server respectively record message processing logs in the request phase and the response phase; a performance monitoring system collects and analyzes the message processing logs, system performance indicators, and session information of the API gateway of each node (server, API gateway, and all nodes of the client), and synchronizes the test analysis results to the testing system; the testing system adjusts the configuration parameters for the stress test and the system configuration parameters according to the test analysis results, thereby determining the performance indicators of the API gateway for massive requests and achieving the effect of optimizing performance.

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

[0039] Figure 1 This is a flow chart of the performance testing method for the API gateway of the present invention. Figure 1 As shown, the method includes:

[0040] S1. The test system receives the configuration parameters of the stress test;

[0041] The configuration parameters for the stress test include the number of packet senders, the number of threads for each packet sender, the connection type, the test duration, the session startup time, and the message information.

[0042] The connection types include long connections and short connections. If it is a short connection, the thread sends an HTTP request, that is, disconnects. If it is a long connection, messages are sent through the same session during the duration.

[0043] The configuration parameters for stress testing also include the API gateway's routing matching algorithm type, plug-in type, and cache.

[0044] S2. The test system synchronizes the clocks of the contract issuing machine, API gateway, and server, and sends the stress test configuration parameters and test case start time to the contract issuing machine;

[0045] S3. The packet sender constructs and sends a test message based on the test case start time and the configuration parameters of the stress test; the test message carries a unique message identifier;

[0046] The packet sender receives the instruction from the test system, executes the test task according to the instruction, and constructs a unique message identifier in the request message;

[0047] The message unique identifier is generated by the packet sender. During the response phase, the server copies the message unique identifier in the request message to the response message. The message unique identifier is located in the request header and the response message header.

[0048] S4, the packet sender, the API gateway, and the server record message processing logs during the request and response phases respectively;

[0049] Message processing logs include the message unique identifier, current time, response status, upstream status, and processing delay;

[0050] The API gateway processes the request message sent by the packet sender according to the routing strategy, and responds to the packet sender's request based on the server's response.

[0051] S5. The performance monitoring system collects and analyzes each node's message processing logs, system performance indicators, and API gateway session information, and synchronizes the test analysis results to the test system.

[0052] The performance monitoring system obtains each node's TPS, processing latency, and anomaly distribution trend charts based on each node's message processing logs and API gateway session information. It also determines the performance indicators of each node's stress test and the trend charts of each indicator.

[0053] The performance indicators of stress testing include TPS, exception rate, and latency.

[0054] S6. The test system adjusts the stress test configuration parameters and system configuration parameters based on the test analysis results to determine the performance indicators of the API gateway for massive requests and achieve the effect of optimizing performance;

[0055] The test system compares the relationship between the performance indicators of the stress test and the system performance indicators and the configuration parameters of the stress test, and determines the factors affecting the performance indicators of the stress test by the system configuration parameters and the configuration parameters of the stress test of each node;

[0056] System configuration parameters include the number of TCP connections, number of retransmissions, TCP timeout, socket buffer size, send and receive window sizes, and other kernel configuration parameters that affect message processing.

[0057] 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 drawings, this does not require or imply that these operations must be performed in this specific order, or that all illustrated operations must be performed to achieve the desired results. Additionally or alternatively, certain steps may be omitted, multiple steps may be combined into one step, and / or one step may be broken down into multiple steps.

[0058] In order to explain the performance testing method of the above-mentioned API gateway more clearly, a specific embodiment is used for illustration below. However, it is worth noting that this embodiment is only for better illustrating the present invention and does not constitute an improper limitation to the present invention.

[0059] The networking of this embodiment is as follows Figure 2 As shown, the test system manages contract issuers, API gateways, and server devices, with multiple devices of each type. In this embodiment, C1, C2, and C3 act as clients, representing three contract issuers, and APIG is an API gateway device. The API gateway receives requests from the contract issuers and forwards them to the server. After receiving responses from the server, it returns the responses to the corresponding contract issuers. S1 and S2 act as servers, receiving and responding to messages from the API gateway.

[0060] The system configurations of C1, C2, C3, S1, S2, and APIG are all 8C16G, the operating system is CentOS 7.6, and other parameters are all system default parameters.

[0061] In this embodiment, it is necessary to perform stress testing on the APIG. The APIG system configuration is 8C16G. During the test, the number of cores that the APIG actually runs can be specified. The implementation steps are as follows:

[0062] S1. The test system receives the configuration parameters of the stress test;

[0063] When you need to stress test an API gateway, first build Figure 2 In the network topology shown, configure the API information and server information for this test on the API gateway. The server information includes the server address and port, as well as the load balancing ratio between different servers.

[0064] API information refers to the path information, protocol type, request type, and routing strategy matched according to the API request in this test.

[0065] The configuration parameters for the stress test include the number of packet senders, the number of threads for each packet sender, the connection type, the test duration, the session startup time, and the message information.

[0066] The connection types include long connections and short connections. If it is a short connection, the thread sends an HTTP request, which disconnects the connection. If it is a long connection, messages are sent through the same session during the duration until the test time ends, at which point the connection is disconnected.

[0067] The configuration parameters of the stress test also include the API gateway's routing matching algorithm type, plug-in type, whether to cache, cache size, etc.

[0068] S2. The test system synchronizes the clocks of the contract issuing machine, API gateway, and server, and sends the stress test configuration parameters and test case start time to the contract issuing machine;

[0069] The test system first synchronizes the clocks of the nodes participating in this test, then sends the configuration parameters of this stress test and the test case start time to the contract issuing machine, and builds the test case.

[0070] S3. The packet sender constructs and sends a test message based on the test case start time and the configuration parameters of the stress test; the test message carries a unique message identifier;

[0071] The packet sender receives the instruction from the test system, executes the test task according to the instruction, and constructs a unique message identifier in the request message.

[0072] When the test case is started, the packet sender constructs and sends the test message according to the configuration parameters of the stress test. Each HTTP request carries a unique message identifier to confirm the message.

[0073] The message unique identifier is generated by the packet sender. During the response phase, the server copies the message unique identifier in the request message to the response message. The message unique identifier is located in the request header and the response message header.

[0074] During specific implementation, the unique identifier of the message may be carried in the request parameters or in the request header.

[0075] S4, the packet sender, API gateway, and server record message processing logs in the request and response phases respectively;

[0076] The message processing log includes the message unique identifier, current time, response status, upstream status, and processing delay.

[0077] After receiving the request from the packet sender, the API gateway matches the request message according to the routing strategy and forwards it according to the matching result.

[0078] Routing policies include authentication, rate limiting, matching priority, request rewriting, and load balancing algorithms.

[0079] After receiving the request, the server copies the unique identifier of the message to the header of the response message and returns it to the API gateway.

[0080] After the API gateway receives the response message from the server, it responds to the request of the packet sender according to the response message from the server.

[0081] The packet sender, API gateway, and server respectively record the request and response of the message. The log records the message's unique identifier, current time, response status, upstream status, and processing delay.

[0082] S5. The performance monitoring system collects and analyzes each node's message processing logs, system performance indicators, and API gateway session information, and synchronizes the test analysis results to the test system.

[0083] The performance monitoring system obtains the TPS, processing delay, and anomaly distribution trend chart of each node based on the message processing log of each node and the session information of the API gateway, and determines the performance indicators of the stress test of each node and the trend chart of each indicator.

[0084] The performance indicators of stress testing include TPS, exception rate, and latency.

[0085] In specific implementation, during the testing process, the API gateway records the current session information and stores it in the form of logs.

[0086] In specific implementation, the performance monitoring system monitors the system performance indicators of each node during the execution of the test case.

[0087] System performance indicators include the node's CPU, memory, and number of cores.

[0088] S6. The test system adjusts the stress test configuration parameters and system configuration parameters based on the test analysis results to determine the performance indicators of the API gateway for massive requests and achieve the effect of optimizing performance;

[0089] The test system compares the relationship between the performance indicators of the stress test and the system performance indicators and the configuration parameters of the stress test, and determines the factors affecting the performance indicators of the stress test by the system configuration parameters and the configuration parameters of the stress test of each node.

[0090] System configuration parameters include the number of TCP connections, the number of files, and kernel configuration.

[0091] In this embodiment, the performance indicators of the stress test are comprehensively compared with the system performance indicators and the relationship between the configuration parameters of the stress test to provide the accuracy of the API gateway performance test.

[0092] Based on the same inventive concept, the present invention also proposes a performance testing device for 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.

[0093] Figure 3 This is a schematic diagram of the performance testing device structure of the API gateway according to one embodiment of the present invention. Figure 3 As shown, the device includes:

[0094] The test system 101 is used to receive the configuration parameters of the stress test; synchronize the clocks of the contract issuing machine, API gateway, and server, and send the stress test configuration parameters and the test case start time to the contract issuing machine, and obtain the system performance indicators and stress test performance indicators of each node from the performance monitoring system; record and store the execution results of the test case at each node, and summarize and analyze the relationship between the performance indicators of the stress test of each node and the system performance indicators and the configuration parameters of the stress test; store the relationship between the performance indicators of the stress test of each node and the system performance indicators and the configuration parameters of the stress test;

[0095] The test system 101 compares the performance indicators of the stress test of each node with the system performance indicators and the configuration parameters of the stress test to determine the factors affecting the performance indicators of the stress test of each node's system configuration parameters and the configuration parameters of the stress test.

[0096] API gateway 102, used to process the request message sent by the packet sender according to the routing policy, and respond to the packet sender's request according to the server's response;

[0097] The API gateway 102 is used as the target device for performance testing. The performance indicators of the API gateway 102 are determined by adjusting different system parameters and additional functions, such as rate limiting and caching.

[0098] The API gateway 102 records the current session information in log behavior and records the message processing log.

[0099] The packet sending machine 103 is used to construct and send a test message according to the test case start time and the configuration parameters of the stress test; the test message carries a unique message identifier;

[0100] The packet issuing machine 103 receives the instruction from the test system 101, executes the test task according to the instruction, and constructs a unique message identifier in the request message;

[0101] The message unique identifier is generated by the packet generator 103. The server 104 copies the message unique identifier in the request message to the response message during the response phase. The message unique identifier is located in the request header and the response message header.

[0102] The server 104 is used to copy the unique identifier of the message to the header of the response message after receiving the request and return it to the API gateway 102.

[0103] Performance monitoring system 105, used to collect and analyze each node's message processing logs, system performance indicators, and API gateway 102 session information, and synchronize test analysis results to the test system;

[0104] The performance monitoring system 105 obtains the TPS, processing delay and abnormal distribution trend chart of each node based on the message processing log of each node and the session information of the API gateway 102, and determines the performance indicators of the stress test of each node and the trend chart of each indicator.

[0105] It should be noted that although several modules of the performance testing device of the API gateway are mentioned in the detailed description above, this division is merely 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 for concretization.

[0106] Based on the above invention concept, Figure 4 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 the processor 220 implements the aforementioned API gateway performance testing method when executing the computer program 230.

[0107] 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 performance testing method for the API gateway.

[0108] The performance testing method and device for the API gateway proposed in the present invention comprehensively compare the relationship between the performance indicators of the stress test and the system performance indicators and the configuration parameters of the stress test, thereby improving the accuracy of the API gateway performance test.

[0109] Although the spirit and principles 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 specific embodiments disclosed, and the division into various aspects does not mean that the features of these aspects cannot be combined to benefit. Such division is only for the convenience of expression. The present invention is intended to cover various modifications and equivalent arrangements included within the spirit and scope of the appended claims.

[0110] 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 performance testing method for an API gateway, characterized in that: The method includes: The test system receives the configuration parameters of the stress test; The test system synchronizes the clocks of the contract issuing machine, API gateway, and server, and sends the stress test configuration parameters and test case start time to the contract issuing machine; The packet sender constructs and sends a test message based on the test case start time and the configuration parameters of the stress test; the test message carries a unique message identifier; The packet sender, API gateway, and server record message processing logs during the request and response phases respectively; The performance monitoring system collects and analyzes each node's message processing logs, system performance indicators, and API gateway session information, and synchronizes the test analysis results to the test system; The test system adjusts the stress test configuration parameters and system configuration parameters based on the test analysis results, thereby determining the performance indicators of the API gateway's massive requests and achieving the effect of optimizing performance.

2. The performance testing method of the API gateway according to claim 1 is characterized in that: The message unique identifier is generated by the packet sender, and the server copies the message unique identifier in the request message to the response message during the response phase. The message unique identifier is located in the request header and the response message header.

3. The performance testing method of the API gateway according to claim 1 is characterized in that: The performance monitoring system obtains the TPS, processing delay and abnormal distribution trend chart of each node based on the message processing log of each node and the session information of the API gateway, and determines the performance indicators of the stress test of each node and the trend chart of each indicator.

4. The performance testing method of the API gateway according to claim 1 is characterized in that: The test system compares the performance index of the stress test of each node with the system performance index and the configuration parameters of the stress test to determine the influencing factors of the system configuration parameters of each node and the configuration parameters of the stress test on the performance index of the stress test.

5. The performance testing method of the API gateway according to claim 1 is characterized in that: The packet sending machine receives the instruction from the test system, executes the test task according to the instruction, and constructs a unique message identifier in the request message.

6. The performance testing method of the API gateway according to claim 1 is characterized in that: The API gateway processes the request message sent by the packet sender according to the routing strategy, and responds to the request of the packet sender according to the response of the server.

7. A performance testing device for an API gateway, characterized in that: The device includes: The test system is used to receive the configuration parameters of the stress test; synchronize the clocks of the contract issuing machine, API gateway, and server, and send the stress test configuration parameters and test case start time to the contract issuing machine, and obtain the system performance indicators and stress test performance indicators of each node from the performance monitoring system; record and store the execution results of the test case at each node, and summarize and analyze the relationship between the performance indicators of the stress test of each node and the system performance indicators and the configuration parameters of the stress test; store the relationship between the performance indicators of the stress test of each node and the system performance indicators and the configuration parameters of the stress test; The API gateway processes the request message sent by the dispatcher according to the routing policy and responds to the dispatcher's request based on the server's response. The packet sender is used to construct and send test messages based on the test case startup time and the configuration parameters of the stress test; the test message carries a unique message identifier; The server, after receiving the request, copies the unique identifier of the message to the header of the response message and returns it to the API gateway; The performance monitoring system is used to collect and analyze the message processing logs, system performance indicators, and API gateway session information of each node, and synchronize the test analysis results to the test system.

8. The performance testing device for an API gateway according to claim 7, characterized in that: The message unique identifier is generated by the packet sender, and the server copies the message unique identifier in the request message to the response message during the response phase. The message unique identifier is located in the request header and the response message header.

9. The performance testing device for an API gateway according to claim 7, characterized in that: The performance monitoring system obtains the TPS, processing delay and abnormal distribution trend chart of each node based on the message processing log of each node and the session information of the API gateway, and determines the performance indicators of the stress test of each node and the trend chart of each indicator.

10. The performance testing device for an API gateway according to claim 7, characterized in that: The test system compares the performance index of the stress test of each node with the system performance index and the configuration parameters of the stress test to determine the influencing factors of the system configuration parameters of each node and the configuration parameters of the stress test on the performance index of the stress test.

11. The performance testing device for an API gateway according to claim 7, characterized in that: The packet sending machine receives the instruction from the test system, executes the test task according to the instruction, and constructs a unique message identifier in the request message.

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

13. 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 6.

Images