Apigee API Analytics Test

Apigee Edge records a wide variety of operational and business data that flows across APIs. The metrics derived from this data are useful for operational monitoring and business monitoring. Using Edge API Analytics, administrators can, for example, determine which APIs are performing well or poorly. To make this analysis even more simpler, eG Enterprise offers the Apigee API Analytics test.

This test periodically monitors the request processing ability of each API in each environment of the Apigee Edge server. For each API, this test reports the number of requests received, average response times, errors, request and response size, and request and response processing latency. Using these details, administrators can quickly troubleshoot the possible issues and take remedial measures if any of the APIs is slow in processing the requests and/or encountering more errors and/or potentially latent in sending out responses. This way, the service delivery of the Apigee Edge server will be intact and better user experience will always be assured.

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 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 environments. 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 count by API	Indicates the total number of client requests received by this API during the last measurement period.	Number
Average response time by API	Indicates the average time taken by this API 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 is very slow in processing the requests. Compare the value of this measure across the APIs to know which API took maximum time to respond to the requests.
Average target response time by API	Indicates the average time that this API 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 by API	Indicates the number of errors encountered by this API during the last measurement period.	Number
Average request size by API	Indicates the average size of the request payload received by this API during the last measurement period.	KB
Average response size by API	Indicates the average size of the response payload of this API during the last measurement period.	KB
Average response processing latency by API	Indicates the average amount of time that this API took to process the responses.	Milliseconds	Typically, the value of this measure denotes the time starting when each API 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 API. Compare the value of this measure across the APIs to know which API is the most latent in processing the responses.
Average request processing latency by API	Indicates the average amount of time that this API resource 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 to the time when Apigee Edge server sends the request to the target bbackend server.