Apigee API Program-wide Analytics Test

Using this test, administrators can proactively detect the traffic handling and performance issues of each API program launched on the Apigee Edge server. This test reports the count of requests to each API program and average time taken to process them, and also reveals how long each API program waited to receive response from the backend targets. In the process, the test points administrators to slow API programs and reveals the exact API program that has suffered the most owing to slow response from the backend targets. Besides, this test also reports the count of errors occurred during execution of each API program and latency during request and response processing. Using these metrics, administrators can timely intervene and resolve the error and latency conditions, troubleshoot problems, and make better business decisions related to the API program.

Target of the test : Apigee Edge Server

Agent deploying the test : An external agent

Outputs of the test : One set of results for each environment: API program pair in the target Apigee Edge server.

Configurable parameters for the test
Parameter	Description
Test period	How often should the test be executed
Host	The IP address of the host for which this test is to be configured.
Port	The port at which the target Apigee server listens to.
Username and Password	By default, the eG agent uses the REST API to collect the metrics from the target Apigee Edge server. To be able to connect to the REST API, the eG agent should be configured with the Apigee email and password of a user who is vested with the rights. Specify the Apigee email and password in the Username and password text boxes.
Confirm Password	Confirm the password by retyping it here.
SSL	By default, the SSL flag is set to Yes indicating that the SSL (Secured Socket Layer) is used to connect to the target Apigee Edge server. If not so, set the SSL flag to No .
Organizations	To enable the eG agent to monitor a particular organization of your interest, specify the name of that organization against this parameter. For instance, primaryorg. Doing so will enable the eG agent to monitor each of the components within the specified organization.
Environments	The organization specified in the Organizations field can contain multiple environments such as dev, test, and prod environment. To enable the eG agent to monitor an environment of your interest, specify the name of that environment in the Environments field. For example, test.
Timeout Seconds	Specify the duration (in seconds) within which the REST API command executed by this test should time out in this text box. The default is 120 seconds.

Measurements made by the test
Measurement	Description	Measurement Unit	Interpretation
Requests over time	Indicates the total number of client requests made to this API program during the last measurement period.	Number	Compare the value of this measure across the API programs to know which API program is the most popular one in terms of handling maximum number of requests.
Average response time	Indicates the average time taken by this API program to respond to the received requests during the last measurement period.	Milliseconds	A very low value is desired for this measure. An increase in the value of this measure indicates that the API program is very slow in processing the requests. Compare the value of this measure across the API programs to know which API program is the slowest and fastest.
Average target response time	Indicates the average time that this API program waited to receive the response from the backend targets during the last measurement period.	Milliseconds	Ideally, the value of this measure should be very low. This measure helps administrators to figure out how well the backend targets are performing while servicing the requests.
Errors over time	Indicates the number of errors encountered by this API program during the last measurement period.	Number	A non-zero value for this measure is a cause for concern.
Average request size over time	Indicates the average size of the request payload received by this API program during the last measurement period.	KB
Average response size over time	Indicates the average size of the response payload of this API program during the last measurement period.	KB
Average response processing latency	Indicates the average amount of time that this API program took to process the responses.	Milliseconds	Typically, the value of this measure denotes the time starting when each API program receives the target service response and ending when the Apigee Edge server forwards the response to the original caller. A high value is a cause for concern, as it indicates a potentially slow resource. Compare the value of this measure across the API programs to know which API resource is the most latent in processing the responses.
Average request processing latency	Indicates the average amount of time that this API response took to process the requests.	Milliseconds	Typically, the value of this measure indicates the time in Milliseconds from the time when a call reaches the API program to the time when Apigee Edge server sends the request to the target backend server.