Apigee API Resource Analytics Test

Resource files are executable code or other types of assets (for example XSLT) that are used by API proxies at runtime. Resource files can be stored at one of three levels:

• API proxy: Available to any policies in an API proxy.
• Environment: Available to any policies in any API proxy deployed in the environment.
• Organization: Available to any API proxy deployed in any environment in an organization.

The API proxies use the resources from any of the above-said repositories based on the runtime requirement. When the clients make requests to use the resources for their API proxies, the resources should process the requests and return responses as quick as possible so as to ensure speedy and seamless API operations. Often, slow responses from the resources lead to the slower API operations. To avoid this, it is necessary to monitor the traffic to and from the resources round the clock! The Apigee API Resource Analytics test helps in this regard!

For each resource, this test reports the count of client requests and average time taken to process them, and also reveals how long it took to receive response from the backend targets. In the process, the test points administrators to slow resources and reveals the exact resource that has suffered the most owing to slow response from the backend targets. Besides, this test reveals the count of errors encountered by each resource and latency during request and response processing. Using these metrics, administrators can timely investigate the issuess and resolve the error and latency conditions before it affects user experience.

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