Apigee API Product Analytics Test

An API provider creates API products to bundle the APIs and make the APIs available to app developers for consumption. Multiple API products can be created to address use cases that solve specific needs. The API products are the central mechanism for authorization and access control to the APIs. The app developers access the API products by registering their applications with the Apigee Edge server. As the API products are shared among multiple applications and developers, the successul utilization of the API products depends on the level of user satisfaction with the API products. The key to ensuring high user experience lies in closely tracking requests to the API products, measuring the responsiveness of the API products to the requests, instantly detecting poor responsiveness, and accurately isolating erratic and latent API product, well before that user notices! This can be achieved using the Apigee API Product Analytics test!

This test reports the count of requests to each API product and average time taken to process them, and also reveals how long each API product waited to receive response from the backend targets to which it is connected to. In the process, the test points administrators to slow API products and reveals the exact API product that has suffered the most owing to slow response from the backend targets. Besides, this test reveals the count of errors encountered by each API product and latency during request and response processing. Using these metrics, administrators can timely intervene and resolve the error and latency conditions.

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 product 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
App count by API products	Indicates the total number of applications that were using this API product during the last measurement period.	Number
Developer count by API products	Indicates the total number of developers who were consuming this API product during the last measurement period.	Number	Compare the value of this measure across the API products to know which API product is the most famous one among the developers.
Requests by API products	Indicates the total number of requests received by this API product during the last measurement period.	Number
Average response time API products	Indicates the average time taken by this API product 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 product is very slow in processing the requests. Compare the value of this measure across the API products to know which API product took maximum time to respond to the requests.
Average target response time by API products	Indicates the average time that this API product 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 products	Indicates the number of errors encountered by this API product during the last measurement period.	Number
Average request size by API	Indicates the average size of the request payload received by this API product during the last measurement period.	KB
Average response size by API products	Indicates the average size of the response payload of this API during the last measurement period.	KB
Average response processing latency by API products	Indicates the average amount of time that this API product 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 products. Compare the value of this measure across the APIs to know which API product is the most latent in processing the responses.
Average request processing latency by API products	Indicates the total number of client requests received by this API product during the last measurement period.	Number